com.opencloud.slee.resources.mm7
Class MM7StatusCode

java.lang.Object
  com.opencloud.slee.resources.mm7.MM7StatusCode

public class MM7StatusCode
extends java.lang.Object

Represents a MM7 Status Code. Constants in this class map to the numeric status codes defined by the MM7 specification.

Field Summary

static int	ADDRESS_ERROR The address supplied in the request was not in a recognizable format or the MMS Relay/Server ascertained that the address was not valid for the network because it was determined not to be serviced by this MMS Relay/Server.
static int	ADDRESS_NOT_FOUND The address supplied in the request could not be located by the MMS Relay/Server.
static int	APPLICATION_ADDRESSING_NOT_SUPPORTED Recipient MMS User Agent does not support the transport of application data.
static int	APPLICATION_DENIED The application does not have permission or funds to perform the requested operation.
static int	APPLICATION_ID_NOT_FOUND This code is returned when an operation is requested on a previously submitted message and the MMS Relay/Server cannot find the destination application for the application ID specified or when the VASP receives a report concerning a previously submitted message and the application ID is not recognized.
static int	CLIENT_ERROR The client made an invalid request
static int	GENERAL_SERVICE_ERROR The requested service cannot be fulfilled.
static int	IMPROPER_IDENTIFICATION Identification header of the request does not uniquely identify the client ( either the VASP or MMS Relay/Server ).
static int	LINKED_ID_NOT_FOUND This code is returned when a LinkedID was supplied and the MMS Relay/Server cannot find the related message
static int	MESSAGE_FORMAT_CORRUPT An element value format is inappropriate or incorrect.
static int	MESSAGE_ID_NOT_FOUND This code is returned when an operation is requested on a previously submitted message and the MMS Relay/Server cannot find the moessage for the message ID specified or when the VASP receives a report concerning a previously submitted message and the message ID is not recognized.
static int	MESSAGE_REJECTED Server could not complete the service requested.
static int	MULTIMEDIA_CONTENT_REFUSED The server could not parse the MIME content that was attached to the SOAP message and indicated by the Content element or the content size or media type was unacceptable.
static int	MULTIPLE_ADDRESSES_NOT_SUPPORTED The MMS Relay/Server does not support this operation on multiple recipients.
static int	NOT_POSSIBLE The request could not be carried out because it is not possible.
static int	OPERATION_RESTRICTED The request was refused due to lack of permission to execute the command.
static int	PARTIAL_SUCCESS The request was executed, but some parts of the request could not be completed.
static int	REPLY_APPLICATION_ID_NOT_FOUND This code is returned when a Reply Application ID was supplied and the MMS Relay/Server could not find the originating application.
static int	SERVER_ERROR The server failed to fulfill an apparently valid request.
static int	SERVICE_DENIED The client does not have permission or funds to perform the requested operation.
static int	SERVICE_ERROR The operation caused a server (either MMS Relay/Server or VASP) failure and should not be resent.
static int	SERVICE_UNAVAILABLE This indication may be sent by the server when service is temporarily unavailable, for example when server is busy.
static int	SUCCESS The request was executed completely.
static int	UNSUPPORTED_OPERATION The server does not support the request indicated by the Message Type element in the header of the message.
static int	UNSUPPORTED_VERSION The version indicated by the MM7 version element is not supported.
static int	VALIDATION_ERROR The SOAP and XML structures could not be parsed, mandatory fields are missing, or the message-format is not compatible to the format specified.

Constructor Summary

MM7StatusCode(int code)
Create a new MM7StatusCode object with a particular status code and no details.

MM7StatusCode(int code, java.lang.String details)
Create a new MM7StatusCode object with particular status code and details.

MM7StatusCode(int code, java.lang.String text, java.lang.String details)
Create a new MM7StatusCode object with a particular status code, status text, and details.

Method Summary

boolean	equals(java.lang.Object o)
java.lang.String	getDetails() Get the details for this MM7StatusCode object.
java.lang.String	getSOAPFaultCode() Return the standard SOAP-level Fault Code for this status code.
java.lang.String	getSOAPFaultString() Return the standard SOAP-level Fault String for this status code.
static java.lang.String	getStandardText(int code) Get the standard status text for a status code.
int	getStatusCode() Get the numeric status code.
java.lang.String	getStatusText() Get the status text.
int	hashCode()
boolean	isSuccess() Determine if this status code is a "success" code.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final int SUCCESS

The request was executed completely.

See Also:

Constant Field Values

PARTIAL_SUCCESS

public static final int PARTIAL_SUCCESS

The request was executed, but some parts of the request could not be completed. Lower order( ie proprietary) digits and the optional Details element may indicate what parts of the request were not completed.

See Also:

Constant Field Values

CLIENT_ERROR

public static final int CLIENT_ERROR

The client made an invalid request

See Also:

Constant Field Values

OPERATION_RESTRICTED

public static final int OPERATION_RESTRICTED

The request was refused due to lack of permission to execute the command.

See Also:

Constant Field Values

ADDRESS_ERROR

public static final int ADDRESS_ERROR

The address supplied in the request was not in a recognizable format or the MMS Relay/Server ascertained that the address was not valid for the network because it was determined not to be serviced by this MMS Relay/Server. When used in response-result, and multiple recipients were specified in the corresponding push submisssion, this status code indicates that at least one address is incorrect.

See Also:

Constant Field Values

ADDRESS_NOT_FOUND

public static final int ADDRESS_NOT_FOUND

The address supplied in the request could not be located by the MMS Relay/Server. This code is returned when an operation is requested on a previously submitted message and the MMS Relay/Server cannot find the message for the address specified.

See Also:

Constant Field Values

MULTIMEDIA_CONTENT_REFUSED

public static final int MULTIMEDIA_CONTENT_REFUSED

The server could not parse the MIME content that was attached to the SOAP message and indicated by the Content element or the content size or media type was unacceptable.

See Also:

Constant Field Values

MESSAGE_ID_NOT_FOUND

public static final int MESSAGE_ID_NOT_FOUND

This code is returned when an operation is requested on a previously submitted message and the MMS Relay/Server cannot find the moessage for the message ID specified or when the VASP receives a report concerning a previously submitted message and the message ID is not recognized.

See Also:

Constant Field Values

LINKED_ID_NOT_FOUND

public static final int LINKED_ID_NOT_FOUND

This code is returned when a LinkedID was supplied and the MMS Relay/Server cannot find the related message

See Also:

Constant Field Values

MESSAGE_FORMAT_CORRUPT

public static final int MESSAGE_FORMAT_CORRUPT

An element value format is inappropriate or incorrect.

See Also:

Constant Field Values

APPLICATION_ID_NOT_FOUND

public static final int APPLICATION_ID_NOT_FOUND

This code is returned when an operation is requested on a previously submitted message and the MMS Relay/Server cannot find the destination application for the application ID specified or when the VASP receives a report concerning a previously submitted message and the application ID is not recognized.

Since:

MM7 v.6.8.0

See Also:

Constant Field Values

REPLY_APPLICATION_ID_NOT_FOUND

public static final int REPLY_APPLICATION_ID_NOT_FOUND

This code is returned when a Reply Application ID was supplied and the MMS Relay/Server could not find the originating application.

Since:

MM7 v.6.8.0

See Also:

Constant Field Values

SERVER_ERROR

public static final int SERVER_ERROR

The server failed to fulfill an apparently valid request.

See Also:

Constant Field Values

NOT_POSSIBLE

public static final int NOT_POSSIBLE

The request could not be carried out because it is not possible. This code is normally used as a result of a cancel or status query on a message that is no longer available for cancel or status query. The MMS Relay/Server has recognized the message in qestion, bt it cannot fulfill the request because the message is already complete or status is no longer available.

See Also:

Constant Field Values

MESSAGE_REJECTED

public static final int MESSAGE_REJECTED

Server could not complete the service requested.

See Also:

Constant Field Values

MULTIPLE_ADDRESSES_NOT_SUPPORTED

public static final int MULTIPLE_ADDRESSES_NOT_SUPPORTED

The MMS Relay/Server does not support this operation on multiple recipients. The operation MAY be resubmitted as multiple single recipient operations.

See Also:

Constant Field Values

APPLICATION_ADDRESSING_NOT_SUPPORTED

public static final int APPLICATION_ADDRESSING_NOT_SUPPORTED

Recipient MMS User Agent does not support the transport of application data.

Since:

MM7 v.6.8.0

See Also:

Constant Field Values

GENERAL_SERVICE_ERROR

public static final int GENERAL_SERVICE_ERROR

The requested service cannot be fulfilled.

See Also:

Constant Field Values

IMPROPER_IDENTIFICATION

public static final int IMPROPER_IDENTIFICATION

Identification header of the request does not uniquely identify the client ( either the VASP or MMS Relay/Server ).

See Also:

Constant Field Values

UNSUPPORTED_VERSION

public static final int UNSUPPORTED_VERSION

The version indicated by the MM7 version element is not supported.

See Also:

Constant Field Values

UNSUPPORTED_OPERATION

public static final int UNSUPPORTED_OPERATION

The server does not support the request indicated by the Message Type element in the header of the message.

See Also:

Constant Field Values

VALIDATION_ERROR

public static final int VALIDATION_ERROR

The SOAP and XML structures could not be parsed, mandatory fields are missing, or the message-format is not compatible to the format specified. Details field may specify the parsing error that caused this status.

See Also:

Constant Field Values

SERVICE_ERROR

public static final int SERVICE_ERROR

The operation caused a server (either MMS Relay/Server or VASP) failure and should not be resent.

See Also:

Constant Field Values

SERVICE_UNAVAILABLE

public static final int SERVICE_UNAVAILABLE

This indication may be sent by the server when service is temporarily unavailable, for example when server is busy.

See Also:

Constant Field Values

SERVICE_DENIED

public static final int SERVICE_DENIED

The client does not have permission or funds to perform the requested operation.

See Also:

Constant Field Values

APPLICATION_DENIED

public static final int APPLICATION_DENIED

The application does not have permission or funds to perform the requested operation.

Since:

MM7 v.6.8.0

See Also:

Constant Field Values

Constructor Detail

MM7StatusCode

public MM7StatusCode(int code)
              throws java.lang.IllegalArgumentException

Create a new MM7StatusCode object with a particular status code and no details. The status text is set to the standard value as determined by getStandardText(int).

Parameters:

code - the status code.

Throws:

java.lang.IllegalArgumentException - if code < 1.

MM7StatusCode

public MM7StatusCode(int code,
                     java.lang.String details)
              throws java.lang.IllegalArgumentException

Create a new MM7StatusCode object with particular status code and details. The status text is set to the standard value as determined by getStandardText(int).

Parameters:

code - the status code.

details - any appropriate description providing details of the error or partial success. This parameter may be null.

Throws:

java.lang.IllegalArgumentException - if code < 1.

MM7StatusCode

public MM7StatusCode(int code,
                     java.lang.String text,
                     java.lang.String details)
              throws java.lang.IllegalArgumentException,
                     java.lang.NullPointerException

Create a new MM7StatusCode object with a particular status code, status text, and details.

Parameters:

code - the status code.

text - the status text.

details - any appropriate description providing details of the error or partial success. This parameter may be null.

Throws:

java.lang.IllegalArgumentException - if code < 1.

java.lang.NullPointerException - if text is null.

Method Detail

getStandardText

public static final java.lang.String getStandardText(int code)

Get the standard status text for a status code. The term standard refers to the status codes and status text defined in the MMS spec: 3GPP TS 23.140 V5.5.0.

Parameters:

code - the status code.

Returns:

the standard status text for the status code. For example, the code SUCCESS has the defined status text of "Success". If the status code is unknown, the text "User-defined Status Code" is returned.

Throws:

java.lang.IllegalArgumentException - if code < 1.

isSuccess

public boolean isSuccess()

Determine if this status code is a "success" code.

Returns:

true if the status code is between 1000 and 1999 inclusive

getStatusCode

public final int getStatusCode()

Get the numeric status code.

Returns:

the status code.

getStatusText

public final java.lang.String getStatusText()

Get the status text.

Returns:

the status code.

getDetails

public final java.lang.String getDetails()

Get the details for this MM7StatusCode object.

Returns:

the details, or null if no details have been set.

getSOAPFaultCode

public java.lang.String getSOAPFaultCode()

Return the standard SOAP-level Fault Code for this status code. For an incoming status code, this may not be the actual SOAP Fault Code received; use ResponseEvent#getSOAPFault to obtain the actual fault.

getSOAPFaultString

public java.lang.String getSOAPFaultString()

Return the standard SOAP-level Fault String for this status code. For an incoming status code, this may not be the actual SOAP Fault String received; use ResponseEvent#getSOAPFault to obtain the actual fault.

equals

public boolean equals(java.lang.Object o)

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