Message.Reason (AMPS Java Client (5.3.4.0.14fbce6f.256885))

java.lang.Object
- com.crankuptheamps.client.Message.Reason

Enclosing class:

Message
```
public static final class Message.Reason
extends java.lang.Object
```
Container class of ints that represent the possible values for Message reason.

See Also:

Message.setReason(int), Message.getReason()

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AuthDisabled` Using the default authenication module, which allows everything.
`static int`	`AuthFailure` Represents authentication failure.
`static int`	`BadFilter` Indicates a problem when the AMPS server reports that a filter could not be successfully processed.
`static int`	`BadRegexTopic` Represents an issue with a regular expression used for topic filtering.
`static int`	`BadSowKey` Represents an issue with the storage of messages.
`static int`	`Deleted` Indicates that the data has been deleted.
`static int`	`Duplicate` When a publish indicates that the message, as identified by the bookmark, is already present in this instance of AMPS.
`static int`	`DuplicateLogon` When the AMPS server reports that a filter could not be successfully processed.
`static int`	`Expired` Used when data has exceeded its validity or expiration.
`static int`	`InvalidBookmark` Represents an issue with a bookmark, which is a saved message positions.
`static int`	`InvalidMessageType` Signifies an issue with the message type.
`static int`	`InvalidOptions` Indicates issues with provided options.
`static int`	`InvalidOrderBy` Occurs when there is an issue with the specified ordering of messages.
`static int`	`InvalidSubId` Occurs when an invalid subscription ID is provided.
`static int`	`InvalidTopic` Indicates an issue when the AMPS server reports that the command requested is not valid for the topic specified.
`static int`	`InvalidTopicOrFilter` Indicates an issue with both the topic and the filter.
`static int`	`LogonFailed` Indicates a failure during the login process.
`static int`	`LogonRequired` Signifies that a login is required to perform the operation.
`static int`	`Match` Signifies a successful match or operation.
`static int`	`NameInUse` When an error occurs with the name of a client.
`static int`	`NoClientName` Occurs when there is no client name provided.
`static int`	`None` This is the default state, typically indicating no specific reason or a successful operation.
`static int`	`NotEntitled` Used when a user doesn't have permission to logon or use a specific topic or command.
`static int`	`NoTopic` Occurs when there is no topic specified.
`static int`	`NoTopicOrFilter` Indicates that neither a topic nor a filter is specified.
`static int`	`NotSupported` Used when an operation or feature is not supported.
`static int`	`OrderByTooLarge` Indicates that the requested order-by condition is too large.
`static int`	`Other` Used for other, unspecified reasons or states.
`static int`	`ParseError` Signifies an error in parsing data.
`static int`	`PublishFilterNoMatch` This might never be used.
`static int`	`RegexTopicNotSupported` Indicates that regular expression topics are not supported.
`static int`	`RejectedByTransportFilter` Used when a message is rejected by a transport filter.
`static int`	`SowCanceled` Occurs when a SOW query is canceled.
`static int`	`SowDeleteInvalid` Represents an attempt to delete invalid state of the world.
`static int`	`SowStoreFailed` Occurs when there is a failure in storing messages.
`static int`	`SubidInUse` When the specified subscription ID is already in use for this client.
`static int`	`SubscriptionAlreadyExists` Occurs when a client attempts to register a subscription that already exists.
`static int`	`TxnReplayFailed` Represents a failure in transaction replay.
`static int`	`TxStoreFailure` Indicates a failure in transactional message storage.

Constructor Summary

Constructors
Constructor and Description

Reason()

Constructors
Constructor and Description
`Reason()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - None
```
public static final int None
```
    This is the default state, typically indicating no specific reason or a successful operation.
    
    See Also:
    
    Constant Field Values
  - Duplicate
```
public static final int Duplicate
```
    When a publish indicates that the message, as identified by the bookmark, is already present in this instance of AMPS.
    
    See Also:
    
    Constant Field Values
  - BadFilter
```
public static final int BadFilter
```
    Indicates a problem when the AMPS server reports that a filter could not be successfully processed.
    
    See Also:
    
    Constant Field Values
  - BadRegexTopic
```
public static final int BadRegexTopic
```
    Represents an issue with a regular expression used for topic filtering. OR When the AMPS server reports that the regex provided as the topic for a subscription or query could not be processed.
    
    See Also:
    
    Constant Field Values
  - SubscriptionAlreadyExists
```
public static final int SubscriptionAlreadyExists
```
    Occurs when a client attempts to register a subscription that already exists.
    
    See Also:
    
    Constant Field Values
  - Deleted
```
public static final int Deleted
```
    Indicates that the data has been deleted.
    
    See Also:
    
    Constant Field Values
  - Expired
```
public static final int Expired
```
    Used when data has exceeded its validity or expiration.
    
    See Also:
    
    Constant Field Values
  - Match
```
public static final int Match
```
    Signifies a successful match or operation.
    
    See Also:
    
    Constant Field Values
  - InvalidTopic
```
public static final int InvalidTopic
```
    Indicates an issue when the AMPS server reports that the command requested is not valid for the topic specified.
    
    See Also:
    
    Constant Field Values
  - NameInUse
```
public static final int NameInUse
```
    When an error occurs with the name of a client.
    
    See Also:
    
    Constant Field Values
  - AuthFailure
```
public static final int AuthFailure
```
    Represents authentication failure.
    
    See Also:
    
    Constant Field Values
  - NotEntitled
```
public static final int NotEntitled
```
    Used when a user doesn't have permission to logon or use a specific topic or command.
    
    See Also:
    
    Constant Field Values
  - AuthDisabled
```
public static final int AuthDisabled
```
    Using the default authenication module, which allows everything.
    
    See Also:
    
    Constant Field Values
  - InvalidBookmark
```
public static final int InvalidBookmark
```
    Represents an issue with a bookmark, which is a saved message positions.
    
    See Also:
    
    Constant Field Values
  - InvalidOrderBy
```
public static final int InvalidOrderBy
```
    Occurs when there is an issue with the specified ordering of messages.
    
    See Also:
    
    Constant Field Values
  - SubidInUse
```
public static final int SubidInUse
```
    When the specified subscription ID is already in use for this client.
    
    See Also:
    
    Constant Field Values
  - NoTopic
```
public static final int NoTopic
```
    Occurs when there is no topic specified.
    
    See Also:
    
    Constant Field Values
  - LogonFailed
```
public static final int LogonFailed
```
    Indicates a failure during the login process.
    
    See Also:
    
    Constant Field Values
  - LogonRequired
```
public static final int LogonRequired
```
    Signifies that a login is required to perform the operation.
    
    See Also:
    
    Constant Field Values
  - InvalidTopicOrFilter
```
public static final int InvalidTopicOrFilter
```
    Indicates an issue with both the topic and the filter.
    
    See Also:
    
    Constant Field Values
  - InvalidSubId
```
public static final int InvalidSubId
```
    Occurs when an invalid subscription ID is provided.
    
    See Also:
    
    Constant Field Values
  - NoTopicOrFilter
```
public static final int NoTopicOrFilter
```
    Indicates that neither a topic nor a filter is specified.
    
    See Also:
    
    Constant Field Values
  - NoClientName
```
public static final int NoClientName
```
    Occurs when there is no client name provided.
    
    See Also:
    
    Constant Field Values
  - BadSowKey
```
public static final int BadSowKey
```
    Represents an issue with the storage of messages.
    
    See Also:
    
    Constant Field Values
  - RegexTopicNotSupported
```
public static final int RegexTopicNotSupported
```
    Indicates that regular expression topics are not supported.
    
    See Also:
    
    Constant Field Values
  - SowStoreFailed
```
public static final int SowStoreFailed
```
    Occurs when there is a failure in storing messages.
    
    See Also:
    
    Constant Field Values
  - ParseError
```
public static final int ParseError
```
    Signifies an error in parsing data.
    
    See Also:
    
    Constant Field Values
  - NotSupported
```
public static final int NotSupported
```
    Used when an operation or feature is not supported.
    
    See Also:
    
    Constant Field Values
  - TxStoreFailure
```
public static final int TxStoreFailure
```
    Indicates a failure in transactional message storage.
    
    See Also:
    
    Constant Field Values
  - DuplicateLogon
```
public static final int DuplicateLogon
```
    When the AMPS server reports that a filter could not be successfully processed.
    
    See Also:
    
    Constant Field Values
  - TxnReplayFailed
```
public static final int TxnReplayFailed
```
    Represents a failure in transaction replay.
    
    See Also:
    
    Constant Field Values
  - SowCanceled
```
public static final int SowCanceled
```
    Occurs when a SOW query is canceled.
    
    See Also:
    
    Constant Field Values
  - InvalidOptions
```
public static final int InvalidOptions
```
    Indicates issues with provided options.
    
    See Also:
    
    Constant Field Values
  - InvalidMessageType
```
public static final int InvalidMessageType
```
    Signifies an issue with the message type.
    
    See Also:
    
    Constant Field Values
  - OrderByTooLarge
```
public static final int OrderByTooLarge
```
    Indicates that the requested order-by condition is too large.
    
    See Also:
    
    Constant Field Values
  - RejectedByTransportFilter
```
public static final int RejectedByTransportFilter
```
    Used when a message is rejected by a transport filter.
    
    See Also:
    
    Constant Field Values
  - SowDeleteInvalid
```
public static final int SowDeleteInvalid
```
    Represents an attempt to delete invalid state of the world.
    
    See Also:
    
    Constant Field Values
  - PublishFilterNoMatch
```
public static final int PublishFilterNoMatch
```
    This might never be used.
    
    See Also:
    
    Constant Field Values
  - Other
```
public static final int Other
```
    Used for other, unspecified reasons or states.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Reason
```
public Reason()
```

Class Message.Reason

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

None

Duplicate

BadFilter

BadRegexTopic

SubscriptionAlreadyExists

Deleted

Expired

Match

InvalidTopic

NameInUse

AuthFailure

NotEntitled

AuthDisabled

InvalidBookmark

InvalidOrderBy

SubidInUse

NoTopic

LogonFailed

LogonRequired

InvalidTopicOrFilter

InvalidSubId

NoTopicOrFilter

NoClientName

BadSowKey

RegexTopicNotSupported

SowStoreFailed

ParseError

NotSupported

TxStoreFailure

DuplicateLogon

TxnReplayFailed

SowCanceled

InvalidOptions

InvalidMessageType

OrderByTooLarge

RejectedByTransportFilter

SowDeleteInvalid

PublishFilterNoMatch

Other

Constructor Detail

Reason