org.apache.sling.distribution.serialization

Interface DistributionContentSerializer

@ConsumerType
public interface DistributionContentSerializer

A content serializer used to convert distribution payloads to and from binary streams.

Method Summary

Modifier and Type	Method and Description
void	exportToStream(ResourceResolver resourceResolver, DistributionExportOptions exportOptions, java.io.OutputStream outputStream) extracts the resources identified by the given request into the given outputStream
java.lang.String	getName() retrieve the name of this content serializer
void	importFromStream(ResourceResolver resourceResolver, java.io.InputStream inputStream) imports the given stream
boolean	isRequestFiltering() whether or not this DistributionContentSerializer can build package filters for including / excluding certain resources / attributes directly from a DistributionRequest

Method Detail

exportToStream

void exportToStream(ResourceResolver resourceResolver,
                    DistributionExportOptions exportOptions,
                    java.io.OutputStream outputStream)
             throws DistributionException

extracts the resources identified by the given request into the given outputStream

Parameters:

resourceResolver - the resource resolver used to access resources to export

exportOptions - export options

outputStream - the output stream

Throws:

DistributionException - if extraction fails for some reason

importFromStream

void importFromStream(ResourceResolver resourceResolver,
                      java.io.InputStream inputStream)
               throws DistributionException

imports the given stream

Parameters:

resourceResolver - the resource resolver used to write resources

inputStream - the stream to import

Throws:

DistributionException - if importing fails for some reason

getName

java.lang.String getName()

retrieve the name of this content serializer

Returns:

the name of this content serializer

isRequestFiltering

boolean isRequestFiltering()

whether or not this DistributionContentSerializer can build package filters for including / excluding certain resources / attributes directly from a DistributionRequest

Returns:

true if it can build filters from a request, false otherwise