public class EventProxy extends AdministeredObject
This object represents an event definition. It provides query functionality for the contents of an event definition.
In order to use the EventProxy 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)); EventProxyManager epm = b.getEventManager(); EventProxy ep = epm.getEvent("eventName");
com.ibm.broker.config.proxy.EventProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Represents a single event definition. |
Internal Collaborators |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------
Modifier and Type | Class and Description |
---|---|
class |
EventProxy.DataLocation
A small class that represents a data location for an event.
|
class |
EventProxy.Publisher
A small class that represents a publisher for an event.
|
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.
|
java.lang.String |
getEventName()
Returns the name of this event
|
java.lang.String |
getEventSource()
Returns the source of this event.
|
java.lang.String |
getEventSourceAddress()
Returns the event source address of this event
|
java.lang.String |
getEventType()
Returns the type associated with this event
|
java.lang.String |
getEventURI()
Returns the URI of this event
|
java.lang.String |
getFilter()
Returns the filter for this event
|
java.lang.String |
getGlobalTransactionCorrelator()
Returns the global transaction correlator of this event.
|
java.lang.String |
getLocalTransactionCorrelator()
Returns the local transaction correlator of this event.
|
int |
getNumberOfActivePublishers()
Returns the number of publishers that are actively publishing
this event
|
int |
getNumberOfPublishers()
Returns the number of publishers that publish this event
|
java.lang.String |
getParentTransactionCorrelator()
Returns the parent transaction correlator of this event.
|
java.lang.String |
getPayloadBitstreamContentEncodingType()
Returns the bitstream content encoding type that is included
in the payload
|
java.lang.String |
getPayloadBitstreamContentType()
Returns the bitstream content type that is included in the
payload
|
java.util.Enumeration<EventProxy.DataLocation> |
getPayloadDataLocations()
Returns an enumeration of all the data locations that have
been defined to the monitoring event
|
java.lang.String |
getProfileName()
Returns the profile name associated with this event
|
java.lang.String |
getProfileVersion()
Returns the profile name associated with this event
|
EventProxy.Publisher |
getPublisherByURI(java.lang.String uri,
boolean activeOnly)
Returns the publisher object with the specified URI, or null
if a publisher with that URI does not exist for this event or
if the supplied argument was null.
|
java.util.Enumeration<EventProxy.Publisher> |
getPublishers(boolean activeOnly)
Returns an enumeration of all the publishers that can publish
this event.
|
java.lang.String |
getUnitOfWork()
Returns the unit of work type of this event
|
boolean |
hasPublisherWithIdentifier(java.lang.String publisherIdentifier)
Returns true only if event has a publisher with specified
UUID
|
boolean |
hasPublisherWithURI(java.lang.String publisherURI)
Returns true only if event has a publisher with specified URI
|
boolean |
hasPublisherWithUUID(java.lang.String publisherUUID)
Returns true only if event has a publisher with specified
UUID
|
boolean |
isBitstreamDataIncludedInPayload()
Returns true only if the bitstream data will be included in
the payload.
|
boolean |
isEnabled()
Returns true only if the event is enabled.
|
boolean |
isTransactionEvent()
Returns true only if the event is a transaction event.
|
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.lang.String getEventType() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getProfileName() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getProfileVersion() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public boolean isEnabled() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public boolean isTransactionEvent() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public boolean isBitstreamDataIncludedInPayload() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getEventSourceAddress() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getEventSource() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getPayloadBitstreamContentType() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getPayloadBitstreamContentEncodingType() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getUnitOfWork() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getEventName() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getEventURI() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getFilter() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getLocalTransactionCorrelator() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getParentTransactionCorrelator() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.util.Enumeration<EventProxy.DataLocation> getPayloadDataLocations() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.lang.String getGlobalTransactionCorrelator() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public int getNumberOfPublishers() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public boolean hasPublisherWithURI(java.lang.String publisherURI) throws ConfigManagerProxyPropertyNotInitializedException
publisherURI
- The URI of the publisherConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public boolean hasPublisherWithUUID(java.lang.String publisherUUID) throws ConfigManagerProxyPropertyNotInitializedException
publisherUUID
- The UUID of the publisherConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public boolean hasPublisherWithIdentifier(java.lang.String publisherIdentifier) throws ConfigManagerProxyPropertyNotInitializedException
publisherIdentifier
- The identifier of the publisherConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public int getNumberOfActivePublishers() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public EventProxy.Publisher getPublisherByURI(java.lang.String uri, boolean activeOnly) throws ConfigManagerProxyPropertyNotInitializedException
uri
- the URI of the publisher to return.activeOnly
- true if only active publishers are to be
returned.ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.public java.util.Enumeration<EventProxy.Publisher> getPublishers(boolean activeOnly) throws ConfigManagerProxyPropertyNotInitializedException
activeOnly
- true if only active publishers are to be
returned.ConfigManagerProxyPropertyNotInitializedException
- if the property could not be determined because the broker
has not yet supplied the relevant information.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.