Interface DistributionContentSerializer
-
- All Known Implementing Classes:
FileVaultContentSerializer
@ConsumerType public interface DistributionContentSerializerA content serializer used to convert distribution payloads to and from binary streams.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidexportToStream(org.apache.sling.api.resource.ResourceResolver resourceResolver, DistributionExportOptions exportOptions, OutputStream outputStream)extracts the resources identified by the given request into the given outputStreamStringgetName()retrieve the name of this content serializervoidimportFromStream(org.apache.sling.api.resource.ResourceResolver resourceResolver, InputStream inputStream)imports the given streambooleanisRequestFiltering()whether or not thisDistributionContentSerializercan build package filters for including / excluding certain resources / attributes directly from aDistributionRequest
-
-
-
Method Detail
-
exportToStream
void exportToStream(org.apache.sling.api.resource.ResourceResolver resourceResolver, DistributionExportOptions exportOptions, OutputStream outputStream) throws DistributionExceptionextracts the resources identified by the given request into the given outputStream- Parameters:
resourceResolver- the resource resolver used to access resources to exportexportOptions- export optionsoutputStream- the output stream- Throws:
DistributionException- if extraction fails for some reason
-
importFromStream
void importFromStream(org.apache.sling.api.resource.ResourceResolver resourceResolver, InputStream inputStream) throws DistributionExceptionimports the given stream- Parameters:
resourceResolver- the resource resolver used to write resourcesinputStream- the stream to import- Throws:
DistributionException- if importing fails for some reason
-
getName
String getName()
retrieve the name of this content serializer- Returns:
- the name of this content serializer
-
isRequestFiltering
boolean isRequestFiltering()
whether or not thisDistributionContentSerializercan build package filters for including / excluding certain resources / attributes directly from aDistributionRequest- Returns:
trueif it can build filters from a request,falseotherwise
-
-