<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<!DOCTYPE stax SYSTEM "/stax.dtd">

<stax>

<function name="_adminCommonArgs">

<function-prolog>

This function resolves common admin arguments

</function-prolog>

<function-no-args/>

<script>

if dsInstanceHost:

STAFCmdParamsList.append('-h %s' % dsInstanceHost)

if dsInstanceAdminPort:

STAFCmdParamsList.append('-p %s' % dsInstanceAdminPort)

STAFCmdParamsList.append('-X')

if dsInstanceDn:

STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)

if dsInstancePswd:

STAFCmdParamsList.append('-w "%s"' % dsInstancePswd)

</script>

</function>

<!-- This function upgrades DS using the upgrade script -->

<function name="UpgradeDsWithScript" scope="local">

<function-prolog>

This function upgrades DS using the upgrade script

</function-prolog>

<function-map-args>

<function-arg-def name="location"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath"

type="optional"

default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Help option

</function-arg-description>

<function-arg-property name="help" value="option"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

</script>

<!-- Check if 'Legal/license_to_accept.txt' exists -->

<call function="'GetEntry'">

{

'location' : location ,

'entry' : '%s/Legal/license_to_accept.txt' % dsPath ,

'attribute' : 'TYPE'

}

</call>

<if expr="RC != 48">

<!-- 'Legal/license_to_accept.txt' exists so add 'acceptLicense' option -->

<script>

STAFCmdParamsList.append('--acceptLicense')

</script>

</if>

<if expr="UPGRADE_OPENDJNAME == 'OpenDJ-2.5.0-Xpress1'">

<!-- Upgrade from 'OpenDJ-2.5.0-Xpress1' so add 'force' option -->

<script>

STAFCmdParamsList.append('--force')

</script>

</if>

<script>

if dsPath:

STAFCmd='%s/upgrade%s' % (dsPath,fileExt)

STAFCmdParamsList.append('-n')

if dsHelp:

STAFCmdParamsList.append('-H')

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'location' : location,

'name' : 'Upgrade DS Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'path' : dsPath,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

</sequence>

</function>

<!-- This function sets up DS using the setup script -->

<function name="SetUpDsWithScript" scope="local">

<function-prolog>

This function sets up a Directory Server using a script

</function-prolog>

<function-map-args>

<function-arg-def name="location"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsHost"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Hostname of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath"

type="optional"

default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="dsPort" type="optional">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsAdminPort"

type="optional"

default="DIRECTORY_INSTANCE_ADMIN_PORT">

<function-arg-description>

Directory server admin port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsSslPort" type="optional">

<function-arg-description>

Directory server SSL port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsJmxPort" type="optional">

<function-arg-description>

Directory server JMX port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsBaseDN" type="optional">

<function-arg-description>

Base DN (only single base DN supported).

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsBindDN" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsBindPwd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBindPwdFile" type="optional">

<function-arg-description>

Bind password file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsEnableWindowsService" type="optional">

<function-arg-description>

Enable as a Windows Service

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="dsDoNotStart" type="optional">

<function-arg-description>

Do not start server after setup

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Help option

</function-arg-description>

<function-arg-property name="help" value="option"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<!-- Get the information about the server -->

<call function="'GetVar'">

{ 'location' : dsHost,

'type' : 'shared',

'variable' : 'Job%s_ServerInfo' % STAXParentID

}

</call>

<if expr="RC != 0">

<script>

STAFResult='{}'

</script>

</if>

<script>

jobInfo=eval(STAFResult)

instPath = '%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)

if jobInfo.has_key(instPath):

serverInformation=jobInfo[instPath]

dsVersion=serverInformation['server version']

else:

dsVersion='unknown'

STAFCmdParamsList=[]

STAFCmdParams=''

</script>

<!-- Check if 'Legal/license_to_accept.txt' exists -->

<call function="'GetEntry'">

{

'location' : location ,

'entry' : '%s/Legal/license_to_accept.txt' % dsPath ,

'attribute' : 'TYPE'

}

</call>

<if expr="RC != 48">

<!-- 'Legal/license_to_accept.txt' exists -->

<if expr="UPGRADE_OPENDJNAME != ''">

<!-- UPGRADE MODE -->

<if expr="UPGRADE_OPENDJNAME >= 'OpenDJ-2.5.0' and UPGRADE_OPENDJNAME != 'OpenDJ-2.5.0-Xpress1'">

<!--Upgrade from a version >= '2.5.0' so add 'acceptLicense' option -->

<script>

STAFCmdParamsList.append('--acceptLicense')

</script>

</if>

<else>

<!-- STANDARD MODE -->

<if expr="dsVersion >= '2.5.0' and dsVersion != '2.5.0-Xpress1'">

<!-- Install a fresh version >= '2.5.0' so add 'acceptLicense' option -->

<script>

STAFCmdParamsList.append('--acceptLicense')

</script>

</if>

</else>

</if>

</if>

<script>

if dsPath:

STAFCmd='%s/setup%s' % (dsPath,fileExt)

STAFCmdParamsList.append('--cli')

STAFCmdParamsList.append('-n')

if dsHost:

STAFCmdParamsList.append('-h %s' % dsHost)

if dsPort:

STAFCmdParamsList.append('-p %s' % dsPort)

if dsAdminPort:

STAFCmdParamsList.append('--adminConnectorPort %s' % dsAdminPort)

if dsSslPort:

STAFCmdParamsList.append('-Z %s' % dsSslPort)

STAFCmdParamsList.append('--generateSelfSignedCertificate')

if dsJmxPort:

STAFCmdParamsList.append('-x %s' % dsJmxPort)

if dsBaseDN:

STAFCmdParamsList.append('-b "%s"' % dsBaseDN)

if dsBindDN:

STAFCmdParamsList.append('-D "%s"' % dsBindDN)

if dsBindPwd:

STAFCmdParamsList.append('-w "%s"' % dsBindPwd)

if dsBindPwdFile:

STAFCmdParamsList.append('-j "%s"' % dsBindPwdFile)

if dsEnableWindowsService:

STAFCmdParamsList.append('-e')

if dsDoNotStart:

STAFCmdParamsList.append('-O')

if dsHelp:

STAFCmdParamsList.append('-H')

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'location' : location,

'name' : 'Setup DS Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'path' : dsPath,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

</sequence>

</function>

<!-- This function uninstall DS using the uninstall script -->

<function name="UninstallDsWithScript" scope="local">

<function-prolog>

This function sets up a Directory Server using a script

</function-prolog>

<function-map-args>

<function-arg-def name="location"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsHost"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Hostname of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath"

type="optional"

default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="dsPort" type="optional">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsAdminPort"

type="optional"

default="DIRECTORY_INSTANCE_ADMIN_PORT">

<function-arg-description>

Directory server admin port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsSslPort" type="optional">

<function-arg-description>

Directory server SSL port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsJmxPort" type="optional">

<function-arg-description>

Directory server JMX port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsBaseDN" type="optional">

<function-arg-description>

Base DN (only single base DN supported).

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsBindDN" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsBindPwd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBindPwdFile" type="optional">

<function-arg-description>

Bind password file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsEnableWindowsService" type="optional">

<function-arg-description>

Enable as a Windows Service

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="dsDoNotStart" type="optional">

<function-arg-description>

Do not start server after setup

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Help option

</function-arg-description>

<function-arg-property name="help" value="option"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

STAFCmd='%s/uninstall%s' % (dsPath,fileExt)

STAFCmdParamsList.append('--cli')

STAFCmdParamsList.append('--remove-all')

STAFCmdParamsList.append('-n')

if dsHost:

STAFCmdParamsList.append('-h %s' % dsHost)

if dsBindDN:

STAFCmdParamsList.append('-I "%s"' % dsBindDN)

if dsBindPwd:

STAFCmdParamsList.append('-w "%s"' % dsBindPwd)

if dsBindPwdFile:

STAFCmdParamsList.append('-j "%s"' % dsBindPwdFile)

if dsHelp:

STAFCmdParamsList.append('-H')

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'location' : location,

'name' : 'Setup DS Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'path' : dsPath,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

</sequence>

</function>

<!-- This function starts DS using the start-ds script -->

<function name="StartDsWithScript">

<function-prolog>

This function starts a Directory Server

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsVersion" type="optional">

<function-arg-description>

Directory server version

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsSystemInfo" type="optional">

<function-arg-description>

Directory server system info

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsNoDetach" type="optional">

<function-arg-description>

Do not detach directory server from process

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Help option

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsBuildInfo" type="optional">

<function-arg-description>

Directory server build information

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsDebugPort" type="optional" default="DEBUG_PORT">

<function-arg-description>

Directory Server debug port

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/start-ds%s' % (dsBinPath,fileExt)

if dsVersion:

STAFCmdParamsList.append('-V')

if dsSystemInfo:

STAFCmdParamsList.append('-s')

if dsNoDetach:

STAFCmdParamsList.append('-N')

if dsHelp:

STAFCmdParamsList.append('-H')

if dsBuildInfo:

STAFCmdParamsList.append('-F')

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<!-- Check if 'emma.jar' exists -->

<call function="'GetEntry'">

{

'location' : STAF_REMOTE_HOSTNAME ,

'entry' : '%s/lib/emma.jar' % dsPath ,

'attribute' : 'TYPE'

}

</call>

<if expr="RC != 48 and CurrentTestPath.has_key('group')">

<!-- 'emma.jar' exists so we can configure the coverage dump file -->

<sequence>

<script>

resultsCoveragePath = os.path.join(LOGS_ROOT,'coverage')

resultsPath = os.path.join(resultsCoveragePath,CurrentTestPath['group'])

remoteCoveragePath = os.path.join(remote.temp,'coverage')

ecPath = os.path.join(remoteCoveragePath,CurrentTestPath['group'])

</script>

<call function="'createFolder'">

{ 'location' : STAXServiceMachine,

'foldername' : resultsCoveragePath

}

</call>

<call function="'createFolder'">

{ 'location' : STAF_REMOTE_HOSTNAME,

'foldername' : remoteCoveragePath

}

</call>

<call function="'createFolder'">

{ 'location' : STAF_REMOTE_HOSTNAME,

'foldername' : ecPath

}

</call>

<call function="'listFolderByExtension'" >

{

'location' : STAF_REMOTE_HOSTNAME,

'foldername' : ecPath,

'extension' : 'ec'

}

</call>

<script>

existingECs=STAXResult

newCoverageEC=os.path.join(ecPath,'coverage%s.ec' % len(existingECs))

coveragefh = open( '%s/emma.properties.%s' % (local.temp,len(existingECs)), 'w' )

coveragefh.write( 'coverage.out.file=%s\n' % newCoverageEC )

coveragefh.write( 'verbosity.level=silent\n')

coveragefh.write( 'coverage.out.merge=true\n')

coveragefh.close()

</script>

<call function="'copyFile'">

{ 'srcfile' : '%s/emma.properties.%s' % (local.temp,len(existingECs)),

'destfile' : '%s/classes/emma.properties' % dsPath,

'remotehost' : STAF_REMOTE_HOSTNAME }

</call>

<call function="'copyFile'">

{ 'location' : STAF_REMOTE_HOSTNAME,

'srcfile' : '%s/coverage.em' % dsPath,

'destfile' : '%s/coverage.em' % remoteCoveragePath,

'remotehost' : STAF_REMOTE_HOSTNAME }

</call>

<call function="'copyFile'">

{ 'location' : STAF_REMOTE_HOSTNAME,

'srcfile' : '%s/coverage.em' % dsPath,

'destfile' : '%s/coverage.em' % resultsCoveragePath,

'remotehost' : STAF_REMOTE_HOSTNAME }

</call>

</sequence>

</if>

<message>'DEBUG PORT: %s' % dsDebugPort</message>

<script>

if dsDebugPort != '' and STAFCmdParams == '':

envCmd = [ 'OPENDJ_JAVA_ARGS=-agentlib:jdwp=transport=dt_socket,address=%s,server=y,suspend=n' % dsDebugPort ]

else:

envCmd = []

</script>

<call function="'runCommand'">

{ 'location' : location,

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : location,

'expectedRC': expectedRC,

'knownIssue': knownIssue,

'envCmd' : envCmd

}

</call>

<return>STAXResult</return>

</sequence>

</function>

<!-- This function stops DS using the stop-ds script -->

<function name="StopDsWithScript">

<function-prolog>

This function starts a Directory Server using the script

</function-prolog>

<function-map-args>

<function-arg-def name="location"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath"

type="optional"

default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsHost" type="optional">

<function-arg-description>

Directory server hostname or IP address

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsAdminPort" type="optional">

<function-arg-description>

Directory server admin port number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsUseSSL" type="optional">

<function-arg-description>

Use SSL for secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseStartTLS" type="optional">

<function-arg-description>

Use StartTLS for secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsBindDN" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsBindPwd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBindPwdFile" type="optional">

<function-arg-description>

Bind password file

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="dsSaslOption" type="optional">

<function-arg-description>

SASL bind options

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsProxyAuthZID" type="optional">

<function-arg-description>

Use the proxied authorization control with the given authorization ID

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsStopReason" type="optional">

<function-arg-description>

Reason the server is being stopped or restarted

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsRestart" type="optional">

<function-arg-description>

Attempt to automatically restart the server once it has stopped

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsStopTime" type="optional">

<function-arg-description>

Time to begin the shutdown in YYYYMMDDhhmmss format (local time)

</function-arg-description>

<function-arg-property name="type" value="timestamp"/>

</function-arg-def>

<function-arg-def name="dsTrustAll" type="optional">

<function-arg-description>

Trust all server SSL certificates

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsKeyStoreFile" type="optional">

<function-arg-description>

Certificate keystore path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePwd" type="optional">

<function-arg-description>

Certificate keystore PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePwdFile" type="optional">

<function-arg-description>

Certificate keystore PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsTrustStoreFile" type="optional">

<function-arg-description>

Certificate trust store path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePwd" type="optional">

<function-arg-description>

Certificate trust store PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePwdFile" type="optional">

<function-arg-description>

Certificate trust store PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Help option

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="noOfLoops"

type="optional"

default="10">

<function-arg-description>

Number of iterations (for isStopped())

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="noOfMilliSeconds"

type="optional"

default="2000">

<function-arg-description>

Number of seconds to wait between iterations (for isStopped())

</function-arg-description>

<function-arg-property name="type" value="seconds"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/stop-ds%s' % (dsBinPath,fileExt)

if dsHost:

STAFCmdParamsList.append('-h %s' % dsHost)

if dsAdminPort:

STAFCmdParamsList.append('-p %s' % dsAdminPort)

STAFCmdParamsList.append('-X')

if dsUseSSL:

STAFCmdParamsList.append('-Z')

if dsUseStartTLS:

STAFCmdParamsList.append('-q')

if dsBindDN:

STAFCmdParamsList.append('-D "%s"' % dsBindDN)

if dsBindPwd:

STAFCmdParamsList.append('-w "%s"' % dsBindPwd)

if dsBindPwdFile:

STAFCmdParamsList.append('-j "%s"' % dsBindPwdFile)

if dsSaslOption:

STAFCmdParamsList.append('-o "%s"' % dsSaslOption)

if dsProxyAuthZID:

STAFCmdParamsList.append('-Y "%s"' % dsProxyAuthZID)

if dsStopReason:

STAFCmdParamsList.append('-r "%s"' % dsStopReason)

if dsRestart:

STAFCmdParamsList.append('-R')

if dsStopTime:

STAFCmdParamsList.append('-t "%s"' % dsStopTime)

if dsKeyStoreFile:

STAFCmdParamsList.append('-K "%s"' % dsKeyStoreFile)

if dsKeyStorePwd:

STAFCmdParamsList.append('-W "%s"' % dsKeyStorePwd)

if dsKeyStorePwdFile:

STAFCmdParamsList.append('-u "%s"' % dsKeyStorePwdFile)

if dsTrustStoreFile:

STAFCmdParamsList.append('-P "%s"' % dsTrustStoreFile)

if dsTrustStorePwd:

STAFCmdParamsList.append('-T "%s"' % dsTrustStorePwd)

if dsTrustStorePwdFile:

STAFCmdParamsList.append('-U "%s"' % dsTrustStorePwdFile)

if dsHelp:

STAFCmdParamsList.append('-H')

STAFCmdParams=' '.join(STAFCmdParamsList)

from java.util import Date

stop_current_time = Date()

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'location' : location,

'name' : 'Stop DS Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<script>

savSTAXResult = STAXResult

</script>

<if expr="dsRestart == None and (expectedRC == 0 or expectedRC == 'noCheck')">

<!--- Check that DS stopped -->

<if expr="IPS_PKG == True">

<call function="'isStopped'">

{ 'location' : location,

'dsPath' : '%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME),

'noOfLoops' : noOfLoops,

'noOfMilliSeconds' : 6000

}

</call>

<else>

<call function="'isStopped'">

{ 'location' : location,

'dsPath' : dsPath,

'noOfLoops' : noOfLoops,

'noOfMilliSeconds' : noOfMilliSeconds

}

</call>

</else>

</if>

</if>

<!-- Get Errors log -->

<message>

'Getting tail of error log on %s/logs/errors' % dsPath

</message>

<call function="'getFile'">

{ 'location' : location,

'filename' : '%s/logs/errors' % dsPath

}

</call>

<script>

tail_logfile(STAXResult,stop_current_time)

</script>

<return>

savSTAXResult

</return>

</sequence>

</function>

<!-- Import-ldif Function -->

<function name="ImportLdifWithScript" scope="local">

<function-prolog>

This function performs an import of an ldif file

</function-prolog>

<function-map-args>

<function-arg-def name="location"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath"

type="optional"

default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory server host name

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceAdminPort" type="optional">

<function-arg-description>

Directory server admin port number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="taskID" type="optional">

<function-arg-description>

The identifier for the task

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="ldifFile" type="optional">

<function-arg-description>

The name of the ldif file

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backEnd"

type="optional"

default="DIRECTORY_INSTANCE_BE">

<function-arg-description>

Optional the name of the database backend

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="wrapColumn" type="optional">

<function-arg-description>

Column at which to wrap long lines

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="startTask" type="optional">

<function-arg-description>

Optional exclude attributes

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="isCompressed" type="optional">

<function-arg-description>

Optional exported ldif data file compressed

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="isEncrypted" type="optional">

<function-arg-description>

Optional exported ldif data file encrypted

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="append" type="optional">

<function-arg-description>

Optional append exported ldif data

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="skipSchemaValidation" type="optional">

<function-arg-description>

Optional do not perform any schema validation

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="templateFile" type="optional">

<function-arg-description>

Optional path to a MakeLDIF template to generate the import data.

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="skipFile" type="optional">

<function-arg-description>

Optional identify entries that were skipped during the import

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="overwriteFile" type="optional">

<function-arg-description>

Optional overwrite the specified skip file or reject file

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="replaceExisting" type="optional">

<function-arg-description>

Optional replace existing data with the content from the import

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="rejectFile" type="optional">

<function-arg-description>

Optional file to hold any rejected entries during the import

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="excludeBranches" type="optional" default="''">

<function-arg-description>

Optional exclude branches

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="includeBranches" type="optional" default="''">

<function-arg-description>

Optional include branches

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="excludeAttributes" type="optional" default="''">

<function-arg-description>

Optional exclude attributes

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="includeAttributes" type="optional" default="''">

<function-arg-description>

Optional include attributes

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="excludeFilters" type="optional" default="''">

<function-arg-description>

Optional exclude filters

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="includeFilters" type="optional" default="''">

<function-arg-description>

Optional exclude filters

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="isSignedHash" type="optional" default="'False'">

<function-arg-description>

Optional generate a signed hash of the export data

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional" default="''">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="numLdapCheckTries" type="optional" default="10">

<function-arg-description>

Number of ldap check tries when checking if task is complete

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="sleepBetweenLdapCheckTries" type="optional" default="2000">

<function-arg-description>

Sleep time in milliseconds between ldap check tries

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

<function-arg-def name="schedulePattern" type="optional">

<function-arg-description>

Indicates the task is recurring and will be scheduled

according to the value argument expressed in crontab(5)

compatible time/date pattern

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Local variables -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

</script>

<!-- Set common ldap arguments -->

<call function="'_adminCommonArgs'" />

<script>

foldersToCreate = []

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/import-ldif%s' % (dsBinPath,fileExt)

if dsInstancePort:

STAFCmdParamsList.append('-p %s' % dsInstancePort)

if ldifFile:

STAFCmdParamsList.append('-l %s' % ldifFile)

if startTask:

STAFCmdParamsList.append('-t %s' % startTask)

if append:

STAFCmdParamsList.append('-a')

if backEnd:

STAFCmdParamsList.append('-n %s' % backEnd)

if skipSchemaValidation:

STAFCmdParamsList.append('-S')

if skipFile:

foldersToCreate.append(os.path.dirname(skipFile))

STAFCmdParamsList.append('--skipFile %s' % skipFile)

if rejectFile:

foldersToCreate.append(os.path.dirname(rejectFile))

STAFCmdParamsList.append('-R %s' % rejectFile)

if overwriteFile:

STAFCmdParamsList.append('-O')

if templateFile:

STAFCmdParamsList.append('-A %s' % templateFile)

if replaceExisting:

STAFCmdParamsList.append('-r')

if schedulePattern:

STAFCmdParamsList.append('--recurringTask %s' % schedulePattern)

if isCompressed:

STAFCmdParamsList.append('-c')

if isEncrypted:

STAFCmdParamsList.append('-y')

if wrapColumn:

STAFCmdParamsList.append('--wrapColumn %s' % wrapColumn)

if excludeBranches:

for branch in excludeBranches:

STAFCmdParamsList.append('-B "%s"' % branch )

if includeBranches:

for branch in includeBranches:

STAFCmdParamsList.append('-b "%s"' % branch )

if excludeAttributes:

for attribute in excludeAttributes:

STAFCmdParamsList.append('-e "%s"' % attribute)

if includeAttributes:

for attribute in includeAttributes:

STAFCmdParamsList.append('-i "%s"' % attribute)

if includeFilters:

for attribute in includeFilters:

STAFCmdParamsList.append('-I "%s"' % attribute)

if excludeFilters:

for attribute in excludeFilters:

STAFCmdParamsList.append('-E "%s"' % attribute )

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<call function="'createMultiFolders'">

{ 'location' : location,

'folderslist' : foldersToCreate

}

</call>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<message>

'Start import-ldif'

</message>

<call function="'runCommand'">

{ 'location' : location,

'name' : 'Import Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'expectedRC' : expectedRC,

'knownIssue' : knownIssue

}

</call>

<script>

savSTAXResult = STAXResult

resultString = STAXResult[0][1]

</script>

<if expr="dsInstanceDn != None and expectedRC == 0 and schedulePattern == None">

<sequence>

<message>

'Check import-ldif task successfully completed'

</message>

<call function="'checkTaskExecution'">

{

'dsPath' : dsPath,

'dsInstanceAdminPort' : dsInstanceAdminPort,

'dsInstanceHost' : dsInstanceHost ,

'dsInstanceDn' : dsInstanceDn ,

'dsInstancePswd' : dsInstancePswd ,

'outputToCheck' : resultString

}

</call>

</sequence>

</if>

<return>

savSTAXResult

</return>

</sequence>

</function>

<!-- Check Import Function -->

<function name="checkImport" scope="local">

<function-prolog>

This function verifies an import of an ldif file

</function-prolog>

<function-map-args>

<function-arg-def name="location"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath"

type="optional"

default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsHost"

type="optional"

default="DIRECTORY_INSTANCE_HOST">

<function-arg-description>

Directory server hostname or IP address

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPort"

type="optional"

default="DIRECTORY_INSTANCE_PORT">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsAdminPort"

type="optional"

default="DIRECTORY_INSTANCE_ADMIN_PORT">

<function-arg-description>

Directory server admin port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsDn"

type="optional"

default="DIRECTORY_INSTANCE_DN">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsPswd"

type="optional"

default="DIRECTORY_INSTANCE_PSWD">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBaseDN" type="optional">

<function-arg-description>

The baseDN for the search operation

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="expectedEntries" type="required">

<function-arg-description>

Entries expected to be present after import

</function-arg-description>

<function-arg-property name="type" value="list"/>

</function-arg-def>

<function-arg-def name="missingEntries"

type="optional"

default="'NULL'">

<function-arg-description>

Optional entries expected to be missing after import

</function-arg-description>

<function-arg-property name="type" value="list"/>

</function-arg-def>

<function-arg-def name="expectedAttributes"

type="optional"

default="'NULL'">

<function-arg-description>

Optional attributes expected to be present after import

</function-arg-description>

<function-arg-property name="type" value="list"/>

</function-arg-def>

<function-arg-def name="missingAttributes"

type="optional"

default="'NULL'">

<function-arg-description>

Optional attributes expected to be missing after import

</function-arg-description>

<function-arg-property name="type" value="list"/>

</function-arg-def>

<function-arg-def name="expectedNoEntries"

type="optional"

default="None">

<function-arg-description>

Optional no of entries expected after import

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="suffix"

type="optional"

default="DIRECTORY_INSTANCE_SFX">

<function-arg-description>

Optional main suffix for the import

</function-arg-description>

<function-arg-property name="type" value="list"/>

</function-arg-def>

<function-arg-def name="startDS" type="optional" default="'yes'">

<function-arg-description>

Optional start the Directory Server after import

</function-arg-description>

<function-arg-property name="type" value="list"/>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Local variables -->

<script>

myLocation=location

myPath=dsPath

myhost=dsHost

myport=dsPort

myadminport=dsAdminPort

mydn=dsDn

mypswd=dsPswd

mybasedn=dsBaseDN

</script>

<!-- Assume that if DS is not started then there is no need to stop it -->

<script>

if startDS == 'yes':

stopDS='yes'

else:

stopDS='no'

</script>

<!-- Do we need to start the DS -->

<if expr="startDS == 'yes'">

<sequence>

<!-- StartDS -->

<call function="'StartDsWithScript'">

{ 'location' : myLocation,

'dsPath' : myPath }

</call>

<!-- Wait for DS to start -->

<call function="'isAlive'">

{ 'location' : myLocation,

'dsPath' : myPath,

'dsInstanceHost' : myhost ,

'dsInstancePort' : myport ,

'dsInstanceDn' : mydn ,

'dsInstancePswd' : mypswd ,

'noOfLoops' : 10 ,

'noOfMilliSeconds' : 2000 }

</call>

</sequence>

</if>

<!-- Count number of expected entries after import -->

<if expr="expectedNoEntries != None">

<sequence>

<message>'Expected number of entries is %s' % expectedNoEntries</message>

<call function="'ldapSearchWithScript'">

{ 'location' : myLocation ,

'dsPath' : myPath,

'dsInstanceHost' : myhost ,

'dsInstancePort' : myport ,

'dsInstanceDn' : mydn ,

'dsInstancePswd' : mypswd ,

'dsBaseDN' : mybasedn ,

'dsFilter' : 'objectclass=*',

'dsAttributes' : 'dn',

'dsCountEntries' : True

}

</call>

<script>

returnString = STAXResult[0][1]

</script>

<call function="'searchString'">

{ 'expectedString' : 'Total number of matching entries: %s' % expectedNoEntries,

'returnString' : returnString ,

'expectedRC' : expectedRC ,

}

</call>

</sequence>

</if>

<!-- Search for expected entries -->

<iterate var="expectedEntry" in="expectedEntries">

<sequence>

<call function="'ldapSearchWithScript'">

{ 'location' : myLocation ,

'dsPath' : myPath,

'dsInstanceHost' : myhost ,

'dsInstancePort' : myport ,

'dsInstanceDn' : mydn ,

'dsInstancePswd' : mypswd ,

'dsBaseDN' : '%s' % expectedEntry ,

'dsScope' : 'base' ,

'dsFilter' : 'objectclass=*',

'dsAttributes' : 'dn'

}

</call>

</sequence>

</iterate>

<!-- Search for missing entries -->

<iterate var="missingEntry" in="missingEntries">

<sequence>

<if expr="missingEntry == 'NULL'">

<break/>

</if>

<call function="'SearchObject'">

{ 'location' : myLocation ,

'dsPath' : myPath,

'dsInstanceHost' : myhost ,

'dsInstancePort' : myport ,

'dsInstanceDn' : mydn ,

'dsInstancePswd' : mypswd ,

'dsBaseDN' : '%s' % missingEntry ,

'dsScope' : 'base' ,

'dsFilter' : 'objectclass=*' ,

'attributes' : 'dn' ,

'expectedRC' : 32

}

</call>

</sequence>

</iterate>

<!-- Do we need to stop the Directory Server -->

<if expr="stopDS == 'yes'">

<!-- StopDS -->

<call function="'StopDsWithScript'">

{ 'location' : myLocation ,

'dsPath' : myPath,

'dsHost' : myhost ,

'dsAdminPort' : myadminport ,

'dsBindDN' : mydn ,

'dsBindPwd' : mypswd }

</call>

</if>

</sequence>

</function>

<!-- Export-ldif Function -->

<function name="exportLdifWithScript" scope="local">

<function-prolog>

This function performs an on line export task of an ldif file

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory server host name

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceAdminPort" type="optional">

<function-arg-description>

Directory server admin port number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="taskID" type="optional">

<function-arg-description>

The identifier for the task

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="ldifFile" type="optional">

<function-arg-description>

The name of the ldif file

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backEnd" type="optional" default="DIRECTORY_INSTANCE_BE">

<function-arg-description>

Optional the name of the database backend

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="wrapColumn" type="optional">

<function-arg-description>

Column at which to wrap long lines

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="startTask" type="optional">

<function-arg-description>

Optional exclude attributes

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="isCompressed" type="optional">

<function-arg-description>

Optional exported ldif data file compressed

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="isEncrypted" type="optional">

<function-arg-description>

Optional exported ldif data file encrypted

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="append" type="optional">

<function-arg-description>

Optional append exported ldif data

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="excludeBranches" type="optional" default="''">

<function-arg-description>

Optional exclude branches

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="includeBranches" type="optional" default="''">

<function-arg-description>

Optional include branches

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="excludeAttributes" type="optional" default="''">

<function-arg-description>

Optional exclude attributes

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="includeAttributes" type="optional" default="''">

<function-arg-description>

Optional include attributes

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="excludeFilters" type="optional" default="''">

<function-arg-description>

Optional exclude filters

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="includeFilters" type="optional" default="''">

<function-arg-description>

Optional exclude filters

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="isSignedHash" type="optional" default="'False'">

<function-arg-description>

Optional generate a signed hash of the export data

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional" default="''">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="schedulePattern" type="optional">

<function-arg-description>

Indicates the task is recurring and will be scheduled

according to the value argument expressed in crontab(5)

compatible time/date pattern

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Local variables -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

</script>

<!-- Set common ldap arguments -->

<call function="'_adminCommonArgs'" />

<script>

foldersToCreate = []

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/export-ldif%s' % (dsBinPath,fileExt)

if dsInstancePort:

STAFCmdParamsList.append('-p %s' % dsInstancePort)

if ldifFile:

foldersToCreate.append(os.path.dirname(ldifFile))

STAFCmdParamsList.append('-l %s' % ldifFile)

if startTask:

STAFCmdParamsList.append('-t %s' % startTask)

if append:

STAFCmdParamsList.append('-a')

if backEnd:

STAFCmdParamsList.append('-n %s' % backEnd)

if schedulePattern:

STAFCmdParamsList.append('--recurringTask %s' % schedulePattern)

if isCompressed:

STAFCmdParamsList.append('-c')

if isEncrypted:

STAFCmdParamsList.append('-y')

if wrapColumn:

STAFCmdParamsList.append('--wrapColumn %s' % wrapColumn)

if excludeBranches:

for branch in excludeBranches:

STAFCmdParamsList.append('-B "%s"' % branch )

if includeBranches:

for branch in includeBranches:

STAFCmdParamsList.append('-b "%s"' % branch )

if excludeAttributes:

for attribute in excludeAttributes:

STAFCmdParamsList.append('-e "%s"' % attribute)

if includeAttributes:

for attribute in includeAttributes:

STAFCmdParamsList.append('-i "%s"' % attribute)

if includeFilters:

for filter in includeFilters:

STAFCmdParamsList.append('-I "%s"' % filter)

if excludeFilters:

for filter in excludeFilters:

STAFCmdParamsList.append('-E "%s"' % filter)

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<call function="'createMultiFolders'">

{ 'location' : location,

'folderslist' : foldersToCreate

}

</call>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<message>

'Start export-ldif'

</message>

<call function="'runCommand'">

{ 'location' : location,

'name' : 'Export Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'expectedRC' : expectedRC

}

</call>

<script>

savSTAXResult=STAXResult

resultString = STAXResult[0][1]

</script>

<if expr="dsInstanceDn != None and expectedRC == 0 and schedulePattern == None">

<sequence>

<message>

'Check export-ldif task successfully completed'

</message>

<call function="'checkTaskExecution'">

{

'dsPath' : dsPath,

'dsInstanceAdminPort' : dsInstanceAdminPort,

'dsInstanceHost' : dsInstanceHost ,

'dsInstanceDn' : dsInstanceDn ,

'dsInstancePswd' : dsInstancePswd ,

'outputToCheck' : resultString

}

</call>

</sequence>

</if>

<return>

savSTAXResult

</return>

</sequence>

</function>

<!-- Backup Function -->

<function name="backup" scope="local">

<function-prolog>

This function performs an off line backup

</function-prolog>

<function-map-args>

<function-arg-def name="location"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath"

type="optional"

default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory server hostname or IP address

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstanceAdminPort" type="optional">

<function-arg-description>

Directory server admin port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backEnd" type="optional" default="DIRECTORY_INSTANCE_BE">

<function-arg-description>

Optional the name of the database backend

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backupDir" type="required">

<function-arg-description>

The directory where the backup files will be placed

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional" default="''">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="startTask" type="optional">

<function-arg-description>

Start time for task

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

<function-arg-def name="schedulePattern" type="optional">

<function-arg-description>

Indicates the task is recurring and will be scheduled

according to the value argument expressed in crontab(5)

compatible time/date pattern

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backupID" type="optional">

<function-arg-description>

Use the provided identifier for the backup

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

</function-map-args>

<sequence>

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

</script>

<!-- Set common ldap arguments -->

<call function="'_adminCommonArgs'" />

<script>

foldersToCreate = []

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/backup%s' % (dsBinPath,fileExt)

if backupDir:

foldersToCreate.append(os.path.dirname(backupDir))

STAFCmdParamsList.append('-d %s' % backupDir)

if backEnd:

STAFCmdParamsList.append('-n %s' % backEnd)

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

if startTask:

STAFCmdParamsList.append('-t %s' % startTask)

if backupID:

STAFCmdParamsList.append('-I %s' % backupID)

if schedulePattern:

STAFCmdParamsList.append('--recurringTask %s' % schedulePattern)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<call function="'createMultiFolders'">

{ 'location' : location,

'folderslist' : foldersToCreate

}

</call>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<message>

'Start backup'

</message>

<call function="'runCommand'">

{ 'location' : location,

'name' : 'Backup Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<!-- Backup Task Function -->

<function name="backupTask" scope="local">

<function-prolog>

This function performs an on line backup task

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory server host name

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

</function-arg-def>

<function-arg-def name="taskID" type="optional">

<function-arg-description>

The identifier for the task

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backupDir" type="required">

<function-arg-description>

Path to the target directory for the backup file(s)

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="backEnd" type="optional" default="DIRECTORY_INSTANCE_BE">

<function-arg-description>

Optional the name of the database backend

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backupAll" type="optional" default="'False'">

<function-arg-description>

Optional back up all backends in the server

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="backupIncremental" type="optional">

<function-arg-description>

Optional perform an incremental backup rather than a full backup

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backupIncrementalId" type="optional">

<function-arg-description>

Optional use the provided identifier for the backup

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="Compress" type="optional" default="'FALSE'">

<function-arg-description>

Optional backup contents compressed

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="Encrypt" type="optional" default="'FALSE'">

<function-arg-description>

Optional backup contents encrypted

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="signHash" type="optional" default="'FALSE'">

<function-arg-description>

Optional generate a signed hash of the backup data

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="hash" type="optional" default="'FALSE'">

<function-arg-description>

Optional generate a hash of the backup data

</function-arg-description>

<function-arg-property name="type" value="boolean"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

</function-map-args>

<sequence>

<script>

myLocation=location

myPath=dsPath

m = md5_hash()

m.update(location)

m.update(dsPath)

taskLdifFile='backup-task-%s.ldif' % m.hexdigest()

taskLdif='%s/%s' % (remote.temp,taskLdifFile)

tmpTaskLdif='%s/%s' % (local.temp,taskLdifFile)

taskDN='ds-task-id=%s,cn=Scheduled Tasks,cn=Tasks' % taskID

</script>

<!-- Build the backup task configuration object -->

<script>

if not os.path.exists(os.path.dirname(backupDir)):

os.makedirs(os.path.dirname(backupDir))

ldifLines=[]

ldifLines.append('dn: %s' % taskDN)

ldifLines.append('objectclass: top')

ldifLines.append('objectclass: ds-task')

ldifLines.append('objectclass: ds-task-backup')

ldifLines.append('ds-task-class-name: org.opends.server.tasks.BackupTask')

ldifLines.append('ds-backup-id: %s' % taskID)

ldifLines.append('ds-task-backup-backend-id: %s' % backEnd )

ldifLines.append('ds-backup-directory-path: %s' % backupDir )

ldifLines.append('ds-task-backup-all: %s' % backupAll )

ldifLines.append('ds-task-backup-compress: %s' % Compress )

ldifLines.append('ds-task-backup-encrypt: %s' % Encrypt )

ldifLines.append('ds-task-backup-sign-hash: %s' % signHash )

ldifLines.append('ds-task-backup-hash: %s' % hash )

if backupIncremental:

ldifLines.append('ds-task-backup-incremental: %s' % backupIncremental )

if backupIncrementalId:

ldifLines.append('ds-task-backup-incremental-base-id: %s' % backupIncrementalId )

</script>

<!-- Write out the backup-task ldif -->

<script>

outfile = open(tmpTaskLdif,"w")

for line in ldifLines:

outfile.write("%s\n" % line)

outfile.close()

</script>

<!-- Copy the backup-task ldif to remote host -->

<message>'Copy backup task ldif file.'</message>

<call function="'copyFile'">

{ 'location' : STAXServiceMachine,

'srcfile' : tmpTaskLdif,

'destfile' : taskLdif,

'remotehost' : myLocation }

</call>

<!-- Start the task using ldap task interface -->

<call function="'StartLdapTask'">

{ 'location' : myLocation,

'dsPath' : myPath,

'taskLabel' : 'Online Backup Task',

'dsHost' : dsInstanceHost,

'dsPort' : dsInstancePort,

'dsBindDn' : dsInstanceDn,

'dsBindPswd' : dsInstancePswd,

'dsTaskLdif' : taskLdif,

'expectedRC' : expectedRC }

</call>

<script>

STAFCmdRC=STAXResult[0]

</script>

<!-- Check that the ldap task is completed -->

<if expr="STAFCmdRC == 0">

<sequence>

<call function="'CheckLdapTask'">

{ 'location' : myLocation,

'dsPath' : myPath,

'dsTaskDn' : taskDN,

'dsHost' : dsInstanceHost,

'dsPort' : dsInstancePort,

'dsBindDn' : dsInstanceDn,

'dsBindPswd' : dsInstancePswd }

</call>

<message>'Check CheckLdapTask returns RC=0'</message>

<call function="'checktestRC'">

{ 'returncode' : RC ,

'result' : STAXResult }

</call>

</sequence>

</if>

</sequence>

</function>

<!-- Restore Function -->

<function name="restore">

<function-prolog>

This function performs an off line restore

</function-prolog>

<function-map-args>

<function-arg-def name="location"

type="optional"

default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath"

type="optional"

default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory server hostname or IP address

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstanceAdminPort" type="optional">

<function-arg-description>

Directory server admin port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backupDir" type="required">

<function-arg-description>

The directory where the backup files will be placed

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional" default="''">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="startTask" type="optional">

<function-arg-description>

Start time for task

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

<function-arg-def name="schedulePattern" type="optional">

<function-arg-description>

Indicates the task is recurring and will be scheduled

according to the value argument expressed in crontab(5)

compatible time/date pattern

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="backupID" type="optional">

<function-arg-description>

Use the provided identifier for the backup

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

</function-map-args>

<sequence>

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

</script>

<!-- Set common ldap arguments -->

<call function="'_adminCommonArgs'" />

<script>

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/restore%s' % (dsBinPath,fileExt)

if backupDir:

STAFCmdParamsList.append('-d %s' % backupDir)

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

if startTask:

STAFCmdParamsList.append('-t %s' % startTask)

if backupID:

STAFCmdParamsList.append('-I %s' % backupID)

if schedulePattern:

STAFCmdParamsList.append('--recurringTask %s' % schedulePattern)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'location' : location,

'name' : 'Restore Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<!-- Restore Task Function -->

<function name="restoreTask">

<function-prolog>

This function performs an on line restore task of a backup file

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>