org.fcrepo.serialization

Interface FedoraObjectSerializer

All Known Implementing Classes:

BaseFedoraObjectSerializer, JcrXmlSerializer

@Component
public interface FedoraObjectSerializer

Interface for serializing/deserializing a FedoraObject to some transportable format

Author:

cbeer

Method Summary

Methods

Modifier and Type	Method and Description
void	deserialize(javax.jcr.Session session, String path, InputStream stream) Read the given InputStream and de-serialize the content into new nodes in the given session using the given path as the parent node
String	getKey() Get the key for the serializer (that will be used at the REST API to identify the format)
String	getMediaType() Get the media type for the serialized output (so we can send the right mime type as appropriate)
void	serialize(org.fcrepo.kernel.FedoraObject obj, OutputStream out) Serialize a FedoraObject into some format, and write it to the given OutputStream

Method Detail

getKey

String getKey()

Get the key for the serializer (that will be used at the REST API to identify the format)

Returns:

serializer key

getMediaType

String getMediaType()

Get the media type for the serialized output (so we can send the right mime type as appropriate)

Returns:

serializer output media type

serialize

void serialize(org.fcrepo.kernel.FedoraObject obj,
             OutputStream out)
               throws javax.jcr.RepositoryException,
                      IOException

Serialize a FedoraObject into some format, and write it to the given OutputStream

Parameters:

obj -

out -

Throws:

javax.jcr.RepositoryException

IOException

deserialize

void deserialize(javax.jcr.Session session,
               String path,
               InputStream stream)
                 throws IOException,
                        javax.jcr.RepositoryException,
                        org.fcrepo.kernel.exception.InvalidChecksumException

Read the given InputStream and de-serialize the content into new nodes in the given session using the given path as the parent node

Parameters:

session -

path -

stream -

Throws:

IOException

javax.jcr.RepositoryException

org.fcrepo.kernel.exception.InvalidChecksumException