Package org.apache.sling.distribution
Interface DistributionResponse
- 
@ProviderType public interface DistributionResponse
ADistributionResponserepresents the outcome of aDistributionRequestas handled by a certain distribution agent. Such a response will include thestateof therequestand optionally a message for more verbose information about the outcome of the request and additionalproperties. 
- 
- 
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DistributionResponseInfogetDistributionInfo()returns additional properties related to theDistributionRequestjava.lang.StringgetMessage()returns a verbose message of the responseDistributionRequestStategetState()returns the state of the associatedDistributionRequestbooleanisSuccessful()returns the status of the request, whether it is successful or not. 
 - 
 
- 
- 
Method Detail
- 
isSuccessful
boolean isSuccessful()
returns the status of the request, whether it is successful or not. A successful request it is not necessarily distributed, it is just successfully received by the agent. To check the exact state of the request one can retrieve it withgetState- Returns:
 trueif request has been accepted by the agent.
 
- 
getState
@Nonnull DistributionRequestState getState()
returns the state of the associatedDistributionRequest- Returns:
 - the state of the associated request
 
 
- 
getMessage
@Nullable java.lang.String getMessage()
returns a verbose message of the response- Returns:
 - a message associated with this response holding information about e.g. why distribution execution failed, etc.
 
 
- 
getDistributionInfo
@Nonnull DistributionResponseInfo getDistributionInfo()
returns additional properties related to theDistributionRequest- Returns:
 - additional properties
 
 
 - 
 
 -