Client (stSoftware API)

java.lang.Object
- com.aspc.remote.jms.Client

All Implemented Interfaces:

ShutdownListener

Direct Known Subclasses:

AppClient, CountMessagesClient, FileSyncJMS, MasterDBJMSClient, MonitorClient
```
public abstract class Client
extends java.lang.Object
implements ShutdownListener
```
MT Thread safe JMS client.
THREAD MODE: MULTI-THREADED

Since:

29 April 2005

Author:

Nigel Leck

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTE_RECORD_COUNT`
`static java.lang.String`	`ATTRIBUTE_SENT_MS` The time that this message was sent.
`static java.lang.String`	`ATTRIBUTE_TRANS_MS` The transaction milliseconds for this message.
`static java.lang.String`	`ATTRIBUTE_TRANS_NR` The transaction for this message.
`static java.lang.String`	`DISABLE_JMS` Environment Variable to turn JMS off.
`static java.lang.String`	`ENV_JMS_MAX_LIVE_MS` Environment variable to control the max transfer time in milliseconds
`static java.lang.String`	`ENV_JMS_PENDING_COUNT` The pending count that we will send out an error
`static java.lang.String`	`ENV_JMS_TIMEOUT` Environment variable to control The maximum time we will wait for a JMS message to be sent.
`static long`	`JMS_TIMEOUT` The maximum time we will wait for a JMS message to be sent.
`static int`	`MAX_INACTIVITY_DURATION` the max inactivity duration
`static java.lang.String`	`PROPERTY_MAX_INACTIVITY_DURATION` the property to control max inactivity duration

Constructor Summary

Constructors
Constructor and Description

Client()

Constructors
Constructor and Description
`Client()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`connect()` Connect to the JMS server
`protected void`	`connectionFailed()` the connection failed
`int`	`getConnectionCount()` How many times have we connected ?
`JMSConnectionStatsImpl`	`getConnectionStats()` The stats
`abstract java.lang.String`	`getContextFactory()` The context factory to use
`java.lang.String`	`getCurrentClientID()` The current the client ID
`java.util.Date`	`getLastConnected()` when did we last connect ?
`protected MessageListener`	`getMessageListener()` The message listener
`abstract java.lang.String`	`getProviderUrl()` get the provider URL to use.
`long`	`getTotalSentCount()` How many messages have been sent ?
`boolean`	`isConnected()` Are we currently connected.
`boolean`	`isEnabled()` Do we have a JMS
`static void`	`logSentMessage(TextMessage message, long startMS)` log the sent message.
`void`	`onException(javax.jms.JMSException jMSException)` Handle a JMS exception
`protected void`	`postPublish(Message msg)` We have sent a message
`protected void`	`prePublish(Message msg)` About to send a message
`protected void`	`reconnectedJMS()` We have reconnected to the JMS server ( may have lost some messages).
`protected void`	`refreshContext()` reload the context from the database or where ever.
`void`	`send(java.lang.String message)` Send the XML message to the message server.
`void`	`shutdown()` the application is shutting down.
`void`	`shutdownJMS()` shutdown the JMS connections

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

- Field Detail
  - MAX_INACTIVITY_DURATION
```
public static final int MAX_INACTIVITY_DURATION
```
    the max inactivity duration
  - PROPERTY_MAX_INACTIVITY_DURATION
```
public static final java.lang.String PROPERTY_MAX_INACTIVITY_DURATION
```
    the property to control max inactivity duration
    
    See Also:
    
    Constant Field Values
  - DISABLE_JMS
```
public static final java.lang.String DISABLE_JMS
```
    Environment Variable to turn JMS off.
    
    See Also:
    
    Constant Field Values
  - JMS_TIMEOUT
```
public static final long JMS_TIMEOUT
```
    The maximum time we will wait for a JMS message to be sent.
  - ENV_JMS_TIMEOUT
```
public static final java.lang.String ENV_JMS_TIMEOUT
```
    Environment variable to control The maximum time we will wait for a JMS message to be sent.
    
    See Also:
    
    Constant Field Values
  - ENV_JMS_MAX_LIVE_MS
```
public static final java.lang.String ENV_JMS_MAX_LIVE_MS
```
    Environment variable to control the max transfer time in milliseconds
    
    See Also:
    
    Constant Field Values
  - ENV_JMS_PENDING_COUNT
```
public static final java.lang.String ENV_JMS_PENDING_COUNT
```
    The pending count that we will send out an error
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_SENT_MS
```
public static final java.lang.String ATTRIBUTE_SENT_MS
```
    The time that this message was sent.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_RECORD_COUNT
```
public static final java.lang.String ATTRIBUTE_RECORD_COUNT
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_TRANS_NR
```
public static final java.lang.String ATTRIBUTE_TRANS_NR
```
    The transaction for this message.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_TRANS_MS
```
public static final java.lang.String ATTRIBUTE_TRANS_MS
```
    The transaction milliseconds for this message.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Client
```
public Client()
```
- Method Detail
  - getContextFactory
```
public abstract java.lang.String getContextFactory()
```
    The context factory to use
    
    Returns:
    
    The context factory
  - getProviderUrl
```
public abstract java.lang.String getProviderUrl()
```
    get the provider URL to use.
    
    Returns:
    
    the provider URL.
  - refreshContext
```
protected void refreshContext()
                       throws java.lang.Exception
```
    reload the context from the database or where ever.
    
    Throws:
    
    java.lang.Exception - A serious error.
  - isEnabled
```
public boolean isEnabled()
```
    Do we have a JMS
    
    Returns:
    
    TRUE if we are using a JMS
  - send
```
public void send(java.lang.String message)
          throws java.lang.Exception
```
    Send the XML message to the message server. If the message server is not connected yet then connect. If will fail to send the message because of illegal state then close the connection and try again as the message server was probably been restarted
    
    Parameters:
    
    message - The message text to send.
    
    Throws:
    
    java.lang.Exception - A serious message
  - reconnectedJMS
```
protected void reconnectedJMS()
```
    We have reconnected to the JMS server ( may have lost some messages).
  - prePublish
```
protected void prePublish(Message msg)
```
    About to send a message
    
    Parameters:
    
    msg - The message we are about to send
  - postPublish
```
protected void postPublish(Message msg)
```
    We have sent a message
    
    Parameters:
    
    msg - The message that was sent.
  - connect
```
public void connect()
             throws java.lang.Exception
```
    Connect to the JMS server
    
    Throws:
    
    java.lang.Exception - A serious problem.
  - onException
```
public void onException(javax.jms.JMSException jMSException)
```
    Handle a JMS exception
    
    Parameters:
    
    jMSException - The exception
  - getConnectionStats
```
public JMSConnectionStatsImpl getConnectionStats()
```
    The stats
    
    Returns:
    
    the stats
  - getLastConnected
```
public java.util.Date getLastConnected()
```
    when did we last connect ?
    
    Returns:
    
    the last connection time
  - getConnectionCount
```
public int getConnectionCount()
```
    How many times have we connected ?
    
    Returns:
    
    the count
  - getTotalSentCount
```
public long getTotalSentCount()
```
    How many messages have been sent ?
    
    Returns:
    
    the count
  - isConnected
```
public boolean isConnected()
```
    Are we currently connected.
    
    Returns:
    
    true if connected
  - getMessageListener
```
protected MessageListener getMessageListener()
```
    The message listener
    
    Returns:
    
    the listener.
  - getCurrentClientID
```
@Nonnull
 @CheckReturnValue
public java.lang.String getCurrentClientID()
```
    The current the client ID
    
    Returns:
    
    the client ID
  - connectionFailed
```
protected void connectionFailed()
```
    the connection failed
  - shutdown
```
public final void shutdown()
```
    the application is shutting down.
    
    Specified by:
    
    shutdown in interface ShutdownListener
  - shutdownJMS
```
public final void shutdownJMS()
```
    shutdown the JMS connections
  - logSentMessage
```
public static void logSentMessage(TextMessage message,
                                  long startMS)
```
    log the sent message.
    
    Parameters:
    
    message - the message
    
    startMS - when did we start sending the message.

Class Client

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_INACTIVITY_DURATION

PROPERTY_MAX_INACTIVITY_DURATION

DISABLE_JMS

JMS_TIMEOUT

ENV_JMS_TIMEOUT

ENV_JMS_MAX_LIVE_MS

ENV_JMS_PENDING_COUNT

ATTRIBUTE_SENT_MS

ATTRIBUTE_RECORD_COUNT

ATTRIBUTE_TRANS_NR

ATTRIBUTE_TRANS_MS

Constructor Detail

Client

Method Detail

getContextFactory

getProviderUrl

refreshContext

isEnabled

send

reconnectedJMS

prePublish

postPublish

connect

onException

getConnectionStats

getLastConnected

getConnectionCount

getTotalSentCount

isConnected

getMessageListener

getCurrentClientID

connectionFailed

shutdown

shutdownJMS

logSentMessage