com.ail.core.command
Class JMSAccessor

java.lang.Object
  com.ail.core.Type
      com.ail.core.command.AbstractCommand
          com.ail.core.command.Accessor
              com.ail.core.command.JMSAccessor

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class JMSAccessor
extends Accessor

Deployment specific command for use with JMS. This accessor object acts as a client to a point-to-point JMS queue. The accessor takes two parameters: Factory and Queue which it uses to locate the ConnectionFacctory and Queue via JNDI.

The following example shows how a JMSAccessor can be configured:

   <service name="NotifyPartyByEmailService" builder="ClassBuilder" key="com.ail.core.command.JMSAccessor">
     <parameter name="Factory">ConnectionFactory</parameter>
     <parameter name="Queue">queue/AilCommandQueue</parameter>
   </service>
 

Version:

$Revision: 1.3 $

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ail.core.Type

jXPathContext, NOT_PERSISTED

Constructor Summary

JMSAccessor()

Method Summary

CommandArg	getArgs() Get the argument set associated with this command.
Configuration	getConfiguration() Fetch the configuration of the entry point associated with this command.
java.lang.String	getFactory()
java.lang.String	getQueue()
Version	getVersion() Fetch the version of the command (entry point) associated with this command.
void	invoke() Invoke the command associated with this command object.
void	setArgs(CommandArg args) Update this Command object's arguments with those taken from the command arg passed in.
void	setConfiguration(Configuration properties) Update the configuration of the entry point associated with this command.
void	setFactory(java.lang.String factory)
void	setQueue(java.lang.String queue)

Methods inherited from class com.ail.core.command.Accessor

getLoggingIndicator, getLoggingIndicatorAsString, setLoggingIndicator, setLoggingIndicatorAsString

Methods inherited from class com.ail.core.Type

addAttribute, clone, deleteLock, deleteSerialVersion, fetchJXPathContext, getAttribute, getAttribute, getAttributeCount, getForeignSystemId, getLock, getSerialVersion, getSystemId, hasLock, hasSerialVersion, hasSystemId, isPersisted, markAsNotPersisted, mergeWithDataFrom, removeAttribute, removeAttribute, setAttribute, setForeignSystemId, setLock, setSerialVersion, setSystemId, xpathGet, xpathGet, xpathIterate, xpathSet

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSAccessor

public JMSAccessor()

Method Detail

invoke

public void invoke()
            throws JMSServiceException

Description copied from class: AbstractCommand

Invoke the command associated with this command object. Before invoke is called, the command object must be populated with all the information (parameters) needed to invoke the service via the command object's setters. Once invoke has been called, the object's getters are used to retrieve the results.

Specified by:

invoke in class AbstractCommand

Throws:

JMSServiceException

setArgs

public void setArgs(CommandArg args)

Description copied from class: AbstractCommand

Update this Command object's arguments with those taken from the command arg passed in. This is in effect a bulk setter. This interface will be implemented by beans that have many more getters/setters to support their properties. The implementations of this method take 'that', and pull all the relevant properties into this.

Specified by:

setArgs in class AbstractCommand

Parameters:

args - Source for arguments

getArgs

public CommandArg getArgs()

Description copied from class: AbstractCommand

Get the argument set associated with this command.

Specified by:

getArgs in class AbstractCommand

Returns:

This objects arguments.

getVersion

public Version getVersion()

Description copied from class: AbstractCommand

Fetch the version of the command (entry point) associated with this command. This is similar to the 'invoke' entry point in that control is passed to the entry point object. In this case to the getVersion() method.

Note: This method does not return the version of the command.

Specified by:

getVersion in class AbstractCommand

Returns:

The version of the entry point.

getConfiguration

public Configuration getConfiguration()

Description copied from class: AbstractCommand

Fetch the configuration of the entry point associated with this command. This is similar to invoke in that control is passed to the entry point object, in this case to the getConfiguration method. Note: This method does not return the configuration of the command object.

Specified by:

getConfiguration in class AbstractCommand

Returns:

The entry point's configuration.

setConfiguration

public void setConfiguration(Configuration properties)

Description copied from class: AbstractCommand

Update the configuration of the entry point associated with this command. This is similar to the invoke method in that control is pass to the entry point object, in this case to its setConfiguration method. Note: This method does not set the configuration of the command object.

Specified by:

setConfiguration in class AbstractCommand

Parameters:

properties - Properties to replace the current configuration.

setFactory

public void setFactory(java.lang.String factory)

getFactory

public java.lang.String getFactory()

setQueue

public void setQueue(java.lang.String queue)

getQueue

public java.lang.String getQueue()