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

java.lang.Object
  |
  +--com.ibm.dse.services.ldap.model.LDAPRequest
        |
        +--com.ibm.dse.services.ldap.model.LDAPGetAttributesRequest

public class LDAPGetAttributesRequest
extends LDAPRequest

This class supports the getattributes request to the LDAP Composer service.


Fields inherited from class com.ibm.dse.services.ldap.model.LDAPRequest
COMPID, requestType
 
Constructor Summary
LDAPGetAttributesRequest()
          LDAPGetAttributesRequest constructor.
 
Method Summary
 void addAttributeToReturn(java.lang.String attributeName)
          A utility method used to manage the list of attributes to return.
 java.lang.String[] getReturningAttributes()
          Get the present list of attributes that are desired to be returned.
 void mapFromContext(Context context)
          This method supports externalization of an LDAP getattributes request.
 void removeAttributeToReturn(java.lang.String attributeName)
          A utility method for managing 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.dse.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()
LDAPGetAttributesRequest constructor.
Method Detail

addAttributeToReturn

public void addAttributeToReturn(java.lang.String attributeName)
A utility method used to manage the list of attributes to return. This method adds an object to the list.
Parameters:
attributeName - java.lang.String

getReturningAttributes

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

mapFromContext

public void mapFromContext(Context context)
                    throws DSEException
This method supports externalization of an LDAP getattributes request. It maps external data definitions from a Composer context into the request model.
Overrides:
mapFromContext in class LDAPRequest
Parameters:
context - com.ibm.dse.base.Context
Throws:
DSEException -  

removeAttributeToReturn

public void removeAttributeToReturn(java.lang.String attributeName)
A utility method for managing the list of attributes to return. This 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[]