Package org.openas2.processor.storage

Class BaseStorageModule

java.lang.Object

org.openas2.BaseComponent

org.openas2.processor.BaseProcessorModule

org.openas2.processor.storage.BaseStorageModule

All Implemented Interfaces:

Component, ProcessorModule, StorageModule

Direct Known Subclasses:

MDNFileModule, MessageFileModule

public abstract class BaseStorageModule
extends BaseProcessorModule
implements StorageModule

Field Summary

Fields

Modifier and Type	Field	Description
static String	PARAM_FILENAME
static String	PARAM_PROTOCOL
static String	PARAM_TEMPDIR

Fields inherited from interface org.openas2.processor.storage.StorageModule

DO_STORE, DO_STOREMDN

Constructor Summary

Constructors

Constructor	Description
BaseStorageModule()

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String action, Message msg, Map<Object,Object> options)
protected File	getFile(Message msg, String fileParam)	Add one more method "getFile" to make no impact to all modules who call this method with only two parameter "Message msg" & "String fileParam"
protected File	getFile(Message msg, String fileParam, String action)	Extracts name of the file from the file parameter and returns a File object with the file name
protected abstract String	getFilename(Message msg, String fileParam, String action)
protected abstract String	getModuleAction()
void	init(Session session, Map<String,String> options)	Component lifecycle hook.
protected void	store(File msgFile, InputStream in)
protected void	writeStream(InputStream in, File destination)

Methods inherited from class org.openas2.BaseComponent

destroy, getName, getParameter, getParameter, getParameterInt, getParameters, getSession, setParameter, setParameter

Methods inherited from interface org.openas2.Component

destroy, getName, getParameters, getSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openas2.processor.ProcessorModule

handle

Field Detail

PARAM_FILENAME

public static final String PARAM_FILENAME

See Also:

Constant Field Values

PARAM_PROTOCOL

public static final String PARAM_PROTOCOL

See Also:

Constant Field Values

PARAM_TEMPDIR

public static final String PARAM_TEMPDIR

See Also:

Constant Field Values

Constructor Detail

BaseStorageModule

public BaseStorageModule()

Method Detail

canHandle

public boolean canHandle(String action,
                         Message msg,
                         Map<Object,Object> options)

Specified by:

canHandle in interface ProcessorModule

init

public void init(Session session,
                 Map<String,String> options)
          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

Overrides:

init in class BaseComponent

Parameters:

session - the component uses this object to access other components

options - configuration values for the component

Throws:

OpenAS2Exception - If an error occurs while initializing the component

See Also:

Session

getModuleAction

protected abstract String getModuleAction()

getFile

protected File getFile(Message msg,
                       String fileParam)
                throws IOException,
                       OpenAS2Exception

Add one more method "getFile" to make no impact to all modules who call this method with only two parameter "Message msg" & "String fileParam"

Parameters:

msg - the context object

fileParam - Name of the file

Returns:

a File object

Throws:

IOException - - IO system has a problem

OpenAS2Exception - - internally handled error condition occurred

getFile

protected File getFile(Message msg,
                       String fileParam,
                       String action)
                throws IOException,
                       OpenAS2Exception

Extracts name of the file from the file parameter and returns a File object with the file name

Parameters:

msg - the context object

fileParam - The parameter containing the format string for the file name

action - what to do

Returns:

a File object

Throws:

IOException - - IO system has a problem

OpenAS2Exception - - internally handled error condition occurred

getFilename

protected abstract String getFilename(Message msg,
                                      String fileParam,
                                      String action)
                               throws InvalidParameterException

Throws:

InvalidParameterException

store

protected void store(File msgFile,
                     InputStream in)
              throws IOException,
                     OpenAS2Exception

Throws:

IOException

OpenAS2Exception

writeStream

protected void writeStream(InputStream in,
                           File destination)
                    throws IOException

Throws:

IOException