Oracle WebLogic Communications Server 10.1 API Reference

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.

Copyright © 2008 Oracle Corp. All Rights Reserved.

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

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

APPLICATION_UNSUPPORTED

public static final ResultCode APPLICATION_UNSUPPORTED

AUTHENTICATION_REJECTED

public static final ResultCode AUTHENTICATION_REJECTED

AUTHORIZATION_REJECTED

public static final ResultCode AUTHORIZATION_REJECTED

AVP_NOT_ALLOWED

public static final ResultCode AVP_NOT_ALLOWED

AVP_OCCURS_TOO_MANY_TIMES

public static final ResultCode AVP_OCCURS_TOO_MANY_TIMES

AVP_UNSUPPORTED

public static final ResultCode AVP_UNSUPPORTED

COMMAND_UNSUPPORTED

public static final ResultCode COMMAND_UNSUPPORTED

CONTRADICTING_AVPS

public static final ResultCode CONTRADICTING_AVPS

ELECTION_LOST

public static final ResultCode ELECTION_LOST

INVALID_AVP_BIT_COMBO

public static final ResultCode INVALID_AVP_BIT_COMBO

INVALID_AVP_BITS

public static final ResultCode INVALID_AVP_BITS

INVALID_AVP_LENGTH

public static final ResultCode INVALID_AVP_LENGTH

INVALID_AVP_VALUE

public static final ResultCode INVALID_AVP_VALUE

INVALID_BIT_IN_HEADER

public static final ResultCode INVALID_BIT_IN_HEADER

INVALID_HDR_BITS

public static final ResultCode INVALID_HDR_BITS

INVALID_MESSAGE_LENGTH

public static final ResultCode INVALID_MESSAGE_LENGTH

LIMITED_SUCCESS

public static final ResultCode LIMITED_SUCCESS

LOOP_DETECTED

public static final ResultCode LOOP_DETECTED

MISSING_AVP

public static final ResultCode MISSING_AVP

MULTI_ROUND_AUTH

public static final ResultCode MULTI_ROUND_AUTH

NO_COMMON_APPLICATION

public static final ResultCode NO_COMMON_APPLICATION

NO_COMMON_SECURITY

public static final ResultCode NO_COMMON_SECURITY

OUT_OF_SPACE

public static final ResultCode OUT_OF_SPACE

REALM_NOT_SERVED

public static final ResultCode REALM_NOT_SERVED

REDIRECT_INDICATION

public static final ResultCode REDIRECT_INDICATION

RESOURCES_EXCEEDED

public static final ResultCode RESOURCES_EXCEEDED

SUCCESS

public static final ResultCode SUCCESS

TOO_BUSY

public static final ResultCode TOO_BUSY

UNABLE_TO_COMPLY

public static final ResultCode UNABLE_TO_COMPLY

UNABLE_TO_DELIVER

public static final ResultCode UNABLE_TO_DELIVER

UNKNOWN_PEER

public static final ResultCode UNKNOWN_PEER

UNKNOWN_SESSION_ID

public static final ResultCode UNKNOWN_SESSION_ID

UNSUPPORTED_VERSION

public static final ResultCode UNSUPPORTED_VERSION

Method Detail

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

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

equals

public boolean equals(java.lang.Object obj)

getAvp

public Avp getAvp()

getCode

public int getCode()

getMessage

public java.lang.String getMessage()

Returns the result code error message or null if none.

getVendorId

public int getVendorId()

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

hashCode

public int hashCode()

isExperimental

public boolean isExperimental()

Returns true if this is an experimental result.

isInformational

public boolean isInformational()

Returns true if this is an informational result.

isPermanentFailure

public boolean isPermanentFailure()

Returns true if this is a permanent failure.

isProtocolError

public boolean isProtocolError()

Returns true if this is a protocol error.

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

isSuccess

public boolean isSuccess()

Returns true if this is a successful result.

isTransientFailure

public boolean isTransientFailure()

Returns true if this is a transient error

toString

public java.lang.String toString()