|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jets3t.service.utils.gatekeeper.GatekeeperMessage
public class GatekeeperMessage
Represents a set of properties that will be sent to or received from a Gatekeeper service as a message document. This class includes utility methods to generate and parse plain text encodings of messages.
For more information about the Gatekeeper message format, please see: Gatekeeper Concepts
Field Summary | |
---|---|
static java.lang.String |
APP_PROPERTY_GATEKEEPER_ERROR_CODE
The property name for storing error codes a Gatekeeper can return to a client. |
static java.lang.String |
DELIM
All message property names are delimited with a vertical bar (|). |
static java.lang.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 java.lang.String |
PROPERTY_CLIENT_VERSION_ID
The property name for storing information about a client application such as its version number. |
static java.lang.String |
PROPERTY_PRIOR_FAILURE_MESSAGE
The property name for storing information about prior failures in the gatekeeper client application. |
static java.lang.String |
PROPERTY_TRANSACTION_ID
The property name for message-specific transaction IDs: transactionId |
static java.lang.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 Summary | |
---|---|
GatekeeperMessage()
Constructs a message with no properties. |
Method Summary | |
---|---|
void |
addApplicationProperties(java.util.Map propertiesMap)
Adds a set of application-specific properties to the message. |
void |
addApplicationProperty(java.lang.String propertyName,
java.lang.String propertyValue)
Adds an application-specific property to the message. |
void |
addMessageProperties(java.util.Map propertiesMap)
Adds a set of message-specific properties to the message. |
void |
addMessageProperty(java.lang.String propertyName,
java.lang.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(java.util.Map postProperties)
Decodes (parses) a Gatekeeper message from the given properties. |
java.util.Properties |
encodeToProperties()
Encodes a Gatekeeper message as a properties object, with all signature requests identified with a unique zero-based index number. |
java.util.Properties |
getApplicationProperties()
|
java.util.Properties |
getMessageProperties()
|
SignatureRequest[] |
getSignatureRequests()
Returns the signature requests in a message. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DELIM
public static final java.lang.String PROPERTY_TRANSACTION_ID
public static final java.lang.String PROPERTY_PRIOR_FAILURE_MESSAGE
public static final java.lang.String PROPERTY_CLIENT_VERSION_ID
public static final java.lang.String APP_PROPERTY_GATEKEEPER_ERROR_CODE
public static final java.lang.String SUMMARY_DOCUMENT_METADATA_FLAG
public static final java.lang.String LIST_OBJECTS_IN_BUCKET_FLAG
Constructor Detail |
---|
public GatekeeperMessage()
Method Detail |
---|
public void addSignatureRequest(SignatureRequest signatureRequest)
signatureRequest
- public void addSignatureRequests(SignatureRequest[] signatureRequests)
signatureRequests
- public SignatureRequest[] getSignatureRequests()
public void addApplicationProperty(java.lang.String propertyName, java.lang.String propertyValue)
propertyName
- propertyValue
- public void addApplicationProperties(java.util.Map propertiesMap)
propertiesMap
- public java.util.Properties getApplicationProperties()
public void addMessageProperty(java.lang.String propertyName, java.lang.String propertyValue)
propertyName
- propertyValue
- public void addMessageProperties(java.util.Map propertiesMap)
propertiesMap
- public java.util.Properties getMessageProperties()
public java.util.Properties encodeToProperties()
public static GatekeeperMessage decodeFromProperties(java.util.Map postProperties)
postProperties
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |