EventTopic (Maximo API)

java.lang.Object
- psdi.server.event.EventTopic

All Implemented Interfaces:: FixedLoggerNames, FixedLoggers

public class EventTopic
extends java.lang.Object
implements FixedLoggers

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String subject
- Fields inherited from interface psdi.util.logging.FixedLoggers
  APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER
- Fields inherited from interface psdi.util.logging.FixedLoggerNames
  appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`subject`

Constructor Summary

Constructors
Constructor and Description

EventTopic(java.lang.String subject)

Constructors
Constructor and Description
`EventTopic(java.lang.String subject)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSubTopic(EventTopic ev)` Add subtopic tree to the event node.
`java.util.Map`	`dumpTopic()`
`void`	`eventAction(EventMessage msg)` action is taken on all subscriptions that returned validate.
`void`	`eventValidate(EventMessage msg)` Runs through all the subscriptons to see if there are any vetoable exceptions.
`EventTopic`	`getEventTopic(java.lang.String subject)` getEventTopic searches the whole event topic tree for an eventTopic.
`java.util.Map`	`getExtendedSubIds()`
`int`	`getListenerCount()`
`java.util.Map`	`getListeners()`
`java.lang.String`	`getSubject()` Returns event topic name.
`int`	`getSubscriptionId(EventListener evt)` Returns the subscription id for the event listener object.
`int`	`getSubscriptionIdByClassName(EventListener evt)` Returns the subscription id for the event listener class.
`EventTopicTree`	`getSubTopicTree()` Returns the sub topic tree from this node.
`EventTopicTree`	`getTree()`
`boolean`	`isActive()` Identifies whether this EventTopic is active.
`void`	`postCommitEventAction(EventMessage msg)` The action is taken after commiting to the database on all subscriptions that returned successful validate.
`void`	`postSaveInternalEventAction(EventMessage msg)` The action is taken after writing to the database on all subscriptions The action is called only if there was no vetoable exception.
`void`	`preSaveEventAction(EventMessage msg)` The action is taken before writing to the database on all subscriptions that returned successful validate.
`void`	`preSaveInternalEventAction(EventMessage msg)` The action is taken before writing to the database on all subscriptions that returned successful validate.
`void`	`setActive(boolean value)` Used by `AdminModeManager` to activate and inactivate the EventTopic.
`void`	`setExtendedSubIds(java.util.Map idMap)`
`void`	`setTree(EventTopicTree tree)`

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

- Field Detail
  - subject
```
protected java.lang.String subject
```
- Constructor Detail
  - EventTopic
```
public EventTopic(java.lang.String subject)
```
- Method Detail
  - setTree
```
public void setTree(EventTopicTree tree)
```
  - setExtendedSubIds
```
public void setExtendedSubIds(java.util.Map idMap)
```
  - getExtendedSubIds
```
public java.util.Map getExtendedSubIds()
```
  - getTree
```
public EventTopicTree getTree()
```
  - getSubject
```
public java.lang.String getSubject()
```
    Returns event topic name.
  - getSubTopicTree
```
public EventTopicTree getSubTopicTree()
```
    Returns the sub topic tree from this node.
  - setActive
```
public void setActive(boolean value)
```
    Used by AdminModeManager to activate and inactivate the EventTopic.
    
    Parameters:
    
    value - True to set Active, False to set Inactive.
  - isActive
```
public boolean isActive()
```
    Identifies whether this EventTopic is active.
    
    Returns:
    
    Value of isActive
  - eventValidate
```
public void eventValidate(EventMessage msg)
                   throws MXException
```
    Runs through all the subscriptons to see if there are any vetoable exceptions. If any subscription throws vetoable exceptions, then the transaction is rolled back, if there are none, then the action is done on all the successfully evaluated subscriptions.
    
    Throws:
    
    MXException
  - eventAction
```
public void eventAction(EventMessage msg)
                 throws MXException
```
    action is taken on all subscriptions that returned validate. The action is called only if there was no vetoable exception.
    
    Throws:
    
    MXException
  - preSaveEventAction
```
public void preSaveEventAction(EventMessage msg)
                        throws MXException
```
    The action is taken before writing to the database on all subscriptions that returned successful validate. The action is called only if there was no vetoable exception.
    
    Throws:
    
    MXException
  - preSaveInternalEventAction
```
public void preSaveInternalEventAction(EventMessage msg)
                                throws MXException
```
    The action is taken before writing to the database on all subscriptions that returned successful validate. The action is called only if there was no vetoable exception.
    
    Throws:
    
    MXException
  - postSaveInternalEventAction
```
public void postSaveInternalEventAction(EventMessage msg)
                                 throws MXException
```
    The action is taken after writing to the database on all subscriptions The action is called only if there was no vetoable exception.
    
    Throws:
    
    MXException
  - postCommitEventAction
```
public void postCommitEventAction(EventMessage msg)
                           throws MXException
```
    The action is taken after commiting to the database on all subscriptions that returned successful validate. If the transaction reaches to commit stage, all the listeners of the event will be fired, disregard whether the validation has been successful for the listener. The listerner is responsible to remember the validate result if needed.
    
    Throws:
    
    MXException
  - addSubTopic
```
public void addSubTopic(EventTopic ev)
                 throws MXException
```
    Add subtopic tree to the event node.
    
    Throws:
    
    MXException
  - getEventTopic
```
public EventTopic getEventTopic(java.lang.String subject)
                         throws MXException
```
    getEventTopic searches the whole event topic tree for an eventTopic. If found returns the EventTopic, if not returns null.
    
    Throws:
    
    MXException
  - getListeners
```
public java.util.Map getListeners()
```
  - getListenerCount
```
public int getListenerCount()
```
  - getSubscriptionId
```
public int getSubscriptionId(EventListener evt)
```
    Returns the subscription id for the event listener object.
    
    Parameters:
    
    EventListener - evt - The listener class that was registered.
    
    Returns:
    
    id of the class or -1 if not found.
  - getSubscriptionIdByClassName
```
public int getSubscriptionIdByClassName(EventListener evt)
```
    Returns the subscription id for the event listener class.
    
    Parameters:
    
    EventListener - evt - The listener class that was registered.
    
    Returns:
    
    id of the class or -1 if not found.
  - dumpTopic
```
public java.util.Map dumpTopic()
                        throws MXException
```
    Throws:
    
    MXException

Fields inherited from interface psdi.util.logging.FixedLoggers

Fields inherited from interface psdi.util.logging.FixedLoggerNames

Methods inherited from class java.lang.Object

subject

EventTopic

setTree

setExtendedSubIds

getExtendedSubIds

getTree

getSubject

getSubTopicTree

setActive

isActive

eventValidate

eventAction

preSaveEventAction

preSaveInternalEventAction

postSaveInternalEventAction

postCommitEventAction

addSubTopic

getEventTopic

getListeners

getListenerCount

getSubscriptionId

getSubscriptionIdByClassName

dumpTopic