Maximo 7.6.1.2 API - JMSHandler

java.lang.Object
- psdi.iface.router.BaseRouterHandler
- - psdi.iface.router.JMSHandler

All Implemented Interfaces:

RouterHandler
```
public class JMSHandler
extends BaseRouterHandler
```
MQHandler sends/writes data into a JMS MQ(for example : Websphere MQ). Before using this class, one must make sure that they have correct JNDI setup for Queue Connection Factory and Queue. Also depending on the JMS provider, one has to make sure that their application server classpath contains the necessessary jar files. This Class Implements RouterHandler Interface.

Version:

1.0

Author:

Anamitra

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONFACTORYJNDINAME`
`static java.lang.String`	`DESTINATIONTYPE`
`static java.lang.String`	`DESTJNDINAME`
`static java.lang.String`	`INITIALCNTXFACTORY`
`static java.lang.String`	`ISCOMPRESS`
`static java.lang.String`	`ISTEXT`
`static java.lang.String`	`JMSEXIT`
`static java.lang.String`	`JMSPROPS`
`static java.lang.String`	`PROVIDERPASSWORD`
`static java.lang.String`	`PROVIDERURL`
`static java.lang.String`	`PROVIDERUSER`

Fields inherited from interface psdi.iface.router.RouterHandler
BIDICONFIG, PASSWORD, USERNAME

Constructor Summary

Constructors
Constructor and Description

JMSHandler()

JMSHandler(MaxEndPointInfo endPointInfo)

Constructors
Constructor and Description
`JMSHandler()`
`JMSHandler(MaxEndPointInfo endPointInfo)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getConFactoryName()` looks for CON_FACTORY_JNDI_NAME from the Map and returns the Queue Connection Factory JNDI Name from the map.
`java.lang.String`	`getDestinationName()` looks for DEST_QUEUE_JNDI_NAME from the Map and returns the Queue JNDI Name from the map.
`java.lang.String`	`getDestinationType()` The Destination type - javax.jms.Queue/javax.jms.Topic.
`java.lang.String`	`getIniConFactory()` looks for INITIAL_CON_FACTORY from the Map and returns the Initial Context Factory from the map.
`java.lang.String`	`getJMSExit()` looks for CON_FACTORY_JNDI_NAME from the Map and returns the Queue Connection Factory JNDI Name from the map.
`java.util.List<RouterPropsInfo>`	`getProperties()`
`java.lang.String`	`getProviderPassword()` The Password of the provider
`java.lang.String`	`getProviderUrl()` looks for PROVIDER_URL from the Map and returns the Provider Url from the map.
`java.lang.String`	`getProviderUsername()` The username of the provider
`java.lang.String`	`getUsername()` The username for accessing the destination.
`byte[]`	`invoke(java.util.Map<java.lang.String,?> metaData, byte[] data)` Sends / Writes data to a given Queue.
`boolean`	`isCompress()` looks for ISCOMPRESS from the Map and returns a boolean from the map.
`boolean`	`isText()`

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

- Field Detail
  - JMSEXIT
```
public static final java.lang.String JMSEXIT
```
    See Also:
    
    Constant Field Values
  - CONFACTORYJNDINAME
```
public static final java.lang.String CONFACTORYJNDINAME
```
    See Also:
    
    Constant Field Values
  - DESTJNDINAME
```
public static final java.lang.String DESTJNDINAME
```
    See Also:
    
    Constant Field Values
  - INITIALCNTXFACTORY
```
public static final java.lang.String INITIALCNTXFACTORY
```
    See Also:
    
    Constant Field Values
  - PROVIDERURL
```
public static final java.lang.String PROVIDERURL
```
    See Also:
    
    Constant Field Values
  - ISCOMPRESS
```
public static final java.lang.String ISCOMPRESS
```
    See Also:
    
    Constant Field Values
  - ISTEXT
```
public static final java.lang.String ISTEXT
```
    See Also:
    
    Constant Field Values
  - DESTINATIONTYPE
```
public static final java.lang.String DESTINATIONTYPE
```
    See Also:
    
    Constant Field Values
  - PROVIDERUSER
```
public static final java.lang.String PROVIDERUSER
```
    See Also:
    
    Constant Field Values
  - PROVIDERPASSWORD
```
public static final java.lang.String PROVIDERPASSWORD
```
    See Also:
    
    Constant Field Values
  - JMSPROPS
```
public static final java.lang.String JMSPROPS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JMSHandler
```
public JMSHandler(MaxEndPointInfo endPointInfo)
```
  - JMSHandler
```
public JMSHandler()
```
- Method Detail
  - invoke
```
public byte[] invoke(java.util.Map<java.lang.String,?> metaData,
                     byte[] data)
              throws MXException
```
    Sends / Writes data to a given Queue. This sendData method looks for two properties namely CON_FACTORY_JNDI_NAME, DEST_QUEUE_JNDI_NAME and its values for a given external system from the MAXEXTSYSHANDLER table. It uses JMSQueueProducer api to write data into a JMS Queue. Note: Before writing into Queue, if you want to compress the message(byte array), then you have to set a property called "ISCOMPRESS" = true in the MAXEXTSYSHANDLER table
    
    Specified by:
    
    invoke in interface RouterHandler
    
    Overrides:
    
    invoke in class BaseRouterHandler
    
    Parameters:
    
    destinationName - Name of the External System
    
    interfaceName - interfaceName of this transacion
    
    data - the xml transaction in byte array
    
    Returns:
    
    the Bidi transformed data to be collected and used by the descendant classes
    
    Throws:
    
    MXException - if there's a problem in writing data to queue.
    
    See Also:
    
    RouterHandler.invoke(java.util.Map, byte[])
  - getProperties
```
public java.util.List<RouterPropsInfo> getProperties()
```
    Returns:
    
    the List of supported properties.
  - getJMSExit
```
public java.lang.String getJMSExit()
```
    looks for CON_FACTORY_JNDI_NAME from the Map and returns the Queue Connection Factory JNDI Name from the map.
    
    Returns:
    
    Queue Connection Factory name from the map. If there is no property in the map, it returns 'null'
  - getConFactoryName
```
public java.lang.String getConFactoryName()
```
    looks for CON_FACTORY_JNDI_NAME from the Map and returns the Queue Connection Factory JNDI Name from the map.
    
    Returns:
    
    Queue Connection Factory name from the map. If there is no property in the map, it returns 'null'
  - getDestinationName
```
public java.lang.String getDestinationName()
```
    looks for DEST_QUEUE_JNDI_NAME from the Map and returns the Queue JNDI Name from the map.
    
    Returns:
    
    Queue JNDI Name from the map. If there is no property in the map, it returns 'null'
  - getIniConFactory
```
public java.lang.String getIniConFactory()
```
    looks for INITIAL_CON_FACTORY from the Map and returns the Initial Context Factory from the map.
    
    Returns:
    
    Initial Context Factory name from the map. If there is no property in the map, it returns 'null'
  - getProviderUrl
```
public java.lang.String getProviderUrl()
```
    looks for PROVIDER_URL from the Map and returns the Provider Url from the map.
    
    Returns:
    
    Provider URL from the map. If there is no property in the map, it returns 'null'
  - isCompress
```
public boolean isCompress()
                   throws java.lang.Exception
```
    looks for ISCOMPRESS from the Map and returns a boolean from the map.
    
    Returns:
    
    a boolean from the map. If there is no property in the map, it returns 'false'
    
    Throws:
    
    java.lang.Exception
  - getDestinationType
```
public java.lang.String getDestinationType()
```
    The Destination type - javax.jms.Queue/javax.jms.Topic.
    
    Returns:
    
    the destivation type.
  - getUsername
```
public java.lang.String getUsername()
```
    The username for accessing the destination.
    
    Returns:
    
    the username
  - getProviderUsername
```
public java.lang.String getProviderUsername()
```
    The username of the provider
    
    Returns:
    
    the PROVIDERUSER
  - getProviderPassword
```
public java.lang.String getProviderPassword()
```
    The Password of the provider
    
    Returns:
    
    the PROVIDERPASSWORD
  - isText
```
public boolean isText()
```

Class JMSHandler

Field Summary

Fields inherited from interface psdi.iface.router.RouterHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JMSEXIT

CONFACTORYJNDINAME

DESTJNDINAME

INITIALCNTXFACTORY

PROVIDERURL

ISCOMPRESS

ISTEXT

DESTINATIONTYPE

PROVIDERUSER

PROVIDERPASSWORD

JMSPROPS

Constructor Detail

JMSHandler

JMSHandler

Method Detail

invoke

getProperties

getJMSExit

getConFactoryName

getDestinationName

getIniConFactory

getProviderUrl

isCompress

getDestinationType

getUsername

getProviderUsername

getProviderPassword

isText