com.adobe.flashaccess.sdk.protocol
Class AdobeErrorData

java.lang.Object
  com.adobe.flashaccess.sdk.protocol.ErrorData
      com.adobe.flashaccess.sdk.protocol.AdobeErrorData

public class AdobeErrorData
extends ErrorData

Encapsulates common errors that can be encountered while interacting with Adobe Flash Access SDK handlers. Along with the error code, this class provides a plain text user-friendly description of the error code.

Flash Access error messages are locale-specific and are stored within the properties file Adobe_ErrorMsg.properties. Additional locale-specific messages and URLs can also be found following the standard Java ResourceBundle naming conventions. If it is desired to support locales not immediately supported by Adobe Flash Access, additional .properties files should be created using the existing files as templates in order to support the new locale. (The Flash Access 2.0 client does not provide this error text to the client application.)

Field Summary

static java.lang.String	ADOBE_NAMESPACE The namespace used for Adobe-defined errors.
static AdobeErrorData	AUTH_FAILED (202) Authentication is denied (for example, the credentials provided in the request are not valid).
static AdobeErrorData	AUTH_UNSUPPORTED_TYPE (201) The request specified an authentication method which is not supported.
static AdobeErrorData	LACQ_AUTHENTICATION_REQUIRED (306) A license cannot be issued, because the user has not been authenticated.
static AdobeErrorData	LACQ_CONTENT_METADATA_INVALID (302) Invalid metadata was provided (for example, the signature is invalid or cannot be parsed).
static AdobeErrorData	LACQ_CONTENT_POLICY_EXPIRED (303) A license cannot be issued, because the policy's end date has been reached.
static AdobeErrorData	LACQ_CONTENT_POLICY_NOT_YET_VALID (312) A license cannot be issued, because the policy's start date has not been reached.
static AdobeErrorData	LACQ_CONTENT_POLICY_REVOKED (304) A license cannot be issued, because the policy has been revoked.
static AdobeErrorData	LACQ_TAMPERING_DETECTED (307) A license cannot be issued, because tampering on the client was detected.
static AdobeErrorData	LACQ_UNSUPPORTED_PHASE (301) The request specified an license acquisition phase which is not supported.
static AdobeErrorData	LACQ_USER_NOT_AUTHORIZED (305) A license cannot be issued, because the user is not authorized to view the content.
static AdobeErrorData	REQ_AUTH_TOKEN_INVALID_EXPIRED (110) The authentication token is not valid or is expired.
static AdobeErrorData	REQ_CANNOT_DECRYPT (101) The request cannot be decrypted.
static AdobeErrorData	REQ_CANNOT_PARSE (103) The request cannot be parsed (format invalid, required data missing, etc.)
static AdobeErrorData	REQ_CLIENT_TIME_OUT_OF_RANGE (108) The difference between the server's time and the client's time exceeds the configured tolerance.
static AdobeErrorData	REQ_DRM_CREDENTIAL_NEEDS_UPGRADE (112) The DRM credential specified in the machine token has been revoked or the server requires a DRM credential with a higher version number.
static AdobeErrorData	REQ_DRM_VERSION_NOT_SUPPORTED (114) The DRM credential specified in the machine token is not supported.
static AdobeErrorData	REQ_INVALID_MESSAGEID (109) The request specified an invalid message identifier.
static AdobeErrorData	REQ_MACHINE_TOKEN_INVALID_EXPIRED (111) The machine token is not valid or is expired.
static AdobeErrorData	REQ_PROXY_REQUESTS_NOT_SUPPORTED (107) The request contains proxy information, and proxy requests are not supported by the server.
static AdobeErrorData	REQ_RUNTIME_CREDENTIAL_NEEDS_UPGRADE (113) The runtime credential specified in the machine token has been revoked or the server requires a Runtime credential with a higher version number.
static AdobeErrorData	REQ_RUNTIME_VERSION_NOT_SUPPORTED (115) The runtime credential specified in the machine token is not supported.
static AdobeErrorData	REQ_SIGNATURE_INVALID (102) The request signature cannot be verified (for example, the certificate is not valid or the signature was tampered with).
static AdobeErrorData	REQ_UNSUPPORTED_EXTENSION (106) The request contains a critical extension which is not supported.
static AdobeErrorData	REQ_UNSUPPORTED_TYPE (104) This type of request is not supported.
static AdobeErrorData	REQ_UNSUPPORTED_VERSION (105) The request specifies a version which is not supported.
static AdobeErrorData	SERVER_ERROR (100) Generic server error.

Method Summary

java.lang.String	getMessage(java.util.Locale loc) Retrieves the user-friendly text description of the error code.
static void	setMessageResourceBase(java.lang.String messageResourceBase) Changes the default ResourceBundle base name used by Adobe Flash Access Errors to obtain error messages.

Methods inherited from class com.adobe.flashaccess.sdk.protocol.ErrorData

getErrorCode, getMessage, getNamespace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADOBE_NAMESPACE

public static final java.lang.String ADOBE_NAMESPACE

The namespace used for Adobe-defined errors.

See Also:

Constant Field Values

SERVER_ERROR

public static final AdobeErrorData SERVER_ERROR

(100) Generic server error.

REQ_CANNOT_DECRYPT

public static final AdobeErrorData REQ_CANNOT_DECRYPT

(101) The request cannot be decrypted.

REQ_SIGNATURE_INVALID

public static final AdobeErrorData REQ_SIGNATURE_INVALID

(102) The request signature cannot be verified (for example, the certificate is not valid or the signature was tampered with).

REQ_CANNOT_PARSE

public static final AdobeErrorData REQ_CANNOT_PARSE

(103) The request cannot be parsed (format invalid, required data missing, etc.)

REQ_UNSUPPORTED_TYPE

public static final AdobeErrorData REQ_UNSUPPORTED_TYPE

(104) This type of request is not supported.

REQ_UNSUPPORTED_VERSION

public static final AdobeErrorData REQ_UNSUPPORTED_VERSION

(105) The request specifies a version which is not supported.

REQ_UNSUPPORTED_EXTENSION

public static final AdobeErrorData REQ_UNSUPPORTED_EXTENSION

(106) The request contains a critical extension which is not supported.

REQ_PROXY_REQUESTS_NOT_SUPPORTED

public static final AdobeErrorData REQ_PROXY_REQUESTS_NOT_SUPPORTED

(107) The request contains proxy information, and proxy requests are not supported by the server.

REQ_CLIENT_TIME_OUT_OF_RANGE

public static final AdobeErrorData REQ_CLIENT_TIME_OUT_OF_RANGE

(108) The difference between the server's time and the client's time exceeds the configured tolerance.

REQ_INVALID_MESSAGEID

public static final AdobeErrorData REQ_INVALID_MESSAGEID

(109) The request specified an invalid message identifier.

REQ_AUTH_TOKEN_INVALID_EXPIRED

public static final AdobeErrorData REQ_AUTH_TOKEN_INVALID_EXPIRED

(110) The authentication token is not valid or is expired.

REQ_MACHINE_TOKEN_INVALID_EXPIRED

public static final AdobeErrorData REQ_MACHINE_TOKEN_INVALID_EXPIRED

(111) The machine token is not valid or is expired.

REQ_DRM_CREDENTIAL_NEEDS_UPGRADE

public static final AdobeErrorData REQ_DRM_CREDENTIAL_NEEDS_UPGRADE

(112) The DRM credential specified in the machine token has been revoked or the server requires a DRM credential with a higher version number.

REQ_RUNTIME_CREDENTIAL_NEEDS_UPGRADE

public static final AdobeErrorData REQ_RUNTIME_CREDENTIAL_NEEDS_UPGRADE

(113) The runtime credential specified in the machine token has been revoked or the server requires a Runtime credential with a higher version number.

REQ_DRM_VERSION_NOT_SUPPORTED

public static final AdobeErrorData REQ_DRM_VERSION_NOT_SUPPORTED

(114) The DRM credential specified in the machine token is not supported.

REQ_RUNTIME_VERSION_NOT_SUPPORTED

public static final AdobeErrorData REQ_RUNTIME_VERSION_NOT_SUPPORTED

(115) The runtime credential specified in the machine token is not supported.

AUTH_UNSUPPORTED_TYPE

public static final AdobeErrorData AUTH_UNSUPPORTED_TYPE

(201) The request specified an authentication method which is not supported.

AUTH_FAILED

public static final AdobeErrorData AUTH_FAILED

(202) Authentication is denied (for example, the credentials provided in the request are not valid).

LACQ_UNSUPPORTED_PHASE

public static final AdobeErrorData LACQ_UNSUPPORTED_PHASE

(301) The request specified an license acquisition phase which is not supported.

LACQ_CONTENT_METADATA_INVALID

public static final AdobeErrorData LACQ_CONTENT_METADATA_INVALID

(302) Invalid metadata was provided (for example, the signature is invalid or cannot be parsed).

LACQ_CONTENT_POLICY_EXPIRED

public static final AdobeErrorData LACQ_CONTENT_POLICY_EXPIRED

(303) A license cannot be issued, because the policy's end date has been reached.

LACQ_CONTENT_POLICY_REVOKED

public static final AdobeErrorData LACQ_CONTENT_POLICY_REVOKED

(304) A license cannot be issued, because the policy has been revoked.

LACQ_USER_NOT_AUTHORIZED

public static final AdobeErrorData LACQ_USER_NOT_AUTHORIZED

(305) A license cannot be issued, because the user is not authorized to view the content.

LACQ_AUTHENTICATION_REQUIRED

public static final AdobeErrorData LACQ_AUTHENTICATION_REQUIRED

(306) A license cannot be issued, because the user has not been authenticated.

LACQ_TAMPERING_DETECTED

public static final AdobeErrorData LACQ_TAMPERING_DETECTED

(307) A license cannot be issued, because tampering on the client was detected. The SDK does not generate this error, but server implementations may choose to return this error if tampering with the client rollback counter is detected (based on custom business rules). If the server returns this error, customers should be able to contact support to recover from this error.

LACQ_CONTENT_POLICY_NOT_YET_VALID

public static final AdobeErrorData LACQ_CONTENT_POLICY_NOT_YET_VALID

(312) A license cannot be issued, because the policy's start date has not been reached.

Method Detail

getMessage

public java.lang.String getMessage(java.util.Locale loc)

Retrieves the user-friendly text description of the error code.

Specified by:

getMessage in class ErrorData

Parameters:

loc - The locale to use, or null to use the default locale.

Returns:

The user-friendly text description of the error code, or null if no error message was provided or the resource bundle could not be found.

setMessageResourceBase

public static void setMessageResourceBase(java.lang.String messageResourceBase)

Changes the default ResourceBundle base name used by Adobe Flash Access Errors to obtain error messages. The new ResourceBundle must support all of the error codes the default bundle supports: see Adobe_ErrorMsg.properties. See java.util.ResourceBundle for information on how ResourceBundles are located.

Parameters:

messageResourceBase - The base name for the ResourceBundle.