de.netseeker.ejoe.adapter
Class CastorAdapter

java.lang.Object
  de.netseeker.ejoe.adapter.BaseAdapter
      de.netseeker.ejoe.adapter.CastorAdapter

All Implemented Interfaces:

SerializeAdapter, java.io.Serializable

public class CastorAdapter
extends BaseAdapter

An adapter for (de)serializing objects via the Castor XML library. This adapter implementation uses the performance hints described in the Castor Marshalling FAQ, that means it does:

• reuse the castor mapping repository
• cache the class desciptors of already marshalled/unmarshalled objects
• disable validation per default

Furthermore it does reuse one Unmarshaller instance.

Author:

netseeker

See Also:

Serialized Form

Constructor Summary

CastorAdapter()
Creates a new instance of this adapter.

CastorAdapter(boolean validate)
Creates a new instance of this adapter.

CastorAdapter(org.exolab.castor.mapping.Mapping mapping)
Creates a new instance of this adapter using the given Castor mapping.

CastorAdapter(java.lang.String pathToMappingFile)
Creates a new instance of this adapter using the Castor mapping loaded from the given mapping file.

CastorAdapter(java.net.URL pathToMappingFile)
Creates a new instance of this adapter using the Castor mapping loaded from the given mapping file.

Method Summary

java.lang.String	getContentType()
void	handleClassLoaderChange(java.lang.ClassLoader classLoader) Signals a change of the ContextClassLoader of the current thread to the adapter.
java.lang.Object	read(java.io.InputStream in) Deserializes an object out of an given InputStream
boolean	requiresCustomEOFHandling() Signals if this adapter has problems with EJOE's UncloseableInputStreams and requires a really closed Stream (which EJOE prevents to ensure that an adapter can not close the underlying socket unintentionally).
void	setValidation(boolean enable) Either enables or disables Castors validation feature.
void	write(java.lang.Object obj, java.io.OutputStream out) Serializes an object into an output stream

Methods inherited from class de.netseeker.ejoe.adapter.BaseAdapter

isSelfBuffered

Methods inherited from class java.lang.Object

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

Constructor Detail

CastorAdapter

public CastorAdapter()

Creates a new instance of this adapter.

CastorAdapter

public CastorAdapter(boolean validate)

Creates a new instance of this adapter. Castor validation is enabled/disabled according to the given value.

Parameters:

validate - either Castor validation should be enabled or not.

CastorAdapter

public CastorAdapter(org.exolab.castor.mapping.Mapping mapping)
              throws org.exolab.castor.mapping.MappingException

Creates a new instance of this adapter using the given Castor mapping.

Parameters:

mapping - existing Castor mapping to use

Throws:

org.exolab.castor.mapping.MappingException

CastorAdapter

public CastorAdapter(java.lang.String pathToMappingFile)
              throws java.io.IOException,
                     org.exolab.castor.mapping.MappingException

Creates a new instance of this adapter using the Castor mapping loaded from the given mapping file.

Parameters:

pathToMappingFile - path of the Castor mapping file to use

Throws:

java.io.IOException

org.exolab.castor.mapping.MappingException

CastorAdapter

public CastorAdapter(java.net.URL pathToMappingFile)
              throws java.io.IOException,
                     org.exolab.castor.mapping.MappingException

Creates a new instance of this adapter using the Castor mapping loaded from the given mapping file.

Parameters:

pathToMappingFile - path of the Castor mapping file to use

Throws:

java.io.IOException

org.exolab.castor.mapping.MappingException

Method Detail

setValidation

public void setValidation(boolean enable)

Either enables or disables Castors validation feature.

Parameters:

enable -

read

public java.lang.Object read(java.io.InputStream in)
                      throws java.lang.Exception

Description copied from interface: SerializeAdapter

Deserializes an object out of an given InputStream

Parameters:

in - the input stream to use for deserialization

Returns:

a deserialized object instance

Throws:

java.lang.Exception

write

public void write(java.lang.Object obj,
                  java.io.OutputStream out)
           throws java.lang.Exception

Description copied from interface: SerializeAdapter

Serializes an object into an output stream

Parameters:

obj - object that should get serialized

out - the outputstream into which the object should serialized

Throws:

java.lang.Exception

handleClassLoaderChange

public void handleClassLoaderChange(java.lang.ClassLoader classLoader)

Description copied from interface: SerializeAdapter

Signals a change of the ContextClassLoader of the current thread to the adapter. This method will be called when the EJOE client is started with support for remote classloading.

Specified by:

handleClassLoaderChange in interface SerializeAdapter

Overrides:

handleClassLoaderChange in class BaseAdapter

requiresCustomEOFHandling

public boolean requiresCustomEOFHandling()

Description copied from interface: SerializeAdapter

Signals if this adapter has problems with EJOE's UncloseableInputStreams and requires a really closed Stream (which EJOE prevents to ensure that an adapter can not close the underlying socket unintentionally). If the adapter requires closed streams, EJOE will append a custom EOF signature at the end of the stream and return -1 in Inputstream#read when EOF is reached.

Specified by:

requiresCustomEOFHandling in interface SerializeAdapter

Overrides:

requiresCustomEOFHandling in class BaseAdapter

Returns:

true if the adapter requires EOF to detect the end of the stream

See Also:

XMLEncoder/Decoder over sockets

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface SerializeAdapter

Overrides:

getContentType in class BaseAdapter

Returns:

A recognized mime type

See Also:

mime type list of IANA