ldap.xml revision d6c71e7b06ef8919af4c8186b4ffb08766c20a09
0N/A<?xml version="1.0" encoding="UTF-8" standalone="no"?>
0N/A<!DOCTYPE stax SYSTEM "stax.dtd">
0N/A<!--
0N/A ! CDDL HEADER START
0N/A !
0N/A ! The contents of this file are subject to the terms of the
0N/A ! Common Development and Distribution License, Version 1.0 only
0N/A ! (the "License"). You may not use this file except in compliance
0N/A ! with the License.
0N/A !
0N/A ! You can obtain a copy of the license at
0N/A ! trunk/opends/resource/legal-notices/OpenDS.LICENSE
0N/A ! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
0N/A ! See the License for the specific language governing permissions
0N/A ! and limitations under the License.
0N/A !
0N/A ! When distributing Covered Code, include this CDDL HEADER in each
0N/A ! file and include the License file at
0N/A ! trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
0N/A ! add the following below this CDDL HEADER, with the fields enclosed
0N/A ! by brackets "[]" replaced with your own identifying * information:
0N/A ! Portions Copyright [yyyy] [name of copyright owner]
0N/A !
0N/A ! CDDL HEADER END
0N/A !
0N/A ! Portions Copyright 2006-2007 Sun Microsystems, Inc.
0N/A ! -->
0N/A<stax>
0N/A
0N/A <function name="addEntry">
0N/A
0N/A <function-prolog>
0N/A This function adds an entry to the Directory Server
0N/A </function-prolog>
0N/A
0N/A <function-map-args>
0N/A <function-required-arg name="dsInstanceHost">
0N/A Directory Server Host Name
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstancePort">
0N/A Directory Server Port Number
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstanceDn">
0N/A Directory Server Manager DN
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstancePswd">
0N/A Directory Server Manager Password
0N/A </function-required-arg>
0N/A <function-required-arg name="entryToBeAdded">
0N/A Entry to be added to Directory Server in ldif format
0N/A </function-required-arg>
0N/A <function-optional-arg name="extraParams" default="' '">
0N/A Optional extra parameters for specific test cases
0N/A </function-optional-arg>
0N/A </function-map-args>
0N/A
0N/A <sequence>
0N/A
0N/A <message>
0N/A 'ldapmodify%s -a -h %s -p %s -D "%s" -w %s %s -f "%s"' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,entryToBeAdded)
0N/A </message>
0N/A <process name="'Add Entry'">
0N/A <location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
0N/A <command>'%s/ldapmodify%s' % (OPENDS_BINPATH,fileExt)</command>
0N/A <parms>'-a -h %s -p %s -D "%s" -w %s %s -f "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,entryToBeAdded)</parms>
0N/A <workdir>'%s' % (OPENDS_BINPATH)</workdir>
0N/A <envs>
0N/A ['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
0N/A </envs>
0N/A <stderr mode="'stdout'"/>
0N/A <returnstdout/>
0N/A </process>
0N/A
0N/A <call function="'checkRC'">
0N/A { 'returncode' : RC ,
0N/A 'result' : STAXResult }
0N/A </call>
0N/A
0N/A </sequence>
0N/A
0N/A </function>
0N/A
0N/A <function name="modifyEntry">
0N/A
0N/A <function-prolog>
0N/A This function modifies an entry in the Directory Server
0N/A </function-prolog>
0N/A
0N/A <function-map-args>
0N/A <function-required-arg name="dsInstanceHost">
0N/A Directory Server Host Name
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstancePort">
0N/A Directory Server Port Number
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstanceDn">
0N/A Directory Server Manager DN
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstancePswd">
0N/A Directory Server Manager Password
0N/A </function-required-arg>
0N/A <function-required-arg name="entryToBeModified">
0N/A Entry to be modified in the Directory Server in ldif format
0N/A </function-required-arg>
0N/A <function-optional-arg name="extraParams" default="' '">
0N/A Optional extra parameters for specific test cases
0N/A </function-optional-arg>
0N/A </function-map-args>
0N/A
0N/A <sequence>
0N/A
0N/A <message>
0N/A 'ldapmodify%s -h %s -p %s -D "%s" -w %s %s -f "%s"' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,entryToBeModified)
0N/A </message>
0N/A <process name="'Modify Entry'">
0N/A <location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
0N/A <command>'%s/ldapmodify%s' % (OPENDS_BINPATH,fileExt)</command>
0N/A <parms>'-h %s -p %s -D "%s" -w %s %s -f "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,entryToBeModified)</parms>
0N/A <workdir>'%s' % (OPENDS_BINPATH)</workdir>
0N/A <envs>
0N/A ['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
0N/A </envs>
0N/A <stderr mode="'stdout'"/>
0N/A <returnstdout/>
0N/A </process>
0N/A
0N/A <call function="'checkRC'">
0N/A { 'returncode' : RC ,
0N/A 'result' : STAXResult }
0N/A </call>
0N/A
0N/A </sequence>
0N/A
0N/A </function>
0N/A
0N/A <function name="SearchObject">
0N/A
0N/A <function-prolog>
0N/A This function searches the Directory Server with optional arguments possible
0N/A </function-prolog>
0N/A
0N/A <function-map-args>
0N/A <function-required-arg name="dsInstanceHost">
0N/A Directory Server Host Name
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstancePort">
0N/A Directory Server Port Number
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstanceDn">
0N/A Directory Server Manager DN
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstancePswd">
0N/A Directory Server Manager Password
0N/A </function-required-arg>
0N/A <function-required-arg name="dsBaseDN">
0N/A The baseDN for the search operation
0N/A </function-required-arg>
0N/A <function-required-arg name="dsFilter">
0N/A The filter for the search operation
0N/A </function-required-arg>
0N/A <function-optional-arg name="extraParams" default="' '">
0N/A Optional extra parameters for specific test cases
0N/A </function-optional-arg>
0N/A <function-optional-arg name="attributes" default="' '">
0N/A Attributes to return
0N/A </function-optional-arg>
0N/A </function-map-args>
0N/A
0N/A <sequence>
0N/A
0N/A <message>
0N/A 'ldapsearch%s -h %s -p %s -D "%s" -w %s %s -b "%s" "%s" "%s"' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,dsBaseDN,dsFilter,attributes)
0N/A </message>
0N/A <process name="'Search Base Object'">
0N/A <location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
0N/A <command>'%s/ldapsearch%s' % (OPENDS_BINPATH,fileExt)</command>
0N/A <parms>'-h %s -p %s -D "%s" -w %s %s -b "%s" "%s" "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,dsBaseDN,dsFilter,attributes)</parms>
0N/A <workdir>'%s' % (OPENDS_BINPATH)</workdir>
0N/A <envs>
0N/A ['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
0N/A </envs>
0N/A <stderr mode="'stdout'"/>
0N/A <returnstdout/>
0N/A </process>
0N/A
0N/A <return>STAXResult</return>
0N/A
0N/A </sequence>
0N/A
0N/A </function>
0N/A
0N/A <function name="SearchObjectNoPwd">
0N/A
0N/A <function-prolog>
0N/A This function searches the Directory Server with optional arguments possible
0N/A </function-prolog>
0N/A
0N/A <function-map-args>
0N/A <function-required-arg name="dsInstanceHost">
0N/A Directory Server Host Name
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstancePort">
0N/A Directory Server Port Number
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstanceDn">
0N/A Directory Server Manager DN
0N/A </function-required-arg>
0N/A <function-required-arg name="dsBaseDN">
0N/A The baseDN for the search operation
0N/A </function-required-arg>
0N/A <function-required-arg name="dsFilter">
0N/A The filter for the search operation
0N/A </function-required-arg>
0N/A <function-optional-arg name="extraParams" default="' '">
0N/A Optional extra parameters for specific test cases
0N/A </function-optional-arg>
0N/A </function-map-args>
0N/A
0N/A <sequence>
0N/A
0N/A <message>
0N/A 'ldapsearch%s -h %s -p %s -D "%s" %s -b "%s" "%s"' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,extraParams,dsBaseDN,dsFilter)
0N/A </message>
0N/A <process name="'Search Base Object'">
0N/A <location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
0N/A <command>'%s/ldapsearch%s' % (OPENDS_BINPATH,fileExt)</command>
0N/A <parms>'-h %s -p %s -D "%s" %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,extraParams,dsBaseDN,dsFilter)</parms>
0N/A <workdir>'%s' % (OPENDS_BINPATH)</workdir>
0N/A <envs>
0N/A ['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
0N/A </envs>
0N/A <stderr mode="'stdout'"/>
0N/A <returnstdout/>
0N/A </process>
0N/A
0N/A </sequence>
0N/A
0N/A </function>
0N/A
0N/A <function name="AnonSearchObject">
0N/A
0N/A <function-prolog>
0N/A This function searches the Directory Server anonymously with optional arguments possible
0N/A </function-prolog>
0N/A
0N/A <function-map-args>
0N/A <function-required-arg name="dsInstanceHost">
0N/A Directory Server Host Name
0N/A </function-required-arg>
0N/A <function-required-arg name="dsInstancePort">
0N/A Directory Server Port Number
0N/A </function-required-arg>
0N/A <function-required-arg name="dsBaseDN">
0N/A The baseDN for the search operation
0N/A </function-required-arg>
0N/A <function-required-arg name="dsFilter">
0N/A The filter for the search operation
0N/A </function-required-arg>
0N/A <function-optional-arg name="extraParams" default="' '">
0N/A Optional extra parameters for specific test cases
0N/A </function-optional-arg>
0N/A </function-map-args>
0N/A
<sequence>
<message>
'ldapsearch%s -h %s -p %s %s -b "%s" "%s"' % (fileExt,dsInstanceHost,dsInstancePort,extraParams,dsBaseDN,dsFilter)
</message>
<process name="'Anonymous Search Base Object'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<command>'%s/ldapsearch%s' % (OPENDS_BINPATH,fileExt)</command>
<parms>'-h %s -p %s %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,extraParams,dsBaseDN,dsFilter)</parms>
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
<envs>
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
</sequence>
</function>
<function name="DeleteEntry">
<function-prolog>
This function an entry in the Directory Server
</function-prolog>
<function-map-args>
<function-required-arg name="dsInstanceHost">
Directory Server Host Name
</function-required-arg>
<function-required-arg name="dsInstancePort">
Directory Server Port Number
</function-required-arg>
<function-required-arg name="dsInstanceDn">
Directory Server Manager DN
</function-required-arg>
<function-required-arg name="dsInstancePswd">
Directory Server Manager Password
</function-required-arg>
<function-required-arg name="dsBaseDN">
The entry to be deleted
</function-required-arg>
<function-optional-arg name="extraParams" default="' '">
Optional extra parameters for specific test cases
</function-optional-arg>
</function-map-args>
<sequence>
<message>
'ldapdelete%s -h %s -p %s -D "%s" -w %s %s "%s"' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,dsBaseDN)
</message>
<process name="'Delete Object'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<command>'%s/ldapdelete%s' % (OPENDS_BINPATH,fileExt)</command>
<parms>'-h %s -p %s -D "%s" -w %s %s "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,dsBaseDN)</parms>
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
<envs>
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<call function="'checkRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</function>
<function name="compareEntry">
<function-prolog>
This function compares the attribute and value an entry to the Directory Server
</function-prolog>
<function-map-args>
<function-required-arg name="dsInstanceHost">
Directory Server Host Name
</function-required-arg>
<function-required-arg name="dsInstancePort">
Directory Server Port Number
</function-required-arg>
<function-required-arg name="dsInstanceDn">
Directory Server Manager DN
</function-required-arg>
<function-required-arg name="dsInstancePswd">
Directory Server Manager Password
</function-required-arg>
<function-required-arg name="attrToBeCompared">
Attribute to be compared in Directory Server
</function-required-arg>
<function-required-arg name="entryToBeCompared">
Entry to be compared in Directory Server
</function-required-arg>
<function-optional-arg name="extraParams" default="' '">
Optional extra parameters for specific test cases
</function-optional-arg>
</function-map-args>
<sequence>
<message>
'ldapcompare%s -h %s -p %s -D "%s" -w %s %s "%s" "%s"' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,attrToBeCompared,entryToBeCompared)
</message>
<process name="'Compare Entry'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<command>'%s/ldapcompare%s' % (OPENDS_BINPATH,fileExt)</command>
<parms>'-h %s -p %s -D "%s" -w %s %s "%s" "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,extraParams,attrToBeCompared,entryToBeCompared)</parms>
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
<envs>
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
</sequence>
</function>
</stax>