commonj.connector.runtime
Interface BindingContext

All Superinterfaces:
Serializable
All Known Subinterfaces:
DataHandler

public interface BindingContext
extends Serializable

The binding context contains information passed from the runtime to the binding in a Map. For inbound, if both the FunctionSelector and DataBinding implement BindingContext, then the runtime must pass the same instance of BindingContext to each. The minimum set of values passed are:

Binding context entries

Key Value
BINDING_NAME A meaningful name for the binding in terms of the runtime. For example, it may be the fully qualified name of the implementation or an SCA artifact.
BINDING_TYPE Specifies the type of runtime binding being used. Possible values are BINDING_TYPE_EIS, BINDING_TYPE_JMS, or BINDING_TYPE_HTTP. A runtime may define more possible values.
BINDING_COMMUNICATION Specifies the direction of the communication in terms of the application server. Possible values are BINDING_COMMUNICATION_INBOUND or BINDING_COMMUNICATION_OUTBOUND.
EXPECTED_TYPE The QName of the argument type.
BINDING_REGISTRY A handle to the runtime implementation of the Binding registry.
BINDING_CONFIGURATION The JavaBean containing the configured properties for this FunctionSelector, DataBinding, or DataHandler.
INTERACTION_SPEC The passed InteractionSpec.
BINDING_INVOCATION This is used with DataBindings to indicate that it is handling a request, response, or a fault. Possible values are BINDING_INVOCATION_REQUEST, BINDING_INVOCATION_RESPONSE or BINDING_INVOCATION_FAULT

Since:
1.1

Field Summary
static String BINDING_COMMUNICATION
          Key name in the bindingContext describing the communication model.
static String BINDING_COMMUNICATION_INBOUND
          Value for BINDING_COMMUNICATION, specifying the inbound communication model.
static String BINDING_COMMUNICATION_OUTBOUND
          Value for BINDING_COMMUNICATION, specifying the outbound communication model.
static Object BINDING_CONFIGURATION
          Key name in the BindingContext, where the value is the JavaBean containing the configured properties for this FunctionSelector, DataBinding, or DataHandler.
static String BINDING_INVOCATION
          Key name in the BindingContext, specifying whether the DataBinding is being used as a request, response or fault.
static String BINDING_INVOCATION_FAULT
          Value for BINDING_INVOCATION indicating the DataBinding is handling a fault.
static String BINDING_INVOCATION_REQUEST
          Value for BINDING_INVOCATION indicating the DataBinding is handling a request.
static String BINDING_INVOCATION_RESPONSE
          Value for BINDING_INVOCATION indicating the DataBinding is handling a response.
static String BINDING_NAME
          Key name in the bindingContext.
static String BINDING_REGISTRY
          Key name in the bindingContext, where the value is the runtime implementation of the Binding registry.
static String BINDING_TYPE
          Key name in the bindingContext describing the binding type.
static String BINDING_TYPE_EIS
          Value for BINDING_TYPE, specifying the EIS.
static String BINDING_TYPE_HTTP
          Value for BINDING_TYPE, specifying HTTP.
static String BINDING_TYPE_JMS
          Value for BINDING_TYPE, specifying JMS.
static String EXPECTED_TYPE
          Key name in the bindingContext, where the value specifies the QName of the argument type.
static String INTERACTION_SPEC
          Key name in the BindingContext, where the value is the EIS InteractionSpec.
 
Method Summary
 void setBindingContext(Map bindingContext)
          Runtime provides the BindingContext to the DataBinding, DataHandler, or FunctionSelector.
 

Field Detail

BINDING_NAME

static final String BINDING_NAME
Key name in the bindingContext. The value is a QName representing the inbound or outbound component.

See Also:
Constant Field Values

BINDING_TYPE

static final String BINDING_TYPE
Key name in the bindingContext describing the binding type.

See Also:
Constant Field Values

BINDING_TYPE_EIS

static final String BINDING_TYPE_EIS
Value for BINDING_TYPE, specifying the EIS.

See Also:
Constant Field Values

BINDING_TYPE_HTTP

static final String BINDING_TYPE_HTTP
Value for BINDING_TYPE, specifying HTTP.

See Also:
Constant Field Values

BINDING_TYPE_JMS

static final String BINDING_TYPE_JMS
Value for BINDING_TYPE, specifying JMS.

See Also:
Constant Field Values

BINDING_COMMUNICATION

static final String BINDING_COMMUNICATION
Key name in the bindingContext describing the communication model.

See Also:
Constant Field Values

BINDING_COMMUNICATION_INBOUND

static final String BINDING_COMMUNICATION_INBOUND
Value for BINDING_COMMUNICATION, specifying the inbound communication model.

See Also:
Constant Field Values

BINDING_COMMUNICATION_OUTBOUND

static final String BINDING_COMMUNICATION_OUTBOUND
Value for BINDING_COMMUNICATION, specifying the outbound communication model.

See Also:
Constant Field Values

EXPECTED_TYPE

static final String EXPECTED_TYPE
Key name in the bindingContext, where the value specifies the QName of the argument type.

See Also:
Constant Field Values

BINDING_REGISTRY

static final String BINDING_REGISTRY
Key name in the bindingContext, where the value is the runtime implementation of the Binding registry.

See Also:
Constant Field Values

BINDING_CONFIGURATION

static final Object BINDING_CONFIGURATION
Key name in the BindingContext, where the value is the JavaBean containing the configured properties for this FunctionSelector, DataBinding, or DataHandler.


INTERACTION_SPEC

static final String INTERACTION_SPEC
Key name in the BindingContext, where the value is the EIS InteractionSpec.

See Also:
Constant Field Values

BINDING_INVOCATION

static final String BINDING_INVOCATION
Key name in the BindingContext, specifying whether the DataBinding is being used as a request, response or fault.

See Also:
Constant Field Values

BINDING_INVOCATION_REQUEST

static final String BINDING_INVOCATION_REQUEST
Value for BINDING_INVOCATION indicating the DataBinding is handling a request.

See Also:
Constant Field Values

BINDING_INVOCATION_RESPONSE

static final String BINDING_INVOCATION_RESPONSE
Value for BINDING_INVOCATION indicating the DataBinding is handling a response.

See Also:
Constant Field Values

BINDING_INVOCATION_FAULT

static final String BINDING_INVOCATION_FAULT
Value for BINDING_INVOCATION indicating the DataBinding is handling a fault.

See Also:
Constant Field Values
Method Detail

setBindingContext

void setBindingContext(Map bindingContext)
Runtime provides the BindingContext to the DataBinding, DataHandler, or FunctionSelector.

Parameters:
bindingContext - is a map containing context information for the DataBinding, DataHandler, or FunctionSelector.