public class EventManagerProxy extends AdministeredObject
This object is for Event definition Administration. It provides query functionality for event definitions.
In order to use the EventManagerProxy object, applications must first obtain a handle to it. Here is an example of how to do this:
BrokerProxy b = BrokerProxy.getInstance( new IntegrationNodeConnectionParameters("localhost", 4414)); EventManagerProxy wa = b.getEventManagerProxy();
com.ibm.broker.config.proxy.EventProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Represents Events and allows settings to be queried. |
Internal Collaborators |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------
Modifier and Type | Method and Description |
---|---|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject type.
|
EventProxy |
getEvent(java.util.Properties props)
Returns the first EventProxy object that matches the
filter specified by the Properties argument.
|
EventProxy |
getEventByName(java.lang.String eventName)
Returns the EventProxy object with the supplied name, or null
if an event of that name does not exist or if the supplied
argument was null.
|
EventProxy |
getEventByURI(java.lang.String eventURI)
Returns the EventProxy object with the supplied URI, or null
if an event with that URI does not exist or if the supplied
argument was null.
|
java.util.Enumeration<EventProxy> |
getEvents()
Returns an enumeration of all the EventProxy objects
|
java.util.Enumeration<EventProxy> |
getEvents(java.util.Properties props)
Returns an enumeration of all the EventProxy objects that
match the filter specified by the Properties argument.
|
java.util.Enumeration<EventProxy> |
getEventsPublishedByIdentifier(java.lang.String publisherIdentifier)
Returns an enumeration of all the EventProxy objects that
are published by the specified publishers identifier
|
java.util.Enumeration<EventProxy> |
getEventsPublishedByIdentifier(java.lang.String publisherIdentifier,
java.util.Properties props)
Returns an enumeration of all the EventProxy objects that
are published by the specified publishers identifier
|
java.util.Enumeration<EventProxy> |
getEventsPublishedByURI(java.lang.String publisherURI)
Returns an enumeration of all the EventProxy objects that
are published by the specified publishers URI
|
java.util.Enumeration<EventProxy> |
getEventsPublishedByURI(java.lang.String publisherURI,
java.util.Properties props)
Returns an enumeration of all the EventProxy objects that
are published by the specified publishers URI
|
java.util.Enumeration<EventProxy> |
getEventsPublishedByUUID(java.lang.String publisherUUID)
Returns an enumeration of all the EventProxy objects that
are published by the specified publishers UUID
|
java.util.Enumeration<EventProxy> |
getEventsPublishedByUUID(java.lang.String publisherUUID,
java.util.Properties props)
Returns an enumeration of all the EventProxy objects that
are published by the specified publishers UUID
|
void |
setLongDescription(java.lang.String desc)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
void |
setName(java.lang.String name)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
void |
setShortDescription(java.lang.String desc)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
deregisterListener, deregisterListener, elements, equals, getAdvancedProperties, getBasicProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperty, getProperty, getProperty, getProperty, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, setProperties, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID
public ConfigurationObjectType getConfigurationObjectType()
AdministeredObject
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
AdministeredObject
getConfigurationObjectTypeOfParent
in class AdministeredObject
public java.util.Enumeration<EventProxy> getEvents() throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the EventProxy objects
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<EventProxy> getEventsPublishedByUUID(java.lang.String publisherUUID) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the EventProxy objects that are published by the specified publishers UUID
publisherUUID
- The UUID of the publisherConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<EventProxy> getEventsPublishedByURI(java.lang.String publisherURI) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the EventProxy objects that are published by the specified publishers URI
publisherURI
- The URI of the publisherConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<EventProxy> getEventsPublishedByIdentifier(java.lang.String publisherIdentifier) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the EventProxy objects that are published by the specified publishers identifier
publisherIdentifier
- The identifier of the publisherConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<EventProxy> getEventsPublishedByUUID(java.lang.String publisherUUID, java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the EventProxy objects that are published by the specified publishers UUID
publisherUUID
- The UUID of the publisherprops
- Filter to select the EventProxy to return.
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match all events defined to this
broker.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<EventProxy> getEventsPublishedByURI(java.lang.String publisherURI, java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the EventProxy objects that are published by the specified publishers URI
publisherURI
- The URI of the publisherprops
- Filter to select the EventProxy to return.
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match all events defined to this
broker.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<EventProxy> getEventsPublishedByIdentifier(java.lang.String publisherIdentifier, java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the EventProxy objects that are published by the specified publishers identifier
publisherIdentifier
- The identifier of the publisherprops
- Filter to select the EventProxy to return.
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match all events defined to this
broker.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<EventProxy> getEvents(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the EventProxy objects that match the filter specified by the Properties argument.
props
- Filter to select the EventProxy to return.
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match all events defined to this
broker.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public EventProxy getEvent(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns the first EventProxy object that matches the filter specified by the Properties argument. This method is an EventProxy-specific wrapper to AdministeredObject.getManagedSubcomponent(Properties). Consider using getEventByName(String) to return an event by name.
props
- Filter to select the EcentProxy to return.
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match all execution groups of this
broker.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.AdministeredObject.getManagedSubcomponent(Properties)
public EventProxy getEventByURI(java.lang.String eventURI) throws ConfigManagerProxyPropertyNotInitializedException
eventURI
- URI of the eventConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public EventProxy getEventByName(java.lang.String eventName) throws ConfigManagerProxyPropertyNotInitializedException
eventName
- Name of the eventConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setName(java.lang.String name) throws ConfigManagerProxyLoggedException
setName
in class AdministeredObject
name
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public void setShortDescription(java.lang.String desc) throws ConfigManagerProxyLoggedException
setShortDescription
in class AdministeredObject
desc
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public void setLongDescription(java.lang.String desc) throws ConfigManagerProxyLoggedException
setLongDescription
in class AdministeredObject
desc
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.