Package org.openas2

Class BaseComponent

java.lang.Object

org.openas2.BaseComponent

All Implemented Interfaces:

Component

Direct Known Subclasses:

BaseCertificateFactory, BaseCommand, BaseCommandRegistry, BaseLogger, BasePartnershipFactory, BaseProcessor, BaseProcessorModule, DefaultProcessor, EmailSender, SchedulerComponent

public class BaseComponent
extends Object
implements Component

Constructor Summary

Constructors

Constructor	Description
BaseComponent()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Component lifecycle hook.
String	getName()	Returns a name for the component.
String	getParameter(String key, boolean required)
String	getParameter(String key, String defaultValue)
int	getParameterInt(String key, boolean required)
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.
void	setParameter(String key, int value)
void	setParameter(String key, String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseComponent

public BaseComponent()

Method Detail

getName

public String getName()

Description copied from interface: Component

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.

Specified by:

getName in interface Component

Returns:

name of the component

setParameter

public void setParameter(String key,
                         String value)

setParameter

public void setParameter(String key,
                         int value)

getParameter

public String getParameter(String key,
                           boolean required)
                    throws InvalidParameterException

Throws:

InvalidParameterException

getParameter

public String getParameter(String key,
                           String defaultValue)
                    throws InvalidParameterException

Throws:

InvalidParameterException

getParameterInt

public int getParameterInt(String key,
                           boolean required)
                    throws InvalidParameterException

Throws:

InvalidParameterException

getParameters

public Map<String,String> getParameters()

Description copied from interface: Component

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

Specified by:

getParameters in interface Component

Returns:

map of parameter name to parameter value

getSession

public Session getSession()

Description copied from interface: Component

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

Specified by:

getSession in interface Component

Returns:

this component's session

init

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

Description copied from interface: Component

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.

Specified by:

init in interface Component

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

public void destroy()
             throws Exception

Description copied from interface: Component

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

Specified by:

destroy in interface Component

Throws:

Exception - Something went wrong

See Also:

Component.init(Session, Map), Session