IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

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

java.lang.Object
  extended by com.ibm.btt.services.ldap.model.LDAPResponse
Direct Known Subclasses:
LDAPCreateResponse, LDAPDestroyResponse, LDAPGetAttributesResponse, LDAPListResponse, LDAPLookupResponse, LDAPModifyResponse, LDAPSearchResponse

public abstract class LDAPResponse
extends java.lang.Object

This class provides basic support for wrapping data returned from an LDAP provider, via the LDAP Access Service. Each of the request models for the LDAP Access Service has a corresponding response model, which extends from this class.


Field Summary
protected  java.lang.Object ldapReturnObject
           
protected  java.lang.String responseType
           
 
Constructor Summary
LDAPResponse()
          This constructor creates an LDAPResponse object.
 
Method Summary
protected  void addDataFieldToColl(DataCollection coll, java.lang.String name, java.lang.Object value)
          Creates a DataField object from supplied arguments and adds it to the supplied collection.
 KeyedCollection getKeyedCollection(Context context, java.lang.String name, boolean create)
          Obtains a keyed collection from the supplied context using the supplied name.
 java.lang.Object getLDAPReturnObject()
          Returns the 'native' LDAP object stored in this response model.
 java.lang.String getResponseType()
          Returns the response type for this response model.
 void mapFromLDAPData(java.lang.Object data)
          Stores the data object returned by LDAP.
 void mapToContext(Context context)
          Supports externalization of an LDAP response.
 void setLDAPReturnObject(java.lang.Object object)
          Stores the 'native' object returned by LDAP in this request model, as-is.
 void setResponseType(java.lang.String newResponseType)
          Sets the response type for this response model
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

responseType

protected java.lang.String responseType

ldapReturnObject

protected java.lang.Object ldapReturnObject
Constructor Detail

LDAPResponse

public LDAPResponse()
This constructor creates an LDAPResponse object.

Method Detail

addDataFieldToColl

protected void addDataFieldToColl(DataCollection coll,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws DSEException
Creates a DataField object from supplied arguments and adds it to the supplied collection.

Parameters:
coll - com.ibm.btt.base.DataCollection
name - java.lang.String
value - java.lang.Object
Throws:
DSEException

getKeyedCollection

public KeyedCollection getKeyedCollection(Context context,
                                          java.lang.String name,
                                          boolean create)
Obtains a keyed collection from the supplied context using the supplied name. If no keyed collection exists for the name then one is created if the create flag is true ;

Parameters:
context - com.ibm.btt.base.Context
name - java.lang.String
create - boolean
Returns:
com.ibm.btt.base.KeyedCollection

getLDAPReturnObject

public java.lang.Object getLDAPReturnObject()
Returns the 'native' LDAP object stored in this response model.

Returns:
java.lang.Object

getResponseType

public java.lang.String getResponseType()
Returns the response type for this response model.

Returns:
java.lang.String

mapFromLDAPData

public void mapFromLDAPData(java.lang.Object data)
                     throws DSEException
Stores the data object returned by LDAP. This is the default function.

Parameters:
data - java.lang.Object
Throws:
DSEException

mapToContext

public void mapToContext(Context context)
                  throws DSEException
Supports externalization of an LDAP response. It maps data from this response model into a context.

Parameters:
context - com.ibm.btt.base.Context
Throws:
DSEException

setLDAPReturnObject

public void setLDAPReturnObject(java.lang.Object object)
Stores the 'native' object returned by LDAP in this request model, as-is.

Parameters:
newLdapReturnObject - java.lang.Object

setResponseType

public void setResponseType(java.lang.String newResponseType)
Sets the response type for this response model

Parameters:
newResponseType - java.lang.String

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009