public class SignedReceiptException extends ESSException
SignedReceipt
fails for some reason. Calling method getReason
may
be used to get the reason code for the failure.Modifier and Type | Field and Description |
---|---|
static int |
ATTRIBUTE_PARSING_ERROR
SignedReceipt creation abort reason "Attribute parsing error".
|
static int |
ML_RECEIPT_POLICY_VALUE_NONE
SignedReceipt creation abort reason "MlReceiptPolicy value none".
|
static int |
NO_RECEIPT_REQUEST
SignedReceipt creation abort reason "No receipt request".
|
static int |
NOT_A_FIRST_TIER_RECIPIENT
SignedReceipt creation abort reason "Not a firstTier recipient".
|
static int |
NOT_IN_RECEIPTS_FROM_LIST
SignedReceipt creation abort reason "Not in receiptsFrom list".
|
protected int |
reason_
The reason why no SignedReceipt has been created.
|
static int |
RECEIPT_REQUEST_ATTRIBUTES_MISMATCH
SignedReceipt creation abort reason "ReceiptRequest attributes mismatch".
|
Constructor and Description |
---|
SignedReceiptException()
Creates a new SignedReceiptException.
|
SignedReceiptException(int reason)
Creates an SignedReceiptException for the specified reason.
|
SignedReceiptException(int reason,
java.lang.String message)
Creates an SignedReceiptException for the specified reason and error message.
|
SignedReceiptException(java.lang.String msg)
Creates an SignedReceiptException with a specified message.
|
Modifier and Type | Method and Description |
---|---|
int |
getReason()
Returns the reason why no SignedReceipt has been created.
|
static java.lang.String |
getReasonMsg(int reason)
Returns a message describing the given reason code.
|
public static final int NO_RECEIPT_REQUEST
ReceiptRequest
attribute.public static final int NOT_IN_RECEIPTS_FROM_LIST
ReceiptRequest
attribute is present, but the recipients address is not
included in the receiptsFrom field.public static final int ML_RECEIPT_POLICY_VALUE_NONE
MLExpansionHistory
attribute is present in the outermost SignedData layer and that its last
MLData
element has a MLReceiptPolicy
value of "none": the the mail list receipt policy supersedes
the receipt request of the sender and no signed receipt has to be sent.public static final int NOT_A_FIRST_TIER_RECIPIENT
MLExpansionHistory
attribute.public static final int RECEIPT_REQUEST_ATTRIBUTES_MISMATCH
ReceiptRequest
attributes included in the SignedData layer that are not identical as
required by RFC2634.public static final int ATTRIBUTE_PARSING_ERROR
ReceiptRequest
attribute included in the inner SignedData layer or a
MLExpansionHistory
attribute
included in the outer layer.protected int reason_
public SignedReceiptException()
public SignedReceiptException(java.lang.String msg)
msg
- the message.public SignedReceiptException(int reason)
"No receipt request"
(integer 0)
"Not in receiptsFrom list"
(integer 1)
"MlReceiptPolicy value none"
(integer 2)
"Not a firstTier recipient"
(integer 3)
"ReceiptRequest attributes mismatch"
(integer 4)
"Attribute parsing error"
(integer 4)
reason
- the reason why no SignedReceipt has been createdpublic SignedReceiptException(int reason, java.lang.String message)
"No receipt request"
(integer 0)
"Not in receiptsFrom list"
(integer 1)
"MlReceiptPolicy value none"
(integer 2)
"Not a firstTier recipient"
(integer 3)
"ReceiptRequest attributes mismatch"
(integer 4)
"Attribute parsing error"
(integer 4)
reason
- the reason why no SignedReceipt has been createdmessage
- the error messagepublic int getReason()
"No receipt request"
(integer 0)
"Not in receiptsFrom list"
(integer 1)
"MlReceiptPolicy value none"
(integer 2)
"Not a firstTier recipient"
(integer 3)
"ReceiptRequest attributes mismatch"
(integer 4)
"Attribute parsing error"
(integer 4)
public static java.lang.String getReasonMsg(int reason)
reason
- the reason code