Package org.openas2
Interface Session
-
- All Known Implementing Classes:
BaseSession
,XMLSession
public interface Session
TheSession
interface provides configuration and resource information, and a means for components to access the functionality of other components. TheSession
has its own lifecycle controlled by two methodsstart()
andstop()
.- See Also:
Component
,CertificateFactory
,PartnershipFactory
,Processor
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_CONTENT_TRANSFER_ENCODING
static java.lang.String
LOG_LEVEL_OVERRIDE_KEY
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAppTitle()
java.lang.String
getAppVersion()
java.lang.String
getBaseDirectory()
CertificateFactory
getCertificateFactory()
Short-cut method to retrieve a certificate factory.Component
getComponent(java.lang.String componentID)
Gets theComponent
currently registered with an IDjava.util.Map<java.lang.String,Component>
getComponents()
Return a map of component ID's toComponent
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 java.lang.String DEFAULT_CONTENT_TRANSFER_ENCODING
- See Also:
- Constant Field Values
-
LOG_LEVEL_OVERRIDE_KEY
static final java.lang.String LOG_LEVEL_OVERRIDE_KEY
- See Also:
- Constant Field Values
-
-
Method Detail
-
start
void start() throws java.lang.Exception
Lifecycle control method.- Throws:
java.lang.Exception
- - - Houston we have a problem
-
stop
void stop() throws java.lang.Exception
Lifecycle control method.- Throws:
java.lang.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 aCertificateFactory
component has not been registered- See Also:
CertificateFactory
,Component
-
getComponent
Component getComponent(java.lang.String componentID) throws ComponentNotFoundException
Gets theComponent
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
java.util.Map<java.lang.String,Component> getComponents()
Return a map of component ID's toComponent
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 aPartnerFactory
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 aProcessor
component has not been registered- See Also:
Processor
,Component
-
getBaseDirectory
java.lang.String getBaseDirectory()
-
getAppVersion
java.lang.String getAppVersion()
-
getAppTitle
java.lang.String getAppTitle()
-
-