com.wm.app.b2b.server.jms.consumer

Class JMSTriggerGroupFacade

java.lang.Object

com.wm.app.b2b.server.jms.consumer.JMSTriggerGroupFacade

public class JMSTriggerGroupFacade
extends java.lang.Object

JMSTriggerGroupFacade is a utility class for quickly creating, deleting, and listing JMS triggers that belong to JMS trigger groups. A JMS trigger group is a collection of nearly identical JMS triggers where each trigger uses a different JMS connection alias to point to different Universal Messaging realms.

Constructor Summary

Constructors

Constructor and Description
JMSTriggerGroupFacade()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createTrigger(java.lang.String sourceTriggerName, java.lang.String targetAliasName, java.lang.String targetTriggerGroupId, java.lang.String targetPackageName) Creates a new JMS trigger by copying an existing JMS trigger and specifying a different JMS connection alias.
static IData[]	createTriggers(java.lang.String targetAliasName, java.lang.String targetTriggerGroupId, java.lang.String targetPackageName) Creates a new trigger by copying every JMS trigger in a loaded package in Integration Server and specifying a different JMS connection alias.
static IData[]	createTriggersForAlias(java.lang.String sourceAliasName, java.lang.String targetAliasName, java.lang.String targetTriggerGroupId, java.lang.String targetPackageName) Creates a copy of every JMS trigger that uses a specific JMS connection alias in Integration Server.
static IData[]	deleteTriggersForGroupId(java.lang.String triggerGroupId) Deletes all the JMS triggers in a JMS trigger group whose name contains the specified trigger group Id.
static java.util.Map<java.lang.String,java.util.ArrayList<java.lang.String>>	getTriggerGroups() Retrieves data about all trigger groups on the Integration Server.
static IData[]	getTriggerGroupsAsData() Retrieves trigger group data, in the form of IData, for all the trigger groups in loaded packages on Integration Server.
static java.lang.String[]	getTriggersInGroup(java.lang.String groupId) Retrieves a list of all the JMS triggers whose names contain a specific JMS trigger group Id.

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSTriggerGroupFacade

public JMSTriggerGroupFacade()

Method Detail

getTriggerGroups

public static java.util.Map<java.lang.String,java.util.ArrayList<java.lang.String>> getTriggerGroups()
                                                                                              throws JMSSubsystemException

Retrieves data about all trigger groups on the Integration Server.

Returns:

a map representing the trigger groups. Each map entry contains the trigger group name as the key, and an ArrayList of Strings containing the name of the JMS triggers.

Throws:

JMSSubsystemException - if an error occurs

getTriggerGroupsAsData

public static IData[] getTriggerGroupsAsData()
                                      throws JMSSubsystemException

Retrieves trigger group data, in the form of IData, for all the trigger groups in loaded packages on Integration Server.

Returns:

IData[] representing the trigger groups. Each IData entry includes information about an individual trigger group, including the group name, the names of each trigger in the group, the trigger group ID for the trigger, and the name of the JMS connection alias used by the trigger,

Throws:

JMSSubsystemException - if an internal error occurs.

createTrigger

public static java.lang.String createTrigger(java.lang.String sourceTriggerName,
                                             java.lang.String targetAliasName,
                                             java.lang.String targetTriggerGroupId,
                                             java.lang.String targetPackageName)
                                      throws JMSSubsystemException

Creates a new JMS trigger by copying an existing JMS trigger and specifying a different JMS connection alias. The new trigger name will include the original trigger name plus a suffix that includes JMS trigger group tag and the trigger group Id. That is: folder.subfolder:originalJmsTriggerName_triggerGroupTag_Id Note that the JMS trigger group tag is configurable via the watt.server.jms.trigger.groupTag property. The default value is WMTG.

Parameters:

sourceTriggerName - the name of the JMS trigger you are copying.

targetAliasName - the JMS connection alias to assign to the new trigger.

targetTriggerGroupId - the Id appended to the end of the new trigger

targetPackageName - the package in which to create the new trigger

Returns:

the name of the new JMS trigger

Throws:

JMSSubsystemException - thrown if an error occurs.

createTriggers

public static IData[] createTriggers(java.lang.String targetAliasName,
                                     java.lang.String targetTriggerGroupId,
                                     java.lang.String targetPackageName)
                              throws JMSSubsystemException

Creates a new trigger by copying every JMS trigger in a loaded package in Integration Server and specifying a different JMS connection alias. Every new trigger name will include the original trigger name plus a suffix that includes the JMS trigger group tag and the trigger group Id. That is: folder.subfolder:originalJmsTriggerName_triggerGroupTag_Id Note that the JMS trigger group tag is configurable via the watt.server.jms.trigger.groupTag property. The default value is WMTG.

Parameters:

targetAliasName - the JMS connection alias to assign to the new triggers.

targetTriggerGroupId - the Id to append to the end of the new trigger names

targetPackageName - the package in which to create the new triggers

Returns:

IData a list of the names of the JMS trigger that Integration Server attempted to create along with the status of each attempt, where status can be success or the exception that caused trigger creation to fail.

Throws:

JMSSubsystemException - thrown if an error occurs

createTriggersForAlias

public static IData[] createTriggersForAlias(java.lang.String sourceAliasName,
                                             java.lang.String targetAliasName,
                                             java.lang.String targetTriggerGroupId,
                                             java.lang.String targetPackageName)
                                      throws JMSSubsystemException

Creates a copy of every JMS trigger that uses a specific JMS connection alias in Integration Server. You can specify which JMS connection alias the new JMS triggers will use to connect to the JMS provider. Every new trigger name will include the original trigger name plus a suffix that includes the JMS trigger group tag and a trigger group Id. That is: folder.subfolder:originalJmsTriggerName_triggerGroupTag_Id Note that the JMS trigger group tag is configurable via the watt.server.jms.trigger.groupTag property. The default value is WMTG.

Parameters:

sourceAliasName - the name of the JMS connection alias used by the JMS triggers for which you want to create copies

targetAliasName - the JMS connection alias to assign to the new triggers.

targetTriggerGroupId - the Id to append to the end of the new trigger names

targetPackageName - the package in which to create the new triggers

Returns:

IData a list of all trigger names that Integration Server attempted to create along with the status of each attempt. If trigger creation failed, includes a the exception that caused failure.

Throws:

JMSSubsystemException - thrown if an error occurs

deleteTriggersForGroupId

public static IData[] deleteTriggersForGroupId(java.lang.String triggerGroupId)
                                        throws JMSSubsystemException

Deletes all the JMS triggers in a JMS trigger group whose name contains the specified trigger group Id. For example, calling deleteTriggersForGroupId("abc") would delete triggers my.trigger1_WMTG_abc and my.trigger2_WMTG_abc.

Parameters:

triggerGroupId - the name of the JMS trigger group Id contained in the names of the JMS triggers that you want to delete

Returns:

IData a list of the names of the JMS triggers that Integration Server attempted to delete along with the status of each delete attempt. If a JMS trigger could not be deleted, the exception that prevented deletion is included.

Throws:

JMSSubsystemException - thrown if an internal error occurs

getTriggersInGroup

public static java.lang.String[] getTriggersInGroup(java.lang.String groupId)
                                             throws JMSSubsystemException

Retrieves a list of all the JMS triggers whose names contain a specific JMS trigger group Id.

Returns:

a String[] of the names of JMS trigger that are in a JMS trigger group and contain the specified trigger group Id

Throws:

JMSSubsystemException - thrown if an error occurs