atg.portal.alert

Class GearMessagePublisher

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.portal.alert.GearMessagePublisher

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class GearMessagePublisher
extends GenericService

This class' purpose is to take care of all JMS initialization and to write the JMS messages, to the appropriate destination. This "Producer" is the class that handles the JMS lookup necessary to obtain the initial context and connection required to send the message. The producer will require the following elements are specified:

Properties:

messageType

The name of the type of message that will be sent. The message type contains the full path of the message object that will be sent when the event is encountered. For example, "atg.portal.gear.docexch.DocExchMessage".

connectionFactory

The name of the connection factory, which for Dynamo is always: "dynamo:/atg/dynamo/messaging/MessagingManager"

topicName

The JNDI name bound to the JMS provider's Topic. This is the name that will be looked up in order to establish the connection used to send the message. For Example, "localdms:/local/PAF/DocumentCreatedEvent".

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
GearMessagePublisher()

Method Summary

Modifier and Type	Method and Description
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
void	doStopService() This is called when a Service is required to shut down.
java.lang.String	getConnectionFactoryName() Get the connectionFactoryName
java.lang.String	getTopicName() Get the topicName
void	setConnectionFactoryName(java.lang.String pConnectionFactoryName) Set the connectionFactoryName
void	setTopicName(java.lang.String pTopicName) Set the topicName
void	writeMessage(GearMessage pMessageObject) Deprecated.
void	writeMessage(PortalMessage pMessageObject) Publish the message object

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

GearMessagePublisher

public GearMessagePublisher()

Method Detail

doStartService

public void doStartService()
                    throws ServiceException

Description copied from class: GenericService

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

doStopService

public void doStopService()
                   throws ServiceException

Description copied from class: GenericService

This is called when a Service is required to shut down. The Service should respond by stopping any processes that it has started.

Overrides:

doStopService in class GenericService

Throws:

ServiceException - if the Service had a problem shutting down

getConnectionFactoryName

public java.lang.String getConnectionFactoryName()

Get the connectionFactoryName

setConnectionFactoryName

public void setConnectionFactoryName(java.lang.String pConnectionFactoryName)

Set the connectionFactoryName

getTopicName

public java.lang.String getTopicName()

Get the topicName

setTopicName

public void setTopicName(java.lang.String pTopicName)

Set the topicName

writeMessage

public void writeMessage(GearMessage pMessageObject)
                  throws javax.jms.JMSException

Deprecated.

Publish the message object

Throws:

javax.jms.JMSException

writeMessage

public void writeMessage(PortalMessage pMessageObject)
                  throws javax.jms.JMSException

Publish the message object

Throws:

javax.jms.JMSException