org.fcrepo.serialization

Class JcrXmlSerializer

java.lang.Object

org.fcrepo.serialization.BaseFedoraObjectSerializer

org.fcrepo.serialization.JcrXmlSerializer

All Implemented Interfaces:

FedoraObjectSerializer

@Component
public class JcrXmlSerializer
extends BaseFedoraObjectSerializer

Serialize a FedoraObject using the modeshape-provided JCR/XML format

Author:

cbeer

Field Summary

Fields inherited from class org.fcrepo.serialization.BaseFedoraObjectSerializer

repo

Fields inherited from interface org.fcrepo.serialization.FedoraObjectSerializer

JCR_XML

Constructor Summary

Constructors

Constructor and Description
JcrXmlSerializer()

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JcrXmlSerializer

public JcrXmlSerializer()

Method Detail

getKey

public String getKey()

Description copied from interface: FedoraObjectSerializer

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

Returns:

serializer key

getMediaType

public String getMediaType()

Description copied from interface: FedoraObjectSerializer

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

Returns:

serializer output media type

canSerialize

public boolean canSerialize(FedoraResource resource)

Description copied from interface: FedoraObjectSerializer

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 FedoraObjectSerializer.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

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

Description copied from interface: FedoraObjectSerializer

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

Specified by:

serialize in interface FedoraObjectSerializer

Specified by:

serialize in class BaseFedoraObjectSerializer

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

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

Description copied from interface: FedoraObjectSerializer

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

Specified by:

deserialize in interface FedoraObjectSerializer

Specified by:

deserialize in class BaseFedoraObjectSerializer

Parameters:

session - the session

path - the path

stream - the stream

Throws:

javax.jcr.RepositoryException - if repository exception occurred

IOException - if IO exception occurred

InvalidSerializationFormatException - if invadlid serialization occurred