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

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

public class LDAPCreateRequest
extends LDAPRequest

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


Fields inherited from class com.ibm.dse.services.ldap.model.LDAPRequest
COMPID, requestType
 
Constructor Summary
LDAPCreateRequest()
          LDAPCreateRequest constructor.
 
Method Summary
 void addAttributeToCreate(javax.naming.directory.Attribute attribute)
          A utility method used to control the attribute-to-create list.
 void addAttributeToCreate(java.lang.String key, java.lang.Object value)
          This is functionally equivalent to calling addAttributeToCreate(Attribute), with the attribute object being constructed from the supplied arguments.
 javax.naming.directory.Attributes getAttributes()
          Returns a collection of the attributes to be associated with the newly created directory object.
 void mapFromContext(Context context)
          This method supports externalization of an LDAP create request.
 void removeAttributeToCreate(java.lang.String key)
          A utility method used to control the attribute-to-create list.
 void setAttributes(javax.naming.directory.Attributes newAttributes)
          Set the attributes to be associated with the newly created directory object.
 
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

LDAPCreateRequest

public LDAPCreateRequest()
LDAPCreateRequest constructor.
Method Detail

addAttributeToCreate

public void addAttributeToCreate(java.lang.String key,
                                 java.lang.Object value)
This is functionally equivalent to calling addAttributeToCreate(Attribute), with the attribute object being constructed from the supplied arguments.
Parameters:
key - java.lang.String
value - java.lang.Object

addAttributeToCreate

public void addAttributeToCreate(javax.naming.directory.Attribute attribute)
A utility method used to control the attribute-to-create list. This method adds the specified attribute to this list.
Parameters:
attribute - javax.naming.directory.Attribute

getAttributes

public javax.naming.directory.Attributes getAttributes()
Returns a collection of the attributes to be associated with the newly created directory object.
Returns:
javax.naming.directory.Attributes

mapFromContext

public void mapFromContext(Context context)
                    throws DSEException
This method supports externalization of an LDAP create 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 -  

removeAttributeToCreate

public void removeAttributeToCreate(java.lang.String key)
A utility method used to control the attribute-to-create list. This method removes the attribute with the supplied name from this list.
Parameters:
key - java.lang.String

setAttributes

public void setAttributes(javax.naming.directory.Attributes newAttributes)
Set the attributes to be associated with the newly created directory object.
Parameters:
newAttributes - javax.naming.directory.Attributes