Package org.openas2.params

Class ParameterParser

java.lang.Object

org.openas2.params.ParameterParser

Direct Known Subclasses:

ComponentParameters, CompositeParameters, DateParameters, ExceptionParameters, MessageMDNParameters, MessageParameters, RandomParameters

public abstract class ParameterParser
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ParameterParser()

Method Summary

Modifier and Type	Method	Description
java.lang.String	format(java.lang.String format)	Fill in a format string with information from a ParameterParser
abstract java.lang.String	getParameter(java.lang.String key)
static java.lang.String	parse(java.lang.String format, ParameterParser parser)	Static way (why?) of getting at format method.
protected java.util.List<java.lang.String>	parseKeys(java.lang.String format)
abstract void	setParameter(java.lang.String key, java.lang.String value)
void	setParameters(java.lang.String encodedParams)	Set parameters from a string, like "msg.sender.as2_id=ME,msg.headers.content-type=application/X12"
void	setParameters(java.lang.String format, java.lang.String delimiters, java.lang.String value, boolean mergeExtraTokens)	Set parameters from a string seperated by delimiters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterParser

public ParameterParser()

Method Detail

setParameter

public abstract void setParameter(java.lang.String key,
                                  java.lang.String value)
                           throws InvalidParameterException

Throws:

InvalidParameterException

getParameter

public abstract java.lang.String getParameter(java.lang.String key)
                                       throws InvalidParameterException

Throws:

InvalidParameterException

setParameters

public void setParameters(java.lang.String encodedParams)
                   throws InvalidParameterException

Set parameters from a string, like "msg.sender.as2_id=ME,msg.headers.content-type=application/X12"

Parameters:

encodedParams - string to parse

Throws:

InvalidParameterException - - error in the parameter format string

setParameters

public void setParameters(java.lang.String format,
                          java.lang.String delimiters,
                          java.lang.String value,
                          boolean mergeExtraTokens)
                   throws OpenAS2Exception

Set parameters from a string seperated by delimiters.

Parameters:

format - Comma seperated list of parameters to set, like msg.sender.as2_id,msg.receiver.as2_id,msg.header.content-type

delimiters - delimiters in string to parse, like "-."

value - string to parse, like "NORINCO-WALMART.application/X12"

mergeExtraTokens - if "value" string contains more tokens than the "foprmat" string merge the extra tokens into final token from "format" string

Throws:

OpenAS2Exception - - error in the parameter format string

parse

public static java.lang.String parse(java.lang.String format,
                                     ParameterParser parser)
                              throws InvalidParameterException

Static way (why?) of getting at format method.

Parameters:

format - the format to fill in

parser - the place to get the parsed info

Returns:

the filled in format

Throws:

InvalidParameterException - - error in the parameter format string

format

public java.lang.String format(java.lang.String format)
                        throws InvalidParameterException

Fill in a format string with information from a ParameterParser

Parameters:

format - the format string to fill in

Returns:

the filled in format string.

Throws:

InvalidParameterException - - error in the parameter format string

parseKeys

protected java.util.List<java.lang.String> parseKeys(java.lang.String format)