com.adaptris.core.varsub

Class XStreamMarshaller

java.lang.Object

com.adaptris.core.AbstractMarshaller

com.adaptris.core.XStreamMarshallerImpl

com.adaptris.core.XStreamMarshaller

com.adaptris.core.varsub.XStreamMarshaller

All Implemented Interfaces:

AdaptrisMarshaller

public class XStreamMarshaller
extends XStreamMarshaller

XStream version of AdaptrisMarshaller that supports variable substitutions when unmarshalling.

If the variable-properties-url is configured as file:///.//path/to/my/variables.properties and that contains

 
 broker.url=tcp://localhost:2506
 broker.backup.url=tcp://my.host:2507
 
 

Then all instances of${broker.url} and ${broker.backup.url} will be replaced as the input is read in, but before the unmarshalling occurs.

In the adapter configuration file this class is aliased as xstream-varsub-marshaller which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.AbstractMarshaller

AbstractMarshaller.Deserializer, AbstractMarshaller.Serializer

Nested classes/interfaces inherited from interface com.adaptris.core.AdaptrisMarshaller

AdaptrisMarshaller.MarshalInputStream, AdaptrisMarshaller.MarshalOutputStream

Field Summary

Fields inherited from class com.adaptris.core.XStreamMarshallerImpl

instance

Constructor Summary

Constructors

Constructor and Description
XStreamMarshaller()

Method Summary

Modifier and Type	Method and Description
void	addVariablePropertiesUrls(java.lang.String url)
VariableSubstitutionType	getSubstitutionType()
java.lang.Boolean	getUseHostname()
java.lang.String	getVariablePostfix()
java.lang.String	getVariablePrefix()
java.util.List<java.lang.String>	getVariablePropertiesUrls()
void	setSubstitutionType(VariableSubstitutionType type) Set the Substitution Type.
void	setUseHostname(java.lang.Boolean b) Whether or not to attempt to format the URL with the hostname.
void	setVariablePostfix(java.lang.String suffix) Set the variable prefix.
void	setVariablePrefix(java.lang.String prefix) Set the variable prefix.
void	setVariablePropertiesUrls(java.util.List<java.lang.String> list) Specify the file where the substitution properties are held.
java.lang.Object	unmarshal(java.io.File file)
java.lang.Object	unmarshal(java.io.InputStream in)
java.lang.Object	unmarshal(java.io.Reader in)
java.lang.Object	unmarshal(java.lang.String input)
java.lang.Object	unmarshal(java.net.URL url)
java.lang.Object	unmarshal(URLString url)
XStreamMarshaller	withUseHostname(java.lang.Boolean b)

Methods inherited from class com.adaptris.core.XStreamMarshaller

getInstance

Methods inherited from class com.adaptris.core.XStreamMarshallerImpl

marshal, marshal

Methods inherited from class com.adaptris.core.AbstractMarshaller

connectToUrl, invokeDeserialize, invokeSerialize, marshal, marshal, marshal, marshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisMarshaller

uncheckedMarshal, uncheckedUnmarshal

Constructor Detail

XStreamMarshaller

public XStreamMarshaller()
                  throws CoreException

Throws:

CoreException

Method Detail

unmarshal

public java.lang.Object unmarshal(java.io.Reader in)
                           throws CoreException

Specified by:

unmarshal in interface AdaptrisMarshaller

Overrides:

unmarshal in class XStreamMarshallerImpl

Throws:

CoreException

unmarshal

public java.lang.Object unmarshal(java.lang.String input)
                           throws CoreException

Specified by:

unmarshal in interface AdaptrisMarshaller

Overrides:

unmarshal in class AbstractMarshaller

Throws:

CoreException

unmarshal

public java.lang.Object unmarshal(java.io.File file)
                           throws CoreException

Specified by:

unmarshal in interface AdaptrisMarshaller

Overrides:

unmarshal in class AbstractMarshaller

Throws:

CoreException

unmarshal

public java.lang.Object unmarshal(java.net.URL url)
                           throws CoreException

Specified by:

unmarshal in interface AdaptrisMarshaller

Overrides:

unmarshal in class AbstractMarshaller

Throws:

CoreException

unmarshal

public java.lang.Object unmarshal(URLString url)
                           throws CoreException

Specified by:

unmarshal in interface AdaptrisMarshaller

Overrides:

unmarshal in class AbstractMarshaller

Throws:

CoreException

unmarshal

public java.lang.Object unmarshal(java.io.InputStream in)
                           throws CoreException

Specified by:

unmarshal in interface AdaptrisMarshaller

Overrides:

unmarshal in class AbstractMarshaller

Throws:

CoreException

getVariablePropertiesUrls

public java.util.List<java.lang.String> getVariablePropertiesUrls()

setVariablePropertiesUrls

public void setVariablePropertiesUrls(java.util.List<java.lang.String> list)

Specify the file where the substitution properties are held.

Parameters:

list - the urls (so it could be remote).

addVariablePropertiesUrls

public void addVariablePropertiesUrls(java.lang.String url)

getVariablePrefix

public java.lang.String getVariablePrefix()

setVariablePrefix

public void setVariablePrefix(java.lang.String prefix)

Set the variable prefix.

Parameters:

prefix - the prefix, defaults to "${"

getVariablePostfix

public java.lang.String getVariablePostfix()

setVariablePostfix

public void setVariablePostfix(java.lang.String suffix)

Set the variable prefix.

Parameters:

suffix - the suffix, defaults to "}"

getSubstitutionType

public VariableSubstitutionType getSubstitutionType()

setSubstitutionType

public void setSubstitutionType(VariableSubstitutionType type)

Set the Substitution Type.

Parameters:

type - the type, if not specified then VariableSubstitutionType.SIMPLE.

getUseHostname

public java.lang.Boolean getUseHostname()

setUseHostname

public void setUseHostname(java.lang.Boolean b)

Whether or not to attempt to format the URL with the hostname.

Parameters:

b -

See Also:

Constants.VARSUB_PROPERTIES_USE_HOSTNAME

withUseHostname

public XStreamMarshaller withUseHostname(java.lang.Boolean b)