Skip navigation links

com.bea.wcp.diameter
Class ResultCode

java.lang.Object
com.bea.wcp.diameter.ResultCode

public final class ResultCode

extends java.lang.Object

Diameter result code. Each result code corresponds to either a Result-Code or Experimental-Result AVP within a Diameter answer message. This class also defines constants for the base Diameter protocol result codes.

Field Summary

static ResultCode	APPLICATION_UNSUPPORTED
static ResultCode	AUTHENTICATION_REJECTED
static ResultCode	AUTHORIZATION_REJECTED
static ResultCode	AVP_NOT_ALLOWED
static ResultCode	AVP_OCCURS_TOO_MANY_TIMES
static ResultCode	AVP_UNSUPPORTED
static ResultCode	COMMAND_UNSUPPORTED
static ResultCode	CONTRADICTING_AVPS
static ResultCode	ELECTION_LOST
static ResultCode	INVALID_AVP_BIT_COMBO
static ResultCode	INVALID_AVP_BITS
static ResultCode	INVALID_AVP_LENGTH
static ResultCode	INVALID_AVP_VALUE
static ResultCode	INVALID_BIT_IN_HEADER
static ResultCode	INVALID_HDR_BITS
static ResultCode	INVALID_MESSAGE_LENGTH
static ResultCode	LIMITED_SUCCESS
static ResultCode	LOOP_DETECTED
static ResultCode	MISSING_AVP
static ResultCode	MULTI_ROUND_AUTH
static ResultCode	NO_COMMON_APPLICATION
static ResultCode	NO_COMMON_SECURITY
static ResultCode	OUT_OF_SPACE
static ResultCode	REALM_NOT_SERVED
static ResultCode	REDIRECT_INDICATION
static ResultCode	RESOURCES_EXCEEDED
static ResultCode	SUCCESS
static ResultCode	TOO_BUSY
static ResultCode	UNABLE_TO_COMPLY
static ResultCode	UNABLE_TO_DELIVER
static ResultCode	UNKNOWN_PEER
static ResultCode	UNKNOWN_SESSION_ID
static ResultCode	UNSUPPORTED_VERSION

Method Summary

XmlBuffer	appendXml(XmlBuffer xb)
static ResultCode	decode(Avp avp) If the specified AVP is a Result-Code or Experimental-Result AVP, then returns a new ResultCode for the result.
static ResultCode	define(int code, int vendorId, java.lang.String msg) Creates a new "experimental" ResultCode with the specified numeric code, vendor id, and error message.
static ResultCode	define(int code, java.lang.String msg) Creates a new ResultCode for the specified numeric code and error message.
boolean	equals(java.lang.Object obj)
Avp	getAvp()
int	getCode()
java.lang.String	getMessage() Returns the result code error message or null if none.
int	getVendorId() If this is an experimental result code, then returns the vendor id, otherwise returns 0.
int	hashCode()
boolean	isExperimental() Returns true if this is an experimental result.
boolean	isInformational() Returns true if this is an informational result.
boolean	isPermanentFailure() Returns true if this is a permanent failure.
boolean	isProtocolError() Returns true if this is a protocol error.
static boolean	isResultCode(Avp avp) Returns true if the specified AVP is a Result-Code AVP.
boolean	isSuccess() Returns true if this is a successful result.
boolean	isTransientFailure() Returns true if this is a transient error
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MULTI_ROUND_AUTH

public static final ResultCode MULTI_ROUND_AUTH

SUCCESS

public static final ResultCode SUCCESS

LIMITED_SUCCESS

public static final ResultCode LIMITED_SUCCESS

COMMAND_UNSUPPORTED

public static final ResultCode COMMAND_UNSUPPORTED

UNABLE_TO_DELIVER

public static final ResultCode UNABLE_TO_DELIVER

REALM_NOT_SERVED

public static final ResultCode REALM_NOT_SERVED

TOO_BUSY

public static final ResultCode TOO_BUSY

LOOP_DETECTED

public static final ResultCode LOOP_DETECTED

REDIRECT_INDICATION

public static final ResultCode REDIRECT_INDICATION

APPLICATION_UNSUPPORTED

public static final ResultCode APPLICATION_UNSUPPORTED

INVALID_HDR_BITS

public static final ResultCode INVALID_HDR_BITS

INVALID_AVP_BITS

public static final ResultCode INVALID_AVP_BITS

UNKNOWN_PEER

public static final ResultCode UNKNOWN_PEER

AUTHENTICATION_REJECTED

public static final ResultCode AUTHENTICATION_REJECTED

OUT_OF_SPACE

public static final ResultCode OUT_OF_SPACE

ELECTION_LOST

public static final ResultCode ELECTION_LOST

AVP_UNSUPPORTED

public static final ResultCode AVP_UNSUPPORTED

UNKNOWN_SESSION_ID

public static final ResultCode UNKNOWN_SESSION_ID

AUTHORIZATION_REJECTED

public static final ResultCode AUTHORIZATION_REJECTED

INVALID_AVP_VALUE

public static final ResultCode INVALID_AVP_VALUE

MISSING_AVP

public static final ResultCode MISSING_AVP

RESOURCES_EXCEEDED

public static final ResultCode RESOURCES_EXCEEDED

CONTRADICTING_AVPS

public static final ResultCode CONTRADICTING_AVPS

AVP_NOT_ALLOWED

public static final ResultCode AVP_NOT_ALLOWED

AVP_OCCURS_TOO_MANY_TIMES

public static final ResultCode AVP_OCCURS_TOO_MANY_TIMES

NO_COMMON_APPLICATION

public static final ResultCode NO_COMMON_APPLICATION

UNSUPPORTED_VERSION

public static final ResultCode UNSUPPORTED_VERSION

UNABLE_TO_COMPLY

public static final ResultCode UNABLE_TO_COMPLY

INVALID_BIT_IN_HEADER

public static final ResultCode INVALID_BIT_IN_HEADER

INVALID_AVP_LENGTH

public static final ResultCode INVALID_AVP_LENGTH

INVALID_MESSAGE_LENGTH

public static final ResultCode INVALID_MESSAGE_LENGTH

INVALID_AVP_BIT_COMBO

public static final ResultCode INVALID_AVP_BIT_COMBO

NO_COMMON_SECURITY

public static final ResultCode NO_COMMON_SECURITY

Method Detail

define

public static ResultCode define(int code,
                                int vendorId,
                                java.lang.String msg)

Creates a new "experimental" ResultCode with the specified numeric code, vendor id, and error message.

Parameters:

code - the numeric result code

vendorId - the vendor id

msg - the error message, or null if none

Returns:

the corresponding ResultCode

define

public static ResultCode define(int code,
                                java.lang.String msg)

Creates a new ResultCode for the specified numeric code and error message.

Parameters:

code - the numeric result code

msg - the error message, or null if none

Returns:

the corresponding ResultCode

getCode

public int getCode()

getVendorId

public int getVendorId()

If this is an experimental result code, then returns the vendor id, otherwise returns 0.

getMessage

public java.lang.String getMessage()

Returns the result code error message or null if none.

isInformational

public boolean isInformational()

Returns true if this is an informational result.

isSuccess

public boolean isSuccess()

Returns true if this is a successful result.

isProtocolError

public boolean isProtocolError()

Returns true if this is a protocol error.

isTransientFailure

public boolean isTransientFailure()

Returns true if this is a transient error

isPermanentFailure

public boolean isPermanentFailure()

Returns true if this is a permanent failure.

isExperimental

public boolean isExperimental()

Returns true if this is an experimental result.

decode

public static ResultCode decode(Avp avp)
                         throws AvpException

If the specified AVP is a Result-Code or Experimental-Result AVP, then returns a new ResultCode for the result. Returns null if the AVP is not a result code AVP.

Parameters:

avp - the AVP to be decoded

Returns:

the ResultCode, or null if none

Throws:

AvpException - if the result code AVP was invalid

isResultCode

public static boolean isResultCode(Avp avp)

Returns true if the specified AVP is a Result-Code AVP.

Parameters:

avp - the AVP to be checked

Returns:

true if a Result-Code AVP, false if not

getAvp

public Avp getAvp()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

appendXml

public XmlBuffer appendXml(XmlBuffer xb)

Skip navigation links