com.adobe.livecycle.readerextensions.client
Class RESMsgSet

java.lang.Object
  com.adobe.logging.MsgSet
      com.adobe.livecycle.readerextensions.client.RESMsgSet

public class RESMsgSet
extends com.adobe.logging.MsgSet

This class contains error messages logged by the ReaderExtensions Service using the "RES-" category.

Field Summary

static java.lang.String	PREFIX A prefix used for all messages.
static com.adobe.logging.Msg1	RES_001_002_MISSING_CREDENTIAL The named credential could not be found.
static com.adobe.logging.Msg1	RES_001_004_UNSUPPORTED_CREDENTIAL_FORMAT The format of the credential specified is not supported.
static com.adobe.logging.Msg0	RES_001_005_CREATE_DSC_FAILED Unable to create a local instance of a Document Service Factory.
static com.adobe.logging.Msg0	RES_001_006_CREDENTIAL_SERVICE_FAILED Unable to create a new Credential Service.
static com.adobe.logging.Msg1	RES_001_007_CREDENTIAL_MISSING The Credential Service did not find the requested credential.
static com.adobe.logging.Msg0	RES_001_008_APPLY_RIGHTS_FAILED Unable to apply the requested usage rights to the given document.
static com.adobe.logging.Msg0	RES_001_009_GET_RIGHTS_FAILED An error occurred while trying to access the usage rights of the document.
static com.adobe.logging.Msg0	RES_001_010_REMOVE_RIGHTS_FAILED An error occurred while trying to remove the usage rights of the document.
static com.adobe.logging.Msg0	RES_001_011_SHARED_PDF_FAILED An error occurred while trying to access a shared PDF document.
static com.adobe.logging.Msg0	RES_001_014_GET_RIGHTS_FAILED An error occurred while trying to access the usage rights of the document.
static com.adobe.logging.Msg2	RES_001_015_RIGHT_NOT_ALLOWED The requested usage right is not allowed by the credential.
static com.adobe.logging.Msg0	RES_001_017_PERMISSION_CONFLICT The permissions of the document do not allow usage rights to be applied.
static com.adobe.logging.Msg0	RES_001_018_ACCESS_PERMISSIONS_FAILED An error occurred while trying to access the permissions allowed by the document.
static com.adobe.logging.Msg0	RES_001_019_INVALID_DOCUMENT The input document is not a valid document type for this operation.
static com.adobe.logging.Msg0	RES_001_020_INVALID_OPTIONS The ReaderExtensionsOptions is not correctly specified.
static com.adobe.logging.Msg0	RES_001_021_MISSING_USAGE_RIGHTS The UsageRights are not specified.
static com.adobe.logging.Msg0	RES_001_022_ENCRYPTED_PDF The input PDF document is encrypted and needs to be unlocked for this operation.
static com.adobe.logging.Msg0	RES_001_023_MISSING_ALIAS The credential alias is not specified.
static com.adobe.logging.Msg0	RES_001_024_MISSING_PDF The input PDF document is not specified.
static com.adobe.logging.Msg0	RES_001_025_NOT_RE_CREDENTIAL The credential specified is not a valid Reader Extensions credential.
static com.adobe.logging.Msg0	RES_001_026_CREDENTIAL_ERROR The Reader Extensions credential specified caused an exception while accessing it.
static com.adobe.logging.Msg2	RES_001_027_EXPIRED_CREDENTIAL Unable to apply the requested usage rights because the credential specified has expired.
static com.adobe.logging.Msg1	RES_001_028_USAGE_COUNT_ERROR Unable to access the use count of the credential specified, [{0}].
static com.adobe.logging.Msg1	RES_001_029_INCREMENTAL_COUNT_FAILED The usage count of a credential could not be incremented.
static com.adobe.logging.Msg1	RES_001_030_CREDENTIAL_USAGE_RIGHTS_ERROR Unable to access the usage rights credential specified, [{0}].

Fields inherited from class com.adobe.logging.MsgSet

CONFIG, INFO, SEVERE, WARNING

Constructor Summary

RESMsgSet()

Method Summary

static java.util.Locale	getCurrentLocale() Get the current currentLocale.
static java.lang.String	getMsg(com.adobe.logging.Msg0 msg) Format a Msg0 into a String.
static java.lang.String	getMsg(com.adobe.logging.Msg1 msg, java.lang.Object arg0) Format a Msg1 into a String.
static java.lang.String	getMsg(com.adobe.logging.Msg2 msg, java.lang.Object arg0, java.lang.Object arg1) Format a Msg2 into a String.
static java.lang.String	getMsg(com.adobe.logging.Msg3 msg, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2) Format a Msg3 into a String.
static java.lang.String	getMsg(com.adobe.logging.Msg4 msg, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Format a Msg4 into a String.
static void	setCurrentLocale(java.util.Locale currentLocale) Set the given currentLocale for this message set.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

A prefix used for all messages.

See Also:

Constant Field Values

RES_001_002_MISSING_CREDENTIAL

public static final com.adobe.logging.Msg1 RES_001_002_MISSING_CREDENTIAL

The named credential could not be found.

RES_001_004_UNSUPPORTED_CREDENTIAL_FORMAT

public static final com.adobe.logging.Msg1 RES_001_004_UNSUPPORTED_CREDENTIAL_FORMAT

The format of the credential specified is not supported.

RES_001_005_CREATE_DSC_FAILED

public static final com.adobe.logging.Msg0 RES_001_005_CREATE_DSC_FAILED

Unable to create a local instance of a Document Service Factory.

RES_001_006_CREDENTIAL_SERVICE_FAILED

public static final com.adobe.logging.Msg0 RES_001_006_CREDENTIAL_SERVICE_FAILED

Unable to create a new Credential Service.

RES_001_007_CREDENTIAL_MISSING

public static final com.adobe.logging.Msg1 RES_001_007_CREDENTIAL_MISSING

The Credential Service did not find the requested credential.

RES_001_008_APPLY_RIGHTS_FAILED

public static final com.adobe.logging.Msg0 RES_001_008_APPLY_RIGHTS_FAILED

Unable to apply the requested usage rights to the given document.

RES_001_009_GET_RIGHTS_FAILED

public static final com.adobe.logging.Msg0 RES_001_009_GET_RIGHTS_FAILED

An error occurred while trying to access the usage rights of the document.

RES_001_010_REMOVE_RIGHTS_FAILED

public static final com.adobe.logging.Msg0 RES_001_010_REMOVE_RIGHTS_FAILED

An error occurred while trying to remove the usage rights of the document.

RES_001_011_SHARED_PDF_FAILED

public static final com.adobe.logging.Msg0 RES_001_011_SHARED_PDF_FAILED

An error occurred while trying to access a shared PDF document.

RES_001_014_GET_RIGHTS_FAILED

public static final com.adobe.logging.Msg0 RES_001_014_GET_RIGHTS_FAILED

An error occurred while trying to access the usage rights of the document.

RES_001_015_RIGHT_NOT_ALLOWED

public static final com.adobe.logging.Msg2 RES_001_015_RIGHT_NOT_ALLOWED

The requested usage right is not allowed by the credential.

RES_001_017_PERMISSION_CONFLICT

public static final com.adobe.logging.Msg0 RES_001_017_PERMISSION_CONFLICT

The permissions of the document do not allow usage rights to be applied.

RES_001_018_ACCESS_PERMISSIONS_FAILED

public static final com.adobe.logging.Msg0 RES_001_018_ACCESS_PERMISSIONS_FAILED

An error occurred while trying to access the permissions allowed by the document.

RES_001_019_INVALID_DOCUMENT

public static final com.adobe.logging.Msg0 RES_001_019_INVALID_DOCUMENT

The input document is not a valid document type for this operation.

RES_001_020_INVALID_OPTIONS

public static final com.adobe.logging.Msg0 RES_001_020_INVALID_OPTIONS

The ReaderExtensionsOptions is not correctly specified.

RES_001_021_MISSING_USAGE_RIGHTS

public static final com.adobe.logging.Msg0 RES_001_021_MISSING_USAGE_RIGHTS

The UsageRights are not specified.

RES_001_022_ENCRYPTED_PDF

public static final com.adobe.logging.Msg0 RES_001_022_ENCRYPTED_PDF

The input PDF document is encrypted and needs to be unlocked for this operation.

RES_001_023_MISSING_ALIAS

public static final com.adobe.logging.Msg0 RES_001_023_MISSING_ALIAS

The credential alias is not specified.

RES_001_024_MISSING_PDF

public static final com.adobe.logging.Msg0 RES_001_024_MISSING_PDF

The input PDF document is not specified.

RES_001_025_NOT_RE_CREDENTIAL

public static final com.adobe.logging.Msg0 RES_001_025_NOT_RE_CREDENTIAL

The credential specified is not a valid Reader Extensions credential.

RES_001_026_CREDENTIAL_ERROR

public static final com.adobe.logging.Msg0 RES_001_026_CREDENTIAL_ERROR

The Reader Extensions credential specified caused an exception while accessing it.

RES_001_027_EXPIRED_CREDENTIAL

public static final com.adobe.logging.Msg2 RES_001_027_EXPIRED_CREDENTIAL

Unable to apply the requested usage rights because the credential specified has expired.

RES_001_028_USAGE_COUNT_ERROR

public static final com.adobe.logging.Msg1 RES_001_028_USAGE_COUNT_ERROR

Unable to access the use count of the credential specified, [{0}].

RES_001_029_INCREMENTAL_COUNT_FAILED

public static final com.adobe.logging.Msg1 RES_001_029_INCREMENTAL_COUNT_FAILED

The usage count of a credential could not be incremented. A cause will be given. This is usually not fatal but does indicate an installation or operational issue. The cause should be diagnosed and fixed.

RES_001_030_CREDENTIAL_USAGE_RIGHTS_ERROR

public static final com.adobe.logging.Msg1 RES_001_030_CREDENTIAL_USAGE_RIGHTS_ERROR

Unable to access the usage rights credential specified, [{0}].

Constructor Detail

RESMsgSet

public RESMsgSet()

Method Detail

getMsg

public static java.lang.String getMsg(com.adobe.logging.Msg0 msg)

Format a Msg0 into a String.

Parameters:

msg - the Msg object to be formatted

Returns:

the assembled String

getMsg

public static java.lang.String getMsg(com.adobe.logging.Msg1 msg,
                                      java.lang.Object arg0)

Format a Msg1 into a String.

Parameters:

msg - the Msg object to be formatted

arg0 - the first message argument

Returns:

the assembled String

getMsg

public static java.lang.String getMsg(com.adobe.logging.Msg2 msg,
                                      java.lang.Object arg0,
                                      java.lang.Object arg1)

Format a Msg2 into a String.

Parameters:

msg - the Msg object to be formatted

arg0 - the first message argument

arg1 - the second message argument

Returns:

the assembled String

getMsg

public static java.lang.String getMsg(com.adobe.logging.Msg3 msg,
                                      java.lang.Object arg0,
                                      java.lang.Object arg1,
                                      java.lang.Object arg2)

Format a Msg3 into a String.

Parameters:

msg - the Msg object to be formatted

arg0 - the first message argument

arg1 - the second message argument

arg2 - the third message argument

Returns:

the assembled String

getMsg

public static java.lang.String getMsg(com.adobe.logging.Msg4 msg,
                                      java.lang.Object arg0,
                                      java.lang.Object arg1,
                                      java.lang.Object arg2,
                                      java.lang.Object arg3)

Format a Msg4 into a String.

Parameters:

msg - the Msg object to be formatted

arg0 - the first message argument

arg1 - the second message argument

arg2 - the third message argument

arg3 - the fourth message argument

Returns:

the assembled String

getCurrentLocale

public static java.util.Locale getCurrentLocale()

Get the current currentLocale.

Returns:

the currentLocale

setCurrentLocale

public static void setCurrentLocale(java.util.Locale currentLocale)

Set the given currentLocale for this message set.

Parameters:

currentLocale - the currentLocale to set