org.jdiameter.api
Interface ResultCode

public interface ResultCode

This interface describe basic result codes

Version:

1.5.1 Final

Author:

erick.svenson@yahoo.com, artem.litvinov@gmail.com

Field Summary

static int	APPLICATION_UNSUPPORTED A request was sent for an application that is not supported.
static int	AUTHENTICATION_REJECTED The authentication process for the user failed, most likely due to an invalid password used by the user.
static int	AUTHORIZATION_REJECTED A request was received for which the user could not be authorized.
static int	AVP_NOT_ALLOWED A message was received with an AVP that MUST NOT be present.
static int	AVP_OCCURS_TOO_MANY_TIMES A message was received that included an AVP that appeared more often than permitted in the message definition.
static int	AVP_UNSUPPORTED The peer received a message that contained an AVP that is not recognized or supported and was marked with the Mandatory bit.
static int	COMMAND_UNSUPPORTED The Request contained a Command-Code that the receiver did not recognize or support.
static int	CONTRADICTING_AVPS The Home Diameter server has detected AVPs in the request that contradicted each other, and is not willing to provide service to the user.
static int	ELECTION_LOST The peer has determined that it has lost the election process and has therefore disconnected the transport connection.
static int	INVALID_AVP_BIT_COMBO The request contained an AVP with which is not allowed to have the given value in the AVP Flags field.
static int	INVALID_AVP_BITS A request was received that included an AVP whose flag bits are set to an unrecognized value, or that is inconsistent with the AVP's definition.
static int	INVALID_AVP_LENGTH The request contained an AVP with an invalid length.
static int	INVALID_AVP_VALUE The request contained an AVP with an invalid value in its data portion.
static int	INVALID_BIT_IN_HEADER This error is returned when an unrecognized bit in the Diameter header is set to one (1).
static int	INVALID_HDR_BITS A request was received whose bits in the Diameter header were either set to an invalid combination, or to a value that is inconsistent with the command code's definition.
static int	INVALID_MESSAGE_LENGTH This error is returned when a request is received with an invalid message length.
static int	LIMITED_SUCCESS When returned, the request was successfully completed, but additional processing is required by the application in order to provide service to the user.
static int	LOOP_DETECTED An agent detected a loop while trying to get the message to the intended recipient.
static int	MISSING_AVP The request did not contain an AVP that is required by the Command Code definition.
static int	MULTI_ROUND_AUTH This informational error is returned by a Diameter server to inform the access device that the authentication mechanism being used requires multiple round trips, and a subsequent request needs to be issued in order for access to be granted.
static int	NO_COMMON_APPLICATION This error is returned when a CER message is received, and there are no common applications supported between the peers.
static int	NO_COMMON_SECURITY This error is returned when a CER message is received, and there are no common security mechanisms supported between the peers.
static int	OUT_OF_SPACE A Diameter node received the accounting request but was unable to commit it to stable storage due to a temporary lack of space.
static int	REALM_NOT_SERVED The intended realm of the request is not recognized.
static int	REDIRECT_INDICATION A redirect agent has determined that the request could not be satisfied locally and the initiator of the request should direct the request directly to the server, whose contact information has been added to the response.
static int	RESOURCES_EXCEEDED A request was received that cannot be authorized because the user has already expended allowed resources.
static int	SUCCESS The Request was successfully completed.
static int	TOO_BUSY When returned, a Diameter node SHOULD attempt to send the message to an alternate peer.
static int	UNABLE_TO_COMPLY This error is returned when a request is rejected for unspecified reasons.
static int	UNABLE_TO_DELIVER This error is given when Diameter can not deliver the message to the destination, either because no host within the realm supporting the required application was available to process the request, or because Destination-Host AVP was given without the associated Destination-Realm AVP
static int	UNKNOWN_PEER A CER was received from an unknown peer.
static int	UNKNOWN_SESSION_ID The request contained an unknown Session-Id.
static int	UNSUPPORTED_VERSION This error is returned when a request was received, whose version number is unsupported.

Field Detail

MULTI_ROUND_AUTH

static final int MULTI_ROUND_AUTH

This informational error is returned by a Diameter server to inform the access device that the authentication mechanism being used requires multiple round trips, and a subsequent request needs to be issued in order for access to be granted.

See Also:

Constant Field Values

SUCCESS

static final int SUCCESS

The Request was successfully completed.

See Also:

Constant Field Values

LIMITED_SUCCESS

static final int LIMITED_SUCCESS

When returned, the request was successfully completed, but additional processing is required by the application in order to provide service to the user.

See Also:

Constant Field Values

COMMAND_UNSUPPORTED

static final int COMMAND_UNSUPPORTED

The Request contained a Command-Code that the receiver did not recognize or support. This MUST be used when a Diameter node receives an experimental command that it does not understand.

See Also:

Constant Field Values

UNABLE_TO_DELIVER

static final int UNABLE_TO_DELIVER

This error is given when Diameter can not deliver the message to the destination, either because no host within the realm supporting the required application was available to process the request, or because Destination-Host AVP was given without the associated Destination-Realm AVP

See Also:

Constant Field Values

REALM_NOT_SERVED

static final int REALM_NOT_SERVED

The intended realm of the request is not recognized.

See Also:

Constant Field Values

TOO_BUSY

static final int TOO_BUSY

When returned, a Diameter node SHOULD attempt to send the message to an alternate peer. This error MUST only be used when a specific server is requested, and it cannot provide the requested service.

See Also:

Constant Field Values

LOOP_DETECTED

static final int LOOP_DETECTED

An agent detected a loop while trying to get the message to the intended recipient. The message MAY be sent to an alternate peer, if one is available, but the peer reporting the error has identified a configuration problem.

See Also:

Constant Field Values

REDIRECT_INDICATION

static final int REDIRECT_INDICATION

A redirect agent has determined that the request could not be satisfied locally and the initiator of the request should direct the request directly to the server, whose contact information has been added to the response. When set, the Redirect-Host AVP MUST be present.

See Also:

Constant Field Values

APPLICATION_UNSUPPORTED

static final int APPLICATION_UNSUPPORTED

A request was sent for an application that is not supported.

See Also:

Constant Field Values

INVALID_HDR_BITS

static final int INVALID_HDR_BITS

A request was received whose bits in the Diameter header were either set to an invalid combination, or to a value that is inconsistent with the command code's definition.

See Also:

Constant Field Values

INVALID_AVP_BITS

static final int INVALID_AVP_BITS

A request was received that included an AVP whose flag bits are set to an unrecognized value, or that is inconsistent with the AVP's definition.

See Also:

Constant Field Values

UNKNOWN_PEER

static final int UNKNOWN_PEER

A CER was received from an unknown peer.

See Also:

Constant Field Values

AUTHENTICATION_REJECTED

static final int AUTHENTICATION_REJECTED

The authentication process for the user failed, most likely due to an invalid password used by the user. Further attempts MUST only be tried after prompting the user for a new password.

See Also:

Constant Field Values

OUT_OF_SPACE

static final int OUT_OF_SPACE

A Diameter node received the accounting request but was unable to commit it to stable storage due to a temporary lack of space.

See Also:

Constant Field Values

ELECTION_LOST

static final int ELECTION_LOST

The peer has determined that it has lost the election process and has therefore disconnected the transport connection.

See Also:

Constant Field Values

AVP_UNSUPPORTED

static final int AVP_UNSUPPORTED

The peer received a message that contained an AVP that is not recognized or supported and was marked with the Mandatory bit. A Diameter message with this error MUST contain one or more Failed- AVP AVP containing the AVPs that caused the failure.

See Also:

Constant Field Values

UNKNOWN_SESSION_ID

static final int UNKNOWN_SESSION_ID

The request contained an unknown Session-Id.

See Also:

Constant Field Values

AUTHORIZATION_REJECTED

static final int AUTHORIZATION_REJECTED

A request was received for which the user could not be authorized. This error could occur if the service requested is not permitted to the user.

See Also:

Constant Field Values

INVALID_AVP_VALUE

static final int INVALID_AVP_VALUE

The request contained an AVP with an invalid value in its data portion. A Diameter message indicating this error MUST include the offending AVPs within a Failed-AVP AVP.

See Also:

Constant Field Values

MISSING_AVP

static final int MISSING_AVP

The request did not contain an AVP that is required by the Command Code definition. If this value is sent in the Result-Code AVP, a Failed-AVP AVP SHOULD be included in the message. The Failed-AVP AVP MUST contain an example of the missing AVP complete with the Vendor-Id if applicable. The value field of the missing AVP should be of correct minimum length and contain zeroes.

See Also:

Constant Field Values

RESOURCES_EXCEEDED

static final int RESOURCES_EXCEEDED

A request was received that cannot be authorized because the user has already expended allowed resources. An example of this error condition is a user that is restricted to one dial-up PPP port, attempts to establish a second PPP connection.

See Also:

Constant Field Values

CONTRADICTING_AVPS

static final int CONTRADICTING_AVPS

The Home Diameter server has detected AVPs in the request that contradicted each other, and is not willing to provide service to the user. One or more Failed-AVP AVPs MUST be present, containing the AVPs that contradicted each other.

See Also:

Constant Field Values

AVP_NOT_ALLOWED

static final int AVP_NOT_ALLOWED

A message was received with an AVP that MUST NOT be present. The Failed-AVP AVP MUST be included and contain a copy of the offending AVP.

See Also:

Constant Field Values

AVP_OCCURS_TOO_MANY_TIMES

static final int AVP_OCCURS_TOO_MANY_TIMES

A message was received that included an AVP that appeared more often than permitted in the message definition. The Failed-AVP AVP MUST be included and contain a copy of the first instance of the offending AVP that exceeded the maximum number of occurrences

See Also:

Constant Field Values

NO_COMMON_APPLICATION

static final int NO_COMMON_APPLICATION

This error is returned when a CER message is received, and there are no common applications supported between the peers.

See Also:

Constant Field Values

UNSUPPORTED_VERSION

static final int UNSUPPORTED_VERSION

This error is returned when a request was received, whose version number is unsupported.

See Also:

Constant Field Values

UNABLE_TO_COMPLY

static final int UNABLE_TO_COMPLY

This error is returned when a request is rejected for unspecified reasons.

See Also:

Constant Field Values

INVALID_BIT_IN_HEADER

static final int INVALID_BIT_IN_HEADER

This error is returned when an unrecognized bit in the Diameter header is set to one (1).

See Also:

Constant Field Values

INVALID_AVP_LENGTH

static final int INVALID_AVP_LENGTH

The request contained an AVP with an invalid length. A Diameter message indicating this error MUST include the offending AVPs within a Failed-AVP AVP.

See Also:

Constant Field Values

INVALID_MESSAGE_LENGTH

static final int INVALID_MESSAGE_LENGTH

This error is returned when a request is received with an invalid message length.

See Also:

Constant Field Values

INVALID_AVP_BIT_COMBO

static final int INVALID_AVP_BIT_COMBO

The request contained an AVP with which is not allowed to have the given value in the AVP Flags field. A Diameter message indicating this error MUST include the offending AVPs within a Failed-AVP AVP.

See Also:

Constant Field Values

NO_COMMON_SECURITY

static final int NO_COMMON_SECURITY

This error is returned when a CER message is received, and there are no common security mechanisms supported between the peers. A Capabilities-Exchange-Answer (CEA) MUST be returned with the Result-Code AVP set to DIAMETER_NO_COMMON_SECURITY.

See Also:

Constant Field Values