Package org.openas2

Class BaseSession

java.lang.Object

org.openas2.BaseSession

All Implemented Interfaces:

Session

Direct Known Subclasses:

XMLSession

public abstract class BaseSession
extends java.lang.Object
implements Session

Field Summary

Fields inherited from interface org.openas2.Session

DEFAULT_CONTENT_TRANSFER_ENCODING, LOG_LEVEL_OVERRIDE_KEY

Constructor Summary

Constructors

Constructor	Description
BaseSession()	Creates a BaseSession object, then calls the init() method.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBaseDirectory()
CertificateFactory	getCertificateFactory()	Short-cut method to retrieve a certificate factory.
Component	getComponent(java.lang.String componentID)	Gets the Component currently registered with an ID
java.util.Map<java.lang.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.
protected void	init()	This method is called by the BaseSession constructor to set up any global configuration settings.
void	setComponent(java.lang.String componentID, Component comp)	Registers a component to a specified ID.
void	start()	Lifecycle control method.
void	stop()	Lifecycle control method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openas2.Session

getAppTitle, getAppVersion

Constructor Detail

BaseSession

public BaseSession()
            throws OpenAS2Exception

Creates a BaseSession object, then calls the init() method.

Throws:

OpenAS2Exception - - - Houston we have a problem

See Also:

init()

Method Detail

start

public void start()
           throws OpenAS2Exception

Description copied from interface: Session

Lifecycle control method.

Specified by:

start in interface Session

Throws:

OpenAS2Exception

stop

public void stop()
          throws java.lang.Exception

Description copied from interface: Session

Lifecycle control method.

Specified by:

stop in interface Session

Throws:

java.lang.Exception - - - Houston we have a problem

getCertificateFactory

public CertificateFactory getCertificateFactory()
                                         throws ComponentNotFoundException

Description copied from interface: Session

Short-cut method to retrieve a certificate factory.

Specified by:

getCertificateFactory in interface Session

Returns:

the currently registered CertificateFactory component

Throws:

ComponentNotFoundException - If a CertificateFactory component has not been registered

See Also:

CertificateFactory, Component

setComponent

public void setComponent(java.lang.String componentID,
                         Component comp)

Registers a component to a specified ID.

Parameters:

componentID - registers the component to this ID

comp - component to register

See Also:

Component

getComponent

public Component getComponent(java.lang.String componentID)
                       throws ComponentNotFoundException

Description copied from interface: Session

Gets the Component currently registered with an ID

Specified by:

getComponent in interface Session

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

public java.util.Map<java.lang.String,Component> getComponents()

Description copied from interface: Session

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

Specified by:

getComponents in interface Session

Returns:

all registered components, mapped by ID

getPartnershipFactory

public PartnershipFactory getPartnershipFactory()
                                         throws ComponentNotFoundException

Description copied from interface: Session

Short-cut method to retrieve a partner factory.

Specified by:

getPartnershipFactory in interface Session

Returns:

the currently registered PartnerFactory component

Throws:

ComponentNotFoundException - If a PartnerFactory component has not been registered

See Also:

PartnershipFactory, Component

getProcessor

public Processor getProcessor()
                       throws ComponentNotFoundException

Description copied from interface: Session

Short-cut method to retrieve a processor.

Specified by:

getProcessor in interface Session

Returns:

the currently registered Processor component

Throws:

ComponentNotFoundException - If a Processor component has not been registered

See Also:

Processor, Component

init

protected void init()
             throws OpenAS2Exception

This method is called by the BaseSession constructor to set up any global configuration settings.

Throws:

OpenAS2Exception - If an error occurs while initializing systems

getBaseDirectory

public java.lang.String getBaseDirectory()

Specified by:

getBaseDirectory in interface Session