public class GatekeeperMessage extends Object
For more information about the Gatekeeper message format, please see: Gatekeeper Concepts
Modifier and Type | Field | Description |
---|---|---|
static String |
APP_PROPERTY_GATEKEEPER_ERROR_CODE |
The property name for storing error codes a Gatekeeper can return to a client.
|
static String |
DELIM |
All message property names are delimited with a vertical bar (|).
|
static String |
LIST_OBJECTS_IN_BUCKET_FLAG |
A flag name that indicates the Gatekeeper servlet should perform a bucket listing -
for example as used by CockpitLite
|
static String |
PROPERTY_CLIENT_VERSION_ID |
The property name for storing information about a client application such as its version
number.
|
static String |
PROPERTY_PRIOR_FAILURE_MESSAGE |
The property name for storing information about prior failures in the gatekeeper client application.
|
static String |
PROPERTY_TRANSACTION_ID |
The property name for message-specific transaction IDs: transactionId
|
static String |
SUMMARY_DOCUMENT_METADATA_FLAG |
A flag name used to indicate when an S3Object is a summary XML document, as generated
by the Uploader application.
|
Constructor | Description |
---|---|
GatekeeperMessage() |
Constructs a message with no properties.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addApplicationProperties(Map propertiesMap) |
Adds a set of application-specific properties to the message.
|
void |
addApplicationProperty(String propertyName,
String propertyValue) |
Adds an application-specific property to the message.
|
void |
addMessageProperties(Map propertiesMap) |
Adds a set of message-specific properties to the message.
|
void |
addMessageProperty(String propertyName,
String propertyValue) |
Adds a message-specific property to the message.
|
void |
addSignatureRequest(SignatureRequest signatureRequest) |
Adds a Signature Request to the message, indicating a request that a particular
operation be allowed on a particular object.
|
void |
addSignatureRequests(SignatureRequest[] signatureRequests) |
Adds multiple signature requests to the message.
|
static GatekeeperMessage |
decodeFromProperties(Map postProperties) |
Decodes (parses) a Gatekeeper message from the given properties.
|
Properties |
encodeToProperties() |
Encodes a Gatekeeper message as a properties object, with all signature requests identified
with a unique zero-based index number.
|
Properties |
getApplicationProperties() |
|
Properties |
getMessageProperties() |
|
SignatureRequest[] |
getSignatureRequests() |
Returns the signature requests in a message.
|
public static final String DELIM
public static final String PROPERTY_TRANSACTION_ID
public static final String PROPERTY_PRIOR_FAILURE_MESSAGE
public static final String PROPERTY_CLIENT_VERSION_ID
public static final String APP_PROPERTY_GATEKEEPER_ERROR_CODE
public static final String SUMMARY_DOCUMENT_METADATA_FLAG
public static final String LIST_OBJECTS_IN_BUCKET_FLAG
public GatekeeperMessage()
public void addSignatureRequest(SignatureRequest signatureRequest)
signatureRequest
- public void addSignatureRequests(SignatureRequest[] signatureRequests)
signatureRequests
- public SignatureRequest[] getSignatureRequests()
public void addApplicationProperty(String propertyName, String propertyValue)
propertyName
- propertyValue
- public void addApplicationProperties(Map propertiesMap)
propertiesMap
- public Properties getApplicationProperties()
public void addMessageProperty(String propertyName, String propertyValue)
propertyName
- propertyValue
- public void addMessageProperties(Map propertiesMap)
propertiesMap
- public Properties getMessageProperties()
public Properties encodeToProperties()
public static GatekeeperMessage decodeFromProperties(Map postProperties)
postProperties
-