org.apache.sling.distribution.transport.impl

Interface DistributionTransport

All Known Implementing Classes:

SimpleHttpDistributionTransport

public interface DistributionTransport

A transport layer implementation to transport data between two (or eventually more) Sling instances.

Each implementation is meant to be stateful in the sense that it will hide the details about the sending / receiving endpoints of the transport.

Method Summary

Modifier and Type	Method and Description
void	deliverPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull DistributionPackage distributionPackage, @NotNull DistributionTransportContext context) Deliver a DistributionPackage to a target instance using this transport layer implementation.
@Nullable RemoteDistributionPackage	retrievePackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull org.apache.sling.distribution.DistributionRequest request, @NotNull DistributionTransportContext context) Retrieve DistributionPackages from a target Sling instance, which will create them according to DistributionRequest.

Method Detail

deliverPackage

void deliverPackage(@NotNull
                    @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                    @NotNull
                    @NotNull DistributionPackage distributionPackage,
                    @NotNull
                    @NotNull DistributionTransportContext context)
             throws DistributionException

Deliver a DistributionPackage to a target instance using this transport layer implementation.

Parameters:

resourceResolver - a resolver used to eventually access local resources needed by the transport algorithm

distributionPackage - a DistributionPackage to transport

Throws:

DistributionException - if the DistributionPackage fails to be delivered to the target instance (e.g. because of network, I/O issues)

retrievePackage

@Nullable
@Nullable RemoteDistributionPackage retrievePackage(@NotNull
                                                              @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                              @NotNull
                                                              @NotNull org.apache.sling.distribution.DistributionRequest request,
                                                              @NotNull
                                                              @NotNull DistributionTransportContext context)
                                                       throws DistributionException

Retrieve DistributionPackages from a target Sling instance, which will create them according to DistributionRequest.

Parameters:

resourceResolver - a resolver used to eventually access local resources needed by the transport algorithm

request - a DistributionRequest to be forwarded to the target instance

Returns:

an Iterable of DistributionPackages fetched from the target instance.

Throws:

DistributionException - if the DistributionPackages fail to be retrieved from the target instance