IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.services.ldap.model
Class LDAPGetAttributesRequest

java.lang.Object
  extended by com.ibm.btt.services.ldap.model.LDAPRequest
      extended by com.ibm.btt.services.ldap.model.LDAPGetAttributesRequest

public class LDAPGetAttributesRequest
extends LDAPRequest

This class supports the getattributes request to the LDAP service.


Field Summary
 
Fields inherited from class com.ibm.btt.services.ldap.model.LDAPRequest
COMPID, requestType
 
Constructor Summary
LDAPGetAttributesRequest()
          This constructor creates an LDAPGetAttributesRequest object.
 
Method Summary
 void addAttributeToReturn(java.lang.String attributeName)
          Manages the list of attributes to return.
 java.lang.String[] getReturningAttributes()
          Gets the present list of attributes that are desired to be returned.
 void mapFromContext(Context context)
          Supports externalization of an LDAP getattributes request.
 void removeAttributeToReturn(java.lang.String attributeName)
          Manages the list of attributes to return.
 void setReturningAttributes(java.lang.String[] newReturningAttributes)
          The array passed into this method should contain the names of attributes that the LDAP server should make an attempt to return.
 
Methods inherited from class com.ibm.btt.services.ldap.model.LDAPRequest
getBooleanValue, getIntValue, getName, getRequestType, getValue, setName, setRequestType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LDAPGetAttributesRequest

public LDAPGetAttributesRequest()
This constructor creates an LDAPGetAttributesRequest object.

Method Detail

addAttributeToReturn

public void addAttributeToReturn(java.lang.String attributeName)
Manages the list of attributes to return. This utility method adds an object to the list.

Parameters:
attributeName - java.lang.String

getReturningAttributes

public java.lang.String[] getReturningAttributes()
Gets the present list of attributes that are desired to be returned.

Returns:
java.lang.String[]

mapFromContext

public void mapFromContext(Context context)
                    throws DSEException
Supports externalization of an LDAP getattributes request. It maps external data definitions from a context into the request model.

Overrides:
mapFromContext in class LDAPRequest
Parameters:
context - com.ibm.btt.base.Context
Throws:
DSEException

removeAttributeToReturn

public void removeAttributeToReturn(java.lang.String attributeName)
Manages the list of attributes to return. This utility method removes an attribute from this list.

Parameters:
attributeName - java.lang.String

setReturningAttributes

public void setReturningAttributes(java.lang.String[] newReturningAttributes)
The array passed into this method should contain the names of attributes that the LDAP server should make an attempt to return. The protocol does not garauntee that the attributes returned by the server will have the same names as supplied in this array.

Parameters:
newReturningAttributes - java.lang.String[]

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011