|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.FormatElement
com.ibm.btt.services.ldap.LDAPResponseFormat
public class LDAPResponseFormat
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 format elements, this class does not utilize the format(Context) method.
Field Summary |
---|
Fields inherited from class com.ibm.btt.base.FormatElement |
---|
dataElementName |
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 XML 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)
Performs equivalent functions as unformat(operation.getContext, response). |
DataElement |
unformat(java.lang.String str,
DataElement element)
Unformat abstract method. |
Methods inherited from class com.ibm.btt.base.FormatElement |
---|
checkIndexes, exceptionInfo, externalizer, extract, format, getDataElementName, getExternalizer, getTagName, isCacheable, isConstant, isItConstant, isNull, readExternal, readExternal, readObject, reinitialize, removeExternal, rootDecorated, setDataElementName, setExternalizer, setSize, toString, toTags, unformat, unformat, unformat, writeExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LDAPResponseFormat()
Method Detail |
---|
public java.lang.String format(DataElement element)
FormatElement
format
in class FormatElement
element
- DataElement
public MapFormat getDataMap()
public java.lang.String getName()
getName
in interface Cacheable
getName
in class FormatElement
public java.lang.String getResponseType()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
initializeFrom
in class FormatElement
aTag
- com.ibm.btt.base.Tag
java.io.IOException
DSEException
public void setDataMap(MapFormat newDataMap)
newDataMap
- com.ibm.btt.services.ldap.Mappublic void setName(java.lang.String newName)
setName
in class FormatElement
newName
- java.lang.Stringpublic void setResponseType(java.lang.String newResponseType)
newResponseType
- java.lang.Stringpublic Vector toStrings()
toStrings
in class FormatElement
public void unformat(Context context, LDAPResponse response) throws DSEInvalidRequestException, DSEInvalidArgumentException
context
- com.ibm.btt.base.Contextresponse
- com.ibm.btt.services.ldap.model.LDAPResponse
DSEInvalidRequestException
DSEInvalidArgumentException
public void unformat(Operation operation, LDAPResponse response) throws DSEInvalidRequestException, DSEInvalidArgumentException
operation
- com.ibm.btt.base.Operationresponse
- com.ibm.btt.services.ldap.model.LDAPResponse
DSEInvalidRequestException
DSEInvalidArgumentException
public DataElement unformat(java.lang.String str, DataElement element)
FormatElement
unformat
in class FormatElement
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |