In-Subtree
Description
Tests to see if the distinguished name for a given user is in a subtree of a directory service. If the user name exists, then a status message is returned. If the user does not exist, then an exception is returned.
Syntax
<ie:webject name="In-Subtree" type="ACT">
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="DBUSER" data="dbuser_name"/>
<ie:param name="GROUP_OUT" data="group_name"/>
<ie:param name="INSTANCE" data="instance_name"/>
<ie:param name="OBJECT" data="context_name"/>
<ie:param name="PASSWD" data="dbpassword"/>
<ie:param name="SUBTREE_OBJECT" data="context_name"/>
</ie:webject>
Parameters
|
Required
|
Optional
|
|
INSTANCE
|
CONNECTION_ATTEMPTS
|
|
OBJECT
|
CONNECTION_ATTEMPT_INTERVAL
|
|
SUBTREE_OBJECT
|
DBUSER
|
|
GROUP_OUT
|
|
PASSWD
|
CONNECTION_ATTEMPTS
Defines the maximum number of times to attempt establishing a connection to an adapter before returning an error. The default value is 1. This parameter is optional.
If multiple INSTANCE parameter values are specified, the value of CONNECTION_ATTEMPTS defines the maximum number of times to iterate through the list of adapter instances.
CONNECTION_ATTEMPT_INTERVAL
Defines the amount of time, in seconds, to delay between connection attempts. The default value is 60 seconds. This parameter is optional.
If multiple INSTANCE parameter values are specified, the value of CONNECTION_ATTEMPT_INTERVAL defines the number of seconds to wait between the attempts to iterate through the entire list of adapter instances.
DBUSER
Specifies the name to use when logging in to the data repository. If this parameter is specified in this webject, the webject value takes precedence over any value specified in the credentials mapping settings or in the adapter LDAP entry. If this parameter is not specified here, it must be specified in the credentials mapping settings or in the adapter LDAP entry. For more information about credentials mapping, see the section
Credentials Mapping.
GROUP_OUT
Identifies the name of the object set returned by the action. Currently, GROUP_OUT only returns a status message. This parameter is optional.
INSTANCE
Specifies the name of the adapter that executes the webject. Adapter names are defined when the adapter is configured for use in your Info*Engine environment. This parameter is required.
To connect to other adapters if a specific adapter is not available, this parameter can be multi-valued. Info*Engine attempts to connect to the adapters in the order given. If the first adapter specified in not available, the next adapter listed is tried, and so on, until a connection is made. If a connection cannot be established with any listed adapter, an error is returned.
In conjunction with this parameter, you can include two other parameters, CONNECTION_ATTEMPTS and CONNECTION_ATTEMPT_INTERVAL.
OBJECT
Specifies the context name of the entry. One object may be specified. If more than one is specified, the first will be used and the remainder ignored. This is an optional parameter.
PASSWD
Specifies the password to use when logging in to the data repository. If this parameter is specified in this webject, the webject value takes precedence over any value specified in the credentials mapping settings or in the adapter LDAP entry. If this parameter is not specified here, it must be specified in the credentials mapping settings or in the adapter LDAP entry. For more information about credentials mapping, see the section
Credentials Mapping.
SUBTREE_OBJECT
Specifies the context name of the node under which a user must exist within a subtree. This is a required parameter.
Example
The In-Subtree webject shown in this example instructs Info*Engine to connect to the appropriate adapter instance. Once connected, the adapter determines if the submitted object exists in the named subtree.
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject NAME="In-Subtree" type="ACT">
<ie:param name="INSTANCE" data="jndiAdapter"/>
<ie:param name="SUBTREE_OBJECT
data="ou-people,o=organization.com"/>
<ie:param name="OBJECT"
data="uid=PPeople,ou=people,o=organization.com"/>
<ie:param name="GROUP_OUT" data="Create"/>
</ie:webject>