com.ibm.dse.services.ldap
Class LDAPResponseFormat

java.lang.Object
  |
  +--com.ibm.dse.base.FormatElement
        |
        +--com.ibm.dse.services.ldap.LDAPResponseFormat

public class LDAPResponseFormat
extends FormatElement

This class provides externalization support for the LDAP Access service. It extends from FormatElement and provides support for transferring data returned in response to an LDAP request, from the response models into client contexes. Unlike regular Composer format elements, this class does not utilize the format(Context) method.

See Also:
Serialized Form

Fields inherited from class com.ibm.dse.base.FormatElement
dataElementName, name
 
Constructor Summary
LDAPResponseFormat()
          LDAPResponseFormat constructor.
 
Method Summary
 java.lang.String format(DataElement element)
          Format abstract class.
 MapFormat getDataMap()
          Returns the data mapping defined for this format element (in support if externalization).
 java.lang.String getName()
          Returns the name of this format element.
 java.lang.String getResponseType()
          Returns the response type for this format.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes this format elements state from externalized data.
 void setDataMap(MapFormat newDataMap)
          Sets the data mappings used by this format element (in support of externalization).
 void setName(java.lang.String newName)
          Sets the names of this format element.
 void setResponseType(java.lang.String newResponseType)
          Sets the response type of this format element.
 Vector toStrings()
          Returns a vector containing the string representation of the SGML tags used to externalize this object.
 void unformat(Context context, LDAPResponse response)
          Transfers data stored in the supplied response model object into the supplied context, according to the data mappings defined for this format element.
 void unformat(Operation operation, LDAPResponse response)
          Functionally equivalent to unformat(operation.getContext, response).
 DataElement unformat(java.lang.String str, DataElement element)
          Unformat abstract method.
 
Methods inherited from class com.ibm.dse.base.FormatElement
exceptionInfo, externalizer, extract, format, format, getDataElementName, getExternalizer, getTagName, isCacheable, isConstant, readExternal, readExternal, readObject, reinitialize, removeExternal, rootDecorated, setDataElementName, setExternalizer, setSize, toString, toTags, unformat, unformat, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LDAPResponseFormat

public LDAPResponseFormat()
LDAPResponseFormat constructor.
Method Detail

format

public java.lang.String format(DataElement element)
Description copied from class: FormatElement
Format abstract class.
Overrides:
format in class FormatElement
Tags copied from class: FormatElement
Parameters:
aDataElement - DataElement
Returns:
String

getDataMap

public MapFormat getDataMap()
Returns the data mapping defined for this format element (in support if externalization).
Returns:
com.ibm.dse.services.ldap.Map

getName

public java.lang.String getName()
Returns the name of this format element.
Overrides:
getName in class FormatElement
Returns:
java.lang.String

getResponseType

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

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
Initializes this format elements state from externalized data.
Overrides:
initializeFrom in class FormatElement
Parameters:
aTag - com.ibm.dse.base.Tag
Returns:
java.lang.Object
Throws:
java.io.IOException -  
DSEException -  

setDataMap

public void setDataMap(MapFormat newDataMap)
Sets the data mappings used by this format element (in support of externalization).
Parameters:
newDataMap - com.ibm.dse.services.ldap.Map

setName

public void setName(java.lang.String newName)
Sets the names of this format element.
Overrides:
setName in class FormatElement
Parameters:
newName - java.lang.String

setResponseType

public void setResponseType(java.lang.String newResponseType)
Sets the response type of this format element.
Parameters:
newResponseType - java.lang.String

toStrings

public Vector toStrings()
Returns a vector containing the string representation of the SGML tags used to externalize this object.
Overrides:
toStrings in class FormatElement
Returns:
com.ibm.dse.base.Vector

unformat

public void unformat(Context context,
                     LDAPResponse response)
              throws DSEInvalidRequestException,
                     DSEInvalidArgumentException
Transfers data stored in the supplied response model object into the supplied context, according to the data mappings defined for this format element.
Parameters:
context - com.ibm.dse.base.Context
response - com.ibm.dse.services.ldap.model.LDAPResponse
Throws:
DSEInvalidRequestException -  
DSEInvalidArgumentException -  

unformat

public void unformat(Operation operation,
                     LDAPResponse response)
              throws DSEInvalidRequestException,
                     DSEInvalidArgumentException
Functionally equivalent to unformat(operation.getContext, response).
Parameters:
operation - com.ibm.dse.base.Operation
response - com.ibm.dse.services.ldap.model.LDAPResponse
Throws:
DSEInvalidRequestException -  
DSEInvalidArgumentException -  

unformat

public DataElement unformat(java.lang.String str,
                            DataElement element)
Description copied from class: FormatElement
Unformat abstract method. To be implemented by the subclasses.
Overrides:
unformat in class FormatElement