Package org.openas2

Interface Component

All Known Subinterfaces:

ActiveModule, AliasedCertificateFactory, CertificateFactory, Command, CommandRegistry, KeyStoreCertificateFactory, Logger, PartnershipFactory, Processor, ProcessorModule, ReceiverModule, ResenderModule, SenderModule, StorableCertificateFactory, StorageModule, TrackingModule

All Known Implementing Classes:

AddPartnerCommand, AddPartnershipCommand, AliasedCertCommand, AliasedLoggingCommand, AliasedPartnershipsCommand, AS2DirectoryPollingModule, AS2FileReceiverModule, AS2MDNReceiverModule, AS2ReceiverModule, AS2SenderModule, BaseActiveModule, BaseCertificateFactory, BaseCommand, BaseCommandProcessor, BaseCommandRegistry, BaseComponent, BaseLogger, BaseMsgTrackingModule, BasePartnershipFactory, BaseProcessor, BaseProcessorModule, BaseReceiverModule, BaseResenderModule, BaseSenderModule, BaseStorageModule, ClearCertsCommand, ConsoleLogger, DbTrackingModule, DefaultProcessor, DeleteCertCommand, DeletePartnerCommand, DeletePartnershipCommand, DirectoryPollingModule, DirectoryResenderModule, EmailLogger, EmailSender, FileLogger, HealthCheckModule, HttpSenderModule, ImportCertCommand, ImportCertInEncodedStreamCommand, ListCertCommand, ListPartnersCommand, ListPartnershipsCommand, MDNFileModule, MDNSenderModule, MessageBuilderModule, MessageFileModule, MultiCommand, NetModule, PKCS12CertificateFactory, PollingModule, RefreshPartnershipsCommand, SchedulerComponent, SentryLogger, SetLogLevelCommand, SocketCommandProcessor, SocketLogger, StorePartnershipsCommand, StreamCommandProcessor, ViewCertCommand, ViewPartnerCommand, ViewPartnershipCommand, XMLCommandRegistry, XMLPartnershipFactory

public interface Component

The Component interface provides a standard way to dynamically create and initialize an object. Component-based objects also have access to a Session, which allow each component to access all components registered to it's Session. Parameters for a component are defined as static strings Note: Any object that implements this interface must have a constructor with no parameters, as these parameters should be passed to the init method.

Author:

Aaron Silinskas

See Also:

BaseComponent, Session

Method Summary

Modifier and Type	Method	Description
void	destroy()	Component lifecycle hook.
String	getName()	Returns a name for the component.
Map<String,String>	getParameters()	Returns the parameters used to initialize this Component, and can also be used to modify parameters.
Session	getSession()	Returns the Session used to initialize this Component.
void	init(Session session, Map<String,String> parameters)	Component lifecycle hook.

Method Detail

getName

String getName()

Returns a name for the component. These names are not guaranteed to be unique, and are intended for display and logging. Generally this is the class name of the Component object, without package information.

Returns:

name of the component

getParameters

Map<String,String> getParameters()

Returns the parameters used to initialize this Component, and can also be used to modify parameters.

Returns:

map of parameter name to parameter value

getSession

Session getSession()

Returns the Session used to initialize this Component. The returned session is also used to locate other components if needed.

Returns:

this component's session

init

void init(Session session,
          Map<String,String> parameters)
   throws OpenAS2Exception

Component lifecycle hook. After creating a Component object, this method should be called to set any parameters used by the component. Component implementations typically have required parameter checking and code to start timers and threads within this method.

Parameters:

session - the component uses this object to access other components

parameters - configuration values for the component

Throws:

OpenAS2Exception - If an error occurs while initializing the component

See Also:

Session

destroy

void destroy()
      throws Exception

Component lifecycle hook. If lifecycle of Component requires a destroy function this method can be used.

Throws:

Exception - Something went wrong

See Also:

init(Session, Map), Session