com.ibm.commerce.programadapter
Class ProgramAdapterDesc

java.lang.Object
  |
  +--com.ibm.commerce.adapter.DeviceFormatAdapterDesc
        |
        +--com.ibm.commerce.adapter.HttpAdapterDesc
              |
              +--com.ibm.commerce.programadapter.ProgramAdapterDesc

public class ProgramAdapterDesc
extends HttpAdapterDesc

The Adapter Descriptor for Program Adapter that handle http requests.


Field Summary
static java.lang.String _CONFIGURATION
          Constant for the adapter's configuration.
static java.lang.String _MESSAGE_MAPPERS
          Constant for the adapter's configuration.
protected  java.util.Vector _Message_Mappers_Vector
           
static java.lang.String _PROGRAM_ADAPTER_NODE_NAME
          Constant for the adapter's configuration.
static java.lang.String _SESSION_CONTEXT
          Constant for the adapter's configuration.
protected   ProgramAdapterSessionContext _Session_Context_Class
           
static java.lang.String _SESSION_CONTEXT_CLASS
          Constant for the adapter's configuration.
static java.lang.String _SESSION_CONTEXT_CONFIG
          Constant for the adapter's configuration.
static java.lang.String _STR_Init
          Constant to represent the name of the method for logging purposes.
static java.lang.String _STR_Initialize
          Constant to represent the name of the method for logging purposes.
static java.lang.String _STR_ThisClass
          Constant to represent the name of the class for logging purposes.
static java.lang.String _SUPPORTED_CHARACTER_ENCODING
          Constant for the adapter's configuration.
protected  java.util.Vector _Supported_Character_Encoding_Vector
           
static java.lang.String _SUPPORTED_CONTENT_TYPES
          Constant for the adapter's configuration.
protected  java.util.Vector _Supported_Content_Types_Vector
           
static java.lang.String _SUPPORTED_METHODS
          Constant for the adapter's configuration.
protected  java.util.Vector _Supported_Methods_Vector
           
static java.lang.String _VECTOR_STRING_TOKEN
          Constant for the adapter's configuration.
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
 
Fields inherited from class com.ibm.commerce.adapter. DeviceFormatAdapterDesc
DEVFMT_ENABLED, DEVFMT_FACTORYCLASSNAME, DEVFMT_ID, DEVFMT_NAME, DEVFMT_TYPE, DEVFMT_TYPEID, devfmtClass, devfmtId, devfmtName, devfmtType, devfmtTypeId, isEnabled
 
Constructor Summary
ProgramAdapterDesc()
          Creates the program adapter descriptor.
 
Method Summary
 java.util.Vector getMessageMappers()
          Returns a Vector object containing the supported Message Mappers.
  SessionContext getSessionContext()
          Returns the session context.
 java.util.Vector getSupportedCharacterEncoding()
          Returns a Vector object containing the supported Character Encodings.
 java.util.Vector getSupportedContentTypes()
          Returns a Vector object containing the supported Content-Types.
 java.util.Vector getSupportedMethods()
          Returns a Vector object containing the supported Http Methods.
 void init(org.w3c.dom.Element node)
          Initializes the Adapter Descriptor.
 void initialize(org.w3c.dom.Element adapterNode)
          Provides further initialization setting of the Adapter Descriptor.
 void setSessionContext( ProgramAdapterSessionContext sessionContext)
          Sets the session context of the adapter.
 
Methods inherited from class com.ibm.commerce.adapter. DeviceFormatAdapterDesc
getDeviceFormatClass, getDeviceFormatId, getDeviceFormatName, getDeviceFormatType, getDeviceFormatTypeId, isEnabled, setDeviceFormatClass, setDeviceFormatId, setDeviceFormatName, setDeviceFormatType, setDeviceFormatTypeId, setIsEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values

_PROGRAM_ADAPTER_NODE_NAME

public static final java.lang.String _PROGRAM_ADAPTER_NODE_NAME
Constant for the adapter's configuration.
See Also:
Constant Field Values

_MESSAGE_MAPPERS

public static final java.lang.String _MESSAGE_MAPPERS
Constant for the adapter's configuration.
See Also:
Constant Field Values

_SUPPORTED_METHODS

public static final java.lang.String _SUPPORTED_METHODS
Constant for the adapter's configuration.
See Also:
Constant Field Values

_SUPPORTED_CONTENT_TYPES

public static final java.lang.String _SUPPORTED_CONTENT_TYPES
Constant for the adapter's configuration.
See Also:
Constant Field Values

_SUPPORTED_CHARACTER_ENCODING

public static final java.lang.String _SUPPORTED_CHARACTER_ENCODING
Constant for the adapter's configuration.
See Also:
Constant Field Values

_CONFIGURATION

public static final java.lang.String _CONFIGURATION
Constant for the adapter's configuration.
See Also:
Constant Field Values

_SESSION_CONTEXT

public static final java.lang.String _SESSION_CONTEXT
Constant for the adapter's configuration.
See Also:
Constant Field Values

_SESSION_CONTEXT_CLASS

public static final java.lang.String _SESSION_CONTEXT_CLASS
Constant for the adapter's configuration.
See Also:
Constant Field Values

_SESSION_CONTEXT_CONFIG

public static final java.lang.String _SESSION_CONTEXT_CONFIG
Constant for the adapter's configuration.
See Also:
Constant Field Values

_VECTOR_STRING_TOKEN

public static final java.lang.String _VECTOR_STRING_TOKEN
Constant for the adapter's configuration.
See Also:
Constant Field Values

_Session_Context_Class

protected ProgramAdapterSessionContext _Session_Context_Class

_Message_Mappers_Vector

protected java.util.Vector _Message_Mappers_Vector

_Supported_Content_Types_Vector

protected java.util.Vector _Supported_Content_Types_Vector

_Supported_Character_Encoding_Vector

protected java.util.Vector _Supported_Character_Encoding_Vector

_Supported_Methods_Vector

protected java.util.Vector _Supported_Methods_Vector

_STR_ThisClass

public static final java.lang.String _STR_ThisClass
Constant to represent the name of the class for logging purposes.
See Also:
Constant Field Values

_STR_Init

public static final java.lang.String _STR_Init
Constant to represent the name of the method for logging purposes.
See Also:
Constant Field Values

_STR_Initialize

public static final java.lang.String _STR_Initialize
Constant to represent the name of the method for logging purposes.
See Also:
Constant Field Values
Constructor Detail

ProgramAdapterDesc

public ProgramAdapterDesc()
Creates the program adapter descriptor.
Method Detail

getMessageMappers

public java.util.Vector getMessageMappers()
Returns a Vector object containing the supported Message Mappers.
Returns:
The defined message mappers for the adapter.

getSessionContext

public SessionContext getSessionContext()
Returns the session context.
Returns:
The program adapter's session context.

getSupportedCharacterEncoding

public java.util.Vector getSupportedCharacterEncoding()
Returns a Vector object containing the supported Character Encodings.
Returns:
The supported character encoding.

getSupportedContentTypes

public java.util.Vector getSupportedContentTypes()
Returns a Vector object containing the supported Content-Types.
Returns:
The supported content-types.

getSupportedMethods

public java.util.Vector getSupportedMethods()
Returns a Vector object containing the supported Http Methods.
Returns:
The supported request methods.

init

public void init(org.w3c.dom.Element node)
          throws java.lang.Exception
Initializes the Adapter Descriptor.
Overrides:
init in class DeviceFormatAdapterDesc
Parameters:
node - the XML configuration for the descriptor.
Throws:
java.lang.Exception - if there is a problem initializing the descriptor.

initialize

public void initialize(org.w3c.dom.Element adapterNode)
                throws java.lang.Exception
Provides further initialization setting of the Adapter Descriptor.
java.lang.Exception

setSessionContext

public void setSessionContext(ProgramAdapterSessionContext sessionContext)
Sets the session context of the adapter.
Parameters:
sessionContext - the session context implementation for the program adapter.