oracle.sdp.messaging
Enum StatusType

java.lang.Object
  java.lang.Enum<StatusType>
      oracle.sdp.messaging.StatusType

All Implemented Interfaces:

Serializable, java.lang.Comparable<StatusType>

public enum StatusType
extends java.lang.Enum<StatusType>

StatusType enumerates all available status types in the SDP Messaging. Some status types are reported by the engine to indicate various message processing states, while others are reported by the driver that delivers the message to a remote gateway.

Since:

11.0.0

Enum Constant Summary

CANCEL_ACKNOWLEDGEMENT_FAILURE
Indicates a failure that occurred during message cancel acknowledgement.

CANCEL_ACKNOWLEDGEMENT_SUCCESS
Indicates successful message cancel acknowledgement.

DELIVERY_TO_CLIENT_FAILURE
Indicates a failure that occurred when the engine attempted to deliver the message to a client (application).

DELIVERY_TO_CLIENT_PENDING
Indicates that the message was processed by the engine, and is waiting for a client app to pick up the message.

DELIVERY_TO_CLIENT_SUCCESS
Indicates successful delivery of the message to a client.

DELIVERY_TO_DEVICE_FAILURE
Indicates a failure that occurred at the gateway when attempting to deliver the message to the device.

DELIVERY_TO_DEVICE_SUCCESS
Indicates successful delivery of the message to the device.

DELIVERY_TO_DRIVER_FAILURE
Indicates a failure that occurred when the engine attempted to deliver the message to a driver.

DELIVERY_TO_DRIVER_PENDING
Indicates that the message was processed by the engine, and is waiting for a driver to pick up the message.

DELIVERY_TO_DRIVER_SUCCESS
Indicates successful delivery of the message to a driver.

DELIVERY_TO_GATEWAY_FAILURE
Indicates a failure that occurred when the driver attempted to deliver the message to a gateway.

DELIVERY_TO_GATEWAY_SUCCESS
Indicates successful delivery of the message to a gateway.

ENGINE_PROCESSING_FAILURE
Indicates a failure that occurred during message processing in the engine.

INTERMEDIATE_NOTIFICATION
Indicates a pending state for this delivery - message is being processed by the engine.

OVERALL_FAILURE
Indicates a final failure - no further statuses will be generated for this delivery.

OVERALL_PENDING
Indicates a pending state for this delivery - message may either be in a queue or being processed by the engine.

OVERALL_SUCCESS
Indicates a final status that concludes a successful delivery - no further statuses will be generated for this delivery.

READ_ACKNOWLEDGEMENT_FAILURE
Indicates a failure that occurred during read acknowledgement.

READ_ACKNOWLEDGEMENT_SUCCESS
Indicates successful read acknowledgement of this message.

REPLACE_ACKNOWLEDGEMENT_FAILURE
Indicates a failure that occurred during message replace acknowledgement.

REPLACE_ACKNOWLEDGEMENT_SUCCESS
Indicates successful message replace acknowledgement.

TIMEOUT
Indicates a delivery timeout occurred while waiting for successful delivery acknowledgement of the message to this recipient.

UNKNOWN_FAILURE
Indicates an unknown failure that occurred during message processing.

UNKNOWN_STATUS_TYPE
Indicates a status received by the driver that it could not understand.

USER_REPLY_ACKNOWLEDGEMENT_FAILURE
Indicates a failure that occurred during user reply acknowledgement.

USER_REPLY_ACKNOWLEDGEMENT_SUCCESS
Indicates successful user reply acknowledgement.

Method Summary

int	getCode()
java.lang.String	getPrimaryType()
java.lang.String	getSecondaryType()
boolean	isFailureType()
boolean	isPendingType()
boolean	isSuccessType()
static StatusType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StatusType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CANCEL_ACKNOWLEDGEMENT_FAILURE

public static final StatusType CANCEL_ACKNOWLEDGEMENT_FAILURE

Indicates a failure that occurred during message cancel acknowledgement.
This status type is not supported by all drivers.

Scope: Sending

CANCEL_ACKNOWLEDGEMENT_SUCCESS

public static final StatusType CANCEL_ACKNOWLEDGEMENT_SUCCESS

Indicates successful message cancel acknowledgement.
This status type is not supported by all drivers.

Scope: Sending

DELIVERY_TO_CLIENT_FAILURE

public static final StatusType DELIVERY_TO_CLIENT_FAILURE

Indicates a failure that occurred when the engine attempted to deliver the message to a client (application).

Scope: Receiving

DELIVERY_TO_CLIENT_PENDING

public static final StatusType DELIVERY_TO_CLIENT_PENDING

Indicates that the message was processed by the engine, and is waiting for a client app to pick up the message.

Scope: Receiving

DELIVERY_TO_CLIENT_SUCCESS

public static final StatusType DELIVERY_TO_CLIENT_SUCCESS

Indicates successful delivery of the message to a client.

Scope: Receiving

DELIVERY_TO_DEVICE_FAILURE

public static final StatusType DELIVERY_TO_DEVICE_FAILURE

Indicates a failure that occurred at the gateway when attempting to deliver the message to the device.
This status type is not supported by all drivers.

Scope: Sending

DELIVERY_TO_DEVICE_SUCCESS

public static final StatusType DELIVERY_TO_DEVICE_SUCCESS

Indicates successful delivery of the message to the device.
This status type is not supported by all drivers.

Scope: Sending

DELIVERY_TO_DRIVER_FAILURE

public static final StatusType DELIVERY_TO_DRIVER_FAILURE

Indicates a failure that occurred when the engine attempted to deliver the message to a driver.

Scope: Sending

DELIVERY_TO_DRIVER_PENDING

public static final StatusType DELIVERY_TO_DRIVER_PENDING

Indicates that the message was processed by the engine, and is waiting for a driver to pick up the message.

Scope: Sending

DELIVERY_TO_DRIVER_SUCCESS

public static final StatusType DELIVERY_TO_DRIVER_SUCCESS

Indicates successful delivery of the message to a driver.

Scope: Sending

DELIVERY_TO_GATEWAY_FAILURE

public static final StatusType DELIVERY_TO_GATEWAY_FAILURE

Indicates a failure that occurred when the driver attempted to deliver the message to a gateway.

Scope: Sending

DELIVERY_TO_GATEWAY_SUCCESS

public static final StatusType DELIVERY_TO_GATEWAY_SUCCESS

Indicates successful delivery of the message to a gateway.

Scope: Sending

ENGINE_PROCESSING_FAILURE

public static final StatusType ENGINE_PROCESSING_FAILURE

Indicates a failure that occurred during message processing in the engine.

Scope: Sending and Receiving

INTERMEDIATE_NOTIFICATION

public static final StatusType INTERMEDIATE_NOTIFICATION

Indicates a pending state for this delivery - message is being processed by the engine.

Scope: Sending and Receiving

OVERALL_FAILURE

public static final StatusType OVERALL_FAILURE

Indicates a final failure - no further statuses will be generated for this delivery.

Scope: Sending and Receiving

OVERALL_PENDING

public static final StatusType OVERALL_PENDING

Indicates a pending state for this delivery - message may either be in a queue or being processed by the engine.

Scope: Sending and Receiving

OVERALL_SUCCESS

public static final StatusType OVERALL_SUCCESS

Indicates a final status that concludes a successful delivery - no further statuses will be generated for this delivery.

Scope: Sending and Receiving

READ_ACKNOWLEDGEMENT_FAILURE

public static final StatusType READ_ACKNOWLEDGEMENT_FAILURE

Indicates a failure that occurred during read acknowledgement.
This status type is not supported by all drivers.

Scope: Sending

READ_ACKNOWLEDGEMENT_SUCCESS

public static final StatusType READ_ACKNOWLEDGEMENT_SUCCESS

Indicates successful read acknowledgement of this message.
This status type is not supported by all drivers.

Scope: Sending

REPLACE_ACKNOWLEDGEMENT_FAILURE

public static final StatusType REPLACE_ACKNOWLEDGEMENT_FAILURE

Indicates a failure that occurred during message replace acknowledgement.
This status type is not supported by all drivers.

Scope: Sending

REPLACE_ACKNOWLEDGEMENT_SUCCESS

public static final StatusType REPLACE_ACKNOWLEDGEMENT_SUCCESS

Indicates successful message replace acknowledgement.
This status type is not supported by all drivers.

Scope: Sending

TIMEOUT

public static final StatusType TIMEOUT

Indicates a delivery timeout occurred while waiting for successful delivery acknowledgement of the message to this recipient.

Scope: Sending

UNKNOWN_FAILURE

public static final StatusType UNKNOWN_FAILURE

Indicates an unknown failure that occurred during message processing. This is generally used to report unexpected exceptions that occur during message processing.

Scope: Sending and Receiving

UNKNOWN_STATUS_TYPE

public static final StatusType UNKNOWN_STATUS_TYPE

Indicates a status received by the driver that it could not understand. This type is treated as a failure type (in order to assist with failover).

Scope: Sending

USER_REPLY_ACKNOWLEDGEMENT_FAILURE

public static final StatusType USER_REPLY_ACKNOWLEDGEMENT_FAILURE

Indicates a failure that occurred during user reply acknowledgement.
This status type is not supported by all drivers.

Scope: Sending

USER_REPLY_ACKNOWLEDGEMENT_SUCCESS

public static final StatusType USER_REPLY_ACKNOWLEDGEMENT_SUCCESS

Indicates successful user reply acknowledgement.
This status type is not supported by all drivers.

Scope: Sending

Method Detail

getCode

public int getCode()

Returns:

returns the code.

getPrimaryType

public java.lang.String getPrimaryType()

Returns:

returns the primaryType of this status type.

getSecondaryType

public java.lang.String getSecondaryType()

Returns:

returns the secondaryType of this status type, one of "PENDING", "SUCCESS", "FAILURE".

isFailureType

public boolean isFailureType()

Returns:

returns true if this status' secondary type is "FAILURE", false otherwise.

isPendingType

public boolean isPendingType()

Returns:

returns true if this status' secondary type is "PENDING", false otherwise.

isSuccessType

public boolean isSuccessType()

Returns:

returns true if this status' secondary type is "SUCCESS", false otherwise.

valueOf

public static StatusType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

values

public static StatusType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StatusType c : StatusType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared