org.openadaptor.adaptor.jms
Class PurgeFailedMessage

java.lang.Object
  org.openadaptor.adaptor.jms.PurgeFailedMessage

public class PurgeFailedMessage
extends java.lang.Object

PurgeFailedMessage is a utility class to assist handling PurgeFailedMessage status.

PurgeFailedMessage takes one of three values: OFF|ONCE|MANY

The PurgeFailedMessage property controls handling when processng fails for transacted session messages, or non-transacted sessions with AcknowledgeMode set to CLIENT_ACKNOWLEDGE.

   OFF  - no purge of failed messages: they remain in the JMS queue
          and further attempts to process them may be made
   ONCE - on the next attempt to process a message which fails, purge
          the failed message from the JMS Queue/Topic and reset value to OFF
   MANY - on every attempt to process a message which fails, purge
          the failed message from the JMS Queue/Topic (value stays set at MANY)
 

Author:

Colin Prosser

Field Summary

static int	MANY
static int	OFF
static int	ONCE

Constructor Summary

PurgeFailedMessage()

Method Summary

static java.lang.String	get(int purgeFailedMessage) Gets value of a PurgeFailedMessage property as a string.
static int	parse(java.lang.String value) Parse value of a PurgeFailedMessage property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OFF

public static final int OFF

See Also:

Constant Field Values

ONCE

public static final int ONCE

See Also:

Constant Field Values

MANY

public static final int MANY

See Also:

Constant Field Values

Constructor Detail

PurgeFailedMessage

public PurgeFailedMessage()

Method Detail

parse

public static int parse(java.lang.String value)
                 throws IbafException

Parse value of a PurgeFailedMessage property.

PurgeFailedMessage takes one of three values: OFF|ONCE|MANY

PurgeFailedMessage controls handling when processng fails for transacted session messages, or non-transacted sessions with AcknowledgeMode set to CLIENT_ACKNOWLEDGE.

   OFF  - no purge of failed messages: they remain in the JMS queue
          and further attempts to process them may be made
   ONCE - on the next attempt to process a message which fails, purge
          the failed message from the JMS Queue/Topic and reset value to OFF
   MANY - on every attempt to process a message which fails, purge
          the failed message from the JMS Queue/Topic (value stays set at MANY)
 

Parameters:

value - string to parse for purgeFailedMessage property.

Throws:

IbafException - if illegal value.

get

public static java.lang.String get(int purgeFailedMessage)

Gets value of a PurgeFailedMessage property as a string.

Returns:

value of the given PurgeFailedMessage as string