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

Field Summary

Fields

Modifier and Type	Field and Description
static String	JCR_XML

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSerialize(FedoraResource resource) Determines whether this FedoraObjectSerializer can be used to serialize the given resource.
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(FedoraResource obj, OutputStream out, boolean skipBinary, boolean recurse) Serialize a FedoraObject into some format with options for recurse and skipBinary, and write it to the given OutputStream

Field Detail

JCR_XML

static final String JCR_XML

See Also:

Constant Field Values

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

canSerialize

boolean canSerialize(FedoraResource resource)

Determines whether this FedoraObjectSerializer can be used to serialize the given resource. A FedoraObjectSerializer implementation may use any arbitrary criteria to determine which resources it can serialize, so this method should be invoked to avoid an InvalidSerializationFormatException from serialize(org.fcrepo.kernel.models.FedoraResource, java.io.OutputStream, boolean, boolean).

Parameters:

resource - the resource

Returns:

whether this can be used to serialize the given resource

serialize

void serialize(FedoraResource obj,
             OutputStream out,
             boolean skipBinary,
             boolean recurse)
               throws javax.jcr.RepositoryException,
                      IOException,
                      InvalidSerializationFormatException

Serialize a FedoraObject into some format with options for recurse and skipBinary, and write it to the given OutputStream

Parameters:

obj - the obj

out - the out

skipBinary - skip binary

recurse - the recurse

Throws:

javax.jcr.RepositoryException - if repository exception occurred

IOException - if IO exception occurred

InvalidSerializationFormatException - if invalid serialization occurred

deserialize

void deserialize(javax.jcr.Session session,
               String path,
               InputStream stream)
                 throws IOException,
                        javax.jcr.RepositoryException,
                        InvalidChecksumException,
                        InvalidSerializationFormatException

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 - the session

path - the path

stream - the stream

Throws:

IOException - if IO exception occurred

javax.jcr.RepositoryException - if repository exception occurred

InvalidChecksumException - if invalid checksum exception occurred

InvalidSerializationFormatException - if invadlid serialization occurred