ProgramAdapterDesc

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

public class ProgramAdapterDesc
extends com.ibm.commerce.adapter.HttpAdapterDesc

The Adapter descriptor for Program Adapter that handles HTTP requests.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`_CONFIGURATION` Constant for the adapter's configuration.
`static java.lang.String`	`_MESSAGE_MAPPERS` Constant for the adapter's configuration.
`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.
`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.
`static java.lang.String`	`_SUPPORTED_CONTENT_TYPES` Constant for the adapter's configuration.
`static java.lang.String`	`_SUPPORTED_METHODS` Constant for the adapter's configuration.
`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

Constructor Summary

Constructors
Constructor and Description

ProgramAdapterDesc()
Creates the program adapter descriptor.

Constructors
Constructor and Description
`ProgramAdapterDesc()` Creates the program adapter descriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Vector`	`getMessageMappers()` Returns a Vector object containing the supported Message Mappers.
`com.ibm.commerce.adapter.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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
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
  - _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 com.ibm.commerce.adapter.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 com.ibm.commerce.adapter.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.
    
    Parameters:
    
    org.w3c.dom.Element - node - the XML configuration for the Descriptor.
    
    Throws:
    
    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.

Fields inherited from class com.ibm.commerce.adapter.DeviceFormatAdapterDesc

Methods inherited from class com.ibm.commerce.adapter.DeviceFormatAdapterDesc

Methods inherited from class java.lang.Object

COPYRIGHT

_PROGRAM_ADAPTER_NODE_NAME

_MESSAGE_MAPPERS

_SUPPORTED_METHODS

_SUPPORTED_CONTENT_TYPES

_SUPPORTED_CHARACTER_ENCODING

_CONFIGURATION

_SESSION_CONTEXT

_SESSION_CONTEXT_CLASS

_SESSION_CONTEXT_CONFIG

_VECTOR_STRING_TOKEN

_STR_ThisClass

_STR_Init

_STR_Initialize

ProgramAdapterDesc

getMessageMappers

getSessionContext

getSupportedCharacterEncoding

getSupportedContentTypes

getSupportedMethods

init

initialize

setSessionContext