org.openas2

Interface Session

All Known Implementing Classes:

BaseSession, XMLSession

public interface Session

The Session interface provides configuration and resource information, and a means for components to access the functionality of other components. The Session has its own lifecycle controlled by two methods start() and stop().

Author:

Aaron Silinskas

See Also:

Component, CertificateFactory, PartnershipFactory, Processor

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTENT_TRANSFER_ENCODING
static String	LOG_LEVEL_OVERRIDE_KEY

Method Summary

Modifier and Type	Method and Description
String	getAppTitle()
String	getAppVersion()
String	getBaseDirectory()
CertificateFactory	getCertificateFactory() Short-cut method to retrieve a certificate factory.
Component	getComponent(String componentID) Gets the Component currently registered with an ID
Map<String,Component>	getComponents() Return a map of component ID's to Component objects.
PartnershipFactory	getPartnershipFactory() Short-cut method to retrieve a partner factory.
Processor	getProcessor() Short-cut method to retrieve a processor.
void	start() Lifecycle control method.
void	stop() Lifecycle control method.

Field Detail

DEFAULT_CONTENT_TRANSFER_ENCODING

static final String DEFAULT_CONTENT_TRANSFER_ENCODING

See Also:

Constant Field Values

LOG_LEVEL_OVERRIDE_KEY

static final String LOG_LEVEL_OVERRIDE_KEY

See Also:

Constant Field Values

Method Detail

start

void start()
    throws Exception

Lifecycle control method.

Throws:

Exception - - - Houston we have a problem

stop

void stop()
   throws Exception

Lifecycle control method.

Throws:

Exception - - - Houston we have a problem

getCertificateFactory

CertificateFactory getCertificateFactory()
                                  throws ComponentNotFoundException

Short-cut method to retrieve a certificate factory.

Returns:

the currently registered CertificateFactory component

Throws:

ComponentNotFoundException - If a CertificateFactory component has not been registered

See Also:

CertificateFactory, Component

getComponent

Component getComponent(String componentID)
                throws ComponentNotFoundException

Gets the Component currently registered with an ID

Parameters:

componentID - ID to search for

Returns:

the component registered to the ID or null

Throws:

ComponentNotFoundException - If a component is not registered with the ID

getComponents

Map<String,Component> getComponents()

Return a map of component ID's to Component objects.

Returns:

all registered components, mapped by ID

getPartnershipFactory

PartnershipFactory getPartnershipFactory()
                                  throws ComponentNotFoundException

Short-cut method to retrieve a partner factory.

Returns:

the currently registered PartnerFactory component

Throws:

ComponentNotFoundException - If a PartnerFactory component has not been registered

See Also:

PartnershipFactory, Component

getProcessor

Processor getProcessor()
                throws ComponentNotFoundException

Short-cut method to retrieve a processor.

Returns:

the currently registered Processor component

Throws:

ComponentNotFoundException - If a Processor component has not been registered

See Also:

Processor, Component

getBaseDirectory

String getBaseDirectory()

getAppVersion

String getAppVersion()

getAppTitle

String getAppTitle()