com.softwareag.eda.utility

Class EDAOrchestrator

java.lang.Object

com.softwareag.eda.utility.EDAOrchestrator

All Implemented Interfaces:

MessageListener, Orchestrator, EDAOrchestratorInterface, JMSReceiverSubscriber

Deprecated.

The EDA Orchestrator has been deprecated and will be removed from the next version of EDA. Please use NERV instead. For more information, see the NERV documentation available with the webMethods Suite.

@Deprecated
public final class EDAOrchestrator
extends java.lang.Object
implements JMSReceiverSubscriber, EDAOrchestratorInterface, Orchestrator

Constructor Summary

Constructors

Constructor and Description
EDAOrchestrator() Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
EDAOrchestrator(com.softwareag.eda.webm.configuration.ConfigEDAOrchestrator configEDAOrchestrator) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
EDAOrchestrator(java.io.File fileConfigEDAOrchestrator) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
EDAOrchestrator(java.lang.String filepathConfigEDAOrchestrator) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Method Summary

Methods

Modifier and Type	Method and Description
com.softwareag.eda.webm.configuration.ConfigEDAOrchestrator	getConfigEDAOrchestrator() Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
java.lang.String	getDefaultDestinationName(EventType eventType) Deprecated. Returns the default JNDI Destination based on the event type object.
java.lang.String	getDefaultDestinationName(javax.xml.namespace.QName eventTypeQName) Deprecated. Returns the default JNDI Destination based on the event type name
EventTypeArtifact	getEventTypeArtifact(javax.xml.namespace.QName eventTypeQName) Deprecated. Returns the event type artifact for the eventTypeQName.
java.util.concurrent.ConcurrentHashMap<javax.xml.namespace.QName,EventTypeArtifact>	getEventTypeArtifacts() Deprecated. Returns the current inventory of event types.
java.util.HashMap<java.lang.String,java.lang.String>	getFilterableProperties(javax.xml.namespace.QName eventTypeQName, java.lang.String xml) Deprecated. Returns a hashmap containing the filterable properties for the specified event type and xml
void	onMessage(MessageListener msgCB, javax.jms.Message message, java.lang.String destinationName, java.lang.String eventTypeName) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	onMessage(javax.jms.Message message, java.lang.String destinationName, java.lang.String eventTypeName) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	printInternals() Deprecated. Logs output showing the contents of the internal maps
void	publish(EventType eventType, java.lang.String xml) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	publish(EventType eventType, java.lang.String destinationName, java.lang.String xml) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	publish(javax.xml.namespace.QName eventTypeQName, java.lang.String xml) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	publish(javax.xml.namespace.QName eventTypeQName, java.lang.String destinationName, java.lang.String xml) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	publish(java.lang.String destinationName, javax.xml.bind.JAXBContext context, com.softwareag.eda.event.Event event) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	publishEventTypeDeploymentChange(javax.xml.namespace.QName eventTypeQName) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	publishNoMsgSelectors(java.lang.String destinationName, java.lang.String xml) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	registerEventType(EventType eventType) Deprecated. Registers an event type passed as an Event Type object
void	registerEventType(javax.xml.namespace.QName qName) Deprecated. Registers an event type passed as an Event Type QName
void	registerEventType(java.lang.String componentPath) Deprecated. Registers an event type passed as a componentPath
void	registerEventTypesInEventTypeStore() Deprecated. Registers event types found in the Event Type Store This method loads all the xsd files found in the Event Type Store folder and registers all xsds evaluated to be a event type.
void	registerEventTypesInFolder(java.lang.String eventTypeFolderPath, boolean recurse) Deprecated. Registers event types found in a folder This method loads all the xsd files found in the folder and registers all xsds evaluated to be a event type.
void	release() Deprecated. Releases all sessions currently avalaible in this Orchestrator.
void	restart() Deprecated. Restarts the current Orchestrator by leaving the current connections with the old settings active.
boolean	subscribe(MessageListener msgCB, java.lang.String destinationName, java.lang.String messageSelector) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
boolean	subscribe(MessageListener msgCB, java.lang.String destinationName, java.lang.String messageSelector, javax.jms.ExceptionListener exceptionListener) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	testJNDIConnection() Deprecated.
void	unsubscribe(MessageListener msgCB, java.lang.String destinationName, boolean refresh) Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.
void	validateXML(javax.xml.namespace.QName eventTypeQName, java.lang.String xml) Deprecated. Validates that msgSelectors can be obtained using the event type and XML string
void	validateXML(javax.xml.namespace.QName eventTypeQName, java.net.URL url) Deprecated. Validates that msgSelectors can be obtained using the event type and XML URL
void	validateXSD(java.net.URL url) Deprecated. Validates that a XSD can be converted into an internal Event Type

Methods inherited from class java.lang.Object

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

Constructor Detail

EDAOrchestrator

@Deprecated
public EDAOrchestrator(com.softwareag.eda.webm.configuration.ConfigEDAOrchestrator configEDAOrchestrator)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Class constructor

Parameters:

configEDAOrchestrator - ConfigEDAOrchestrator object

EDAOrchestrator

@Deprecated
public EDAOrchestrator(java.io.File fileConfigEDAOrchestrator)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Class constructor

Parameters:

fileConfigEDAOrchestrator - File containing XML instance of ConfigEDAOrchestrator object

EDAOrchestrator

@Deprecated
public EDAOrchestrator(java.lang.String filepathConfigEDAOrchestrator)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Class constructor

Parameters:

filepathConfigEDAOrchestrator - String file path to file containing XML instance of ConfigEDAOrchestrator object

EDAOrchestrator

@Deprecated
public EDAOrchestrator()

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Class constructor

Uses SystemProperty called edaO.configuration or then default config path

Method Detail

restart

public void restart()
             throws EventTypeStoreException

Deprecated.

Description copied from interface: Orchestrator

Restarts the current Orchestrator by leaving the current connections with the old settings active.

Specified by:

restart in interface Orchestrator

Throws:

EventTypeStoreException

testJNDIConnection

public void testJNDIConnection()

Deprecated.

Specified by:

testJNDIConnection in interface Orchestrator

registerEventTypesInEventTypeStore

public void registerEventTypesInEventTypeStore()

Deprecated.

Registers event types found in the Event Type Store

This method loads all the xsd files found in the Event Type Store folder and registers all xsds evaluated to be a event type. Folder search is recursive.

Specified by:

registerEventTypesInEventTypeStore in interface Orchestrator

registerEventTypesInFolder

public void registerEventTypesInFolder(java.lang.String eventTypeFolderPath,
                              boolean recurse)

Deprecated.

Registers event types found in a folder

This method loads all the xsd files found in the folder and registers all xsds evaluated to be a event type. Folder search can be recursive.

Parameters:

eventTypeFolderPath - Folder containing the schemas to extract and register

recurse - Recursive folder search option

subscribe

@Deprecated
public boolean subscribe(MessageListener msgCB,
                           java.lang.String destinationName,
                           java.lang.String messageSelector)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Requests a topic subscription be added. If a subscription currently exists for the provided msgCB and destination, this request will replace that existing subscription.

Specified by:

subscribe in interface Orchestrator

Parameters:

msgCB - the class implementing the EDAOrchestraorInterface

destinationName - the name of the JMS Destination to subscribe to

messageSelector - optional - used to filter messages based on filterable attributes of the event (as defined in the event type XSD)

Returns:

true

subscribe

@Deprecated
public boolean subscribe(MessageListener msgCB,
                           java.lang.String destinationName,
                           java.lang.String messageSelector,
                           javax.jms.ExceptionListener exceptionListener)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Requests a topic subscription be added and registers an exception listener. If a subscription currently exists for the provided msgCB and destination, this request will replace that existing subscription.

Specified by:

subscribe in interface Orchestrator

Parameters:

msgCB - the class implementing the EDAOrchestraorInterface

destinationName - the name of the JMS Destination to subscribe to

messageSelector - optional - used to filter messages based on filterable attributes of the event (as defined in the event type XSD)

exceptionListener - optional - listener asynchronously called by the jms provider if a problem with the connection is detected

Returns:

true

unsubscribe

@Deprecated
public void unsubscribe(MessageListener msgCB,
                          java.lang.String destinationName,
                          boolean refresh)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Requests a topic subscription be removed

Specified by:

unsubscribe in interface Orchestrator

Parameters:

msgCB - the class implementing the EDAOrchestraorInterface

destinationName - the name of the JMS Destination to subscribe to

refresh - optional - states whether the unsubscribe will be replaced with a subscribe

onMessage

@Deprecated
public void onMessage(MessageListener msgCB,
                        javax.jms.Message message,
                        java.lang.String destinationName,
                        java.lang.String eventTypeName)
               throws javax.jms.JMSException

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Implementation of JMSReceiverSubscriber inherited abstract method

Specified by:

onMessage in interface JMSReceiverSubscriber

Throws:

javax.jms.JMSException

onMessage

@Deprecated
public void onMessage(javax.jms.Message message,
                        java.lang.String destinationName,
                        java.lang.String eventTypeName)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Implementation of EDAOrchestratorInterface for internal events

Specified by:

onMessage in interface MessageListener

Parameters:

message - the message to be delivered

destinationName - the name of the topic to which the message was sent

eventTypeName - the name of the event type

publish

@Deprecated
public void publish(javax.xml.namespace.QName eventTypeQName,
                      java.lang.String destinationName,
                      java.lang.String xml)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Publishes an XML event using the specified JNDI Destination name

Specified by:

publish in interface Orchestrator

Parameters:

eventTypeQName - the event type Qname found in the eventTypeCache event type. event type must be registered before use.

destinationName - the name of the JNDI Destination to use for announcement

xml - the event instance in XML format. This XML must comply with the related event type format found in the eventTypeCache.

publish

@Deprecated
public void publish(javax.xml.namespace.QName eventTypeQName,
                      java.lang.String xml)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Publishes an XML event using the default JNDI Destination name

Specified by:

publish in interface Orchestrator

Parameters:

eventTypeQName - the event type name found in the eventTypeCache event type. event type must be registered before use.

xml - the event instance in XML format. This XML must comply with the related event type format found in the eventTypeCache.

publish

@Deprecated
public void publish(EventType eventType,
                      java.lang.String destinationName,
                      java.lang.String xml)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Publishes an XML event using the specified JNDI Destination name

Specified by:

publish in interface Orchestrator

Parameters:

eventType - event type object represented in the xml

destinationName - the name of the JNDI Destination to use for announcement

xml - the event instance in XML format. This XML must comply with the related event type format found in the eventTypeCache.

publish

@Deprecated
public void publish(EventType eventType,
                      java.lang.String xml)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Publishes an XML event using the default JNDI Destination name

Specified by:

publish in interface Orchestrator

Parameters:

eventType - event type object represented in the xml

xml - the event instance in XML format. This XML must comply with the related event type format found in the eventTypeCache.

publishNoMsgSelectors

@Deprecated
public void publishNoMsgSelectors(java.lang.String destinationName,
                                    java.lang.String xml)
                           throws java.lang.Exception

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Publishes an XML event using the specified JNDI Destination name. No filterableProperties since event type not provided in this method

Specified by:

publishNoMsgSelectors in interface Orchestrator

Parameters:

destinationName - the name of the JNDI Destination to use for announcement

xml - the event instance in XML format. This XML must comply with the related event type format found in the eventTypeCache.

Throws:

java.lang.Exception - ???

publish

@Deprecated
public void publish(java.lang.String destinationName,
                      javax.xml.bind.JAXBContext context,
                      com.softwareag.eda.event.Event event)

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Publishes an Event using the specified JNDI Destination name

Specified by:

publish in interface Orchestrator

Parameters:

destinationName - the name of the JNDI Destination to use for announcement

context - JAXBContext of event - should include class name of Event and the

event - the event instance in event object format. This event type must be registered in the eventTypeCache first.

validateXSD

public void validateXSD(java.net.URL url)

Deprecated.

Validates that a XSD can be converted into an internal Event Type

Parameters:

url - the URL location of the file to be validated

validateXML

public void validateXML(javax.xml.namespace.QName eventTypeQName,
               java.net.URL url)

Deprecated.

Validates that msgSelectors can be obtained using the event type and XML URL

Parameters:

eventTypeQName - the event type Qname found in the eventTypeCache event type. event type must be registered before use.

url - the URL location of the file to be validated

validateXML

public void validateXML(javax.xml.namespace.QName eventTypeQName,
               java.lang.String xml)

Deprecated.

Validates that msgSelectors can be obtained using the event type and XML string

Parameters:

eventTypeQName - the event type Qname found in the eventTypeCache event type. event type must be registered before use.

xml - String containing the XML to validate

getFilterableProperties

public java.util.HashMap<java.lang.String,java.lang.String> getFilterableProperties(javax.xml.namespace.QName eventTypeQName,
                                                                           java.lang.String xml)

Deprecated.

Returns a hashmap containing the filterable properties for the specified event type and xml

Parameters:

eventTypeQName - the event type name found in the eventTypeCache event type. event type must be registered before use.

xml - the event instance in XML format. This XML must comply with the related event type format found in the eventTypeCache.

Returns:

HashMap Property and property value pairing

getDefaultDestinationName

public java.lang.String getDefaultDestinationName(javax.xml.namespace.QName eventTypeQName)

Deprecated.

Returns the default JNDI Destination based on the event type name

Specified by:

getDefaultDestinationName in interface Orchestrator

Parameters:

eventTypeQName - the event type Qname found in the eventTypeCache event type. event type must be registered before use.

Returns:

String defaultDestinationName

getDefaultDestinationName

public java.lang.String getDefaultDestinationName(EventType eventType)

Deprecated.

Description copied from interface: Orchestrator

Returns the default JNDI Destination based on the event type object.

Specified by:

getDefaultDestinationName in interface Orchestrator

Parameters:

eventType - ?

Returns:

String defaultDestinationName

publishEventTypeDeploymentChange

@Deprecated
public void publishEventTypeDeploymentChange(javax.xml.namespace.QName eventTypeQName)
                                      throws java.lang.Exception

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Publishes an event type deployment change for the event type provided as a QName

This is a special event type and instances do not comply with EDA event instance standards

Specified by:

publishEventTypeDeploymentChange in interface Orchestrator

Parameters:

eventTypeQName -

Throws:

java.lang.Exception

printInternals

public void printInternals()

Deprecated.

Logs output showing the contents of the internal maps

getConfigEDAOrchestrator

public com.softwareag.eda.webm.configuration.ConfigEDAOrchestrator getConfigEDAOrchestrator()

Deprecated. The entire class is deprecated. See deprecation notice for EDAOrchestrator.

Returns the ConfigEDAOrchestrator in use

Specified by:

getConfigEDAOrchestrator in interface Orchestrator

Returns:

ConfigEDAOrchestrator

getEventTypeArtifact

public EventTypeArtifact getEventTypeArtifact(javax.xml.namespace.QName eventTypeQName)

Deprecated.

Description copied from interface: Orchestrator

Returns the event type artifact for the eventTypeQName.

Specified by:

getEventTypeArtifact in interface Orchestrator

Parameters:

eventTypeQName - ?

Returns:

?

getEventTypeArtifacts

public java.util.concurrent.ConcurrentHashMap<javax.xml.namespace.QName,EventTypeArtifact> getEventTypeArtifacts()

Deprecated.

Description copied from interface: Orchestrator

Returns the current inventory of event types.

Specified by:

getEventTypeArtifacts in interface Orchestrator

Returns:

to be removed

registerEventType

public void registerEventType(EventType eventType)

Deprecated.

Registers an event type passed as an Event Type object

Specified by:

registerEventType in interface Orchestrator

Parameters:

eventType - event type object to be registered

registerEventType

public void registerEventType(javax.xml.namespace.QName qName)
                       throws java.lang.Exception

Deprecated.

Registers an event type passed as an Event Type QName

Specified by:

registerEventType in interface Orchestrator

Parameters:

qName - qname to the event type to be registered

Throws:

java.lang.Exception

registerEventType

public void registerEventType(java.lang.String componentPath)
                       throws java.lang.Exception

Deprecated.

Registers an event type passed as a componentPath

Specified by:

registerEventType in interface Orchestrator

Parameters:

componentPath - componentPath to the event type to be registered

Throws:

java.lang.Exception

release

public void release()
             throws java.lang.Exception

Deprecated.

Releases all sessions currently avalaible in this Orchestrator. It is extremely recomended to use that method after the Orchestrator is no more needed.

Specified by:

release in interface Orchestrator

Throws:

java.lang.Exception - ?