com.ibm.broker.config.proxy

Class EventManagerProxy



  • 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:
     -------- ----------- -------------   ------------------------------------
    
     
    • Method Detail

      • getConfigurationObjectType

        public ConfigurationObjectType getConfigurationObjectType()
        Description copied from class: AdministeredObject
        Returns the ConfigurationObjectType associated with this AdministeredObject type. For example, for ExecutionGroupProxy, ConfigurationObjectType.executiongroup is returned.
        Specified by:
        getConfigurationObjectType in class AdministeredObject
        Returns:
        ConfigurationObjectType associated with this class.
      • getConfigurationObjectTypeOfParent

        public ConfigurationObjectType getConfigurationObjectTypeOfParent()
        Description copied from class: AdministeredObject
        Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type. For example, for ExecutionGroupProxy, ConfigurationObjectType.broker is returned.
        Specified by:
        getConfigurationObjectTypeOfParent in class AdministeredObject
        Returns:
        ConfigurationObjectType associated with this class.
      • getEventsPublishedByUUID

        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

        Parameters:
        publisherUUID - The UUID of the publisher
        Returns:
        Enumeration The EventProxy objects
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getEventsPublishedByURI

        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

        Parameters:
        publisherURI - The URI of the publisher
        Returns:
        Enumeration The EventProxy objects
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getEventsPublishedByIdentifier

        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

        Parameters:
        publisherIdentifier - The identifier of the publisher
        Returns:
        Enumeration The EventProxy objects
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getEventsPublishedByUUID

        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

        Parameters:
        publisherUUID - The UUID of the publisher
        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.
        Returns:
        Enumeration The EventProxy objects
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getEventsPublishedByURI

        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

        Parameters:
        publisherURI - The URI of the publisher
        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.
        Returns:
        Enumeration The EventProxy objects
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getEventsPublishedByIdentifier

        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

        Parameters:
        publisherIdentifier - The identifier of the publisher
        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.
        Returns:
        Enumeration The EventProxy objects
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getEvents

        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.

        Parameters:
        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.
        Returns:
        Enumeration The EventProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getEvent

        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.

        Parameters:
        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.
        Returns:
        EventProxy The first object that matched the supplied filter, or null if nothing matched the filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AdministeredObject.getManagedSubcomponent(Properties)
      • getEventByURI

        public EventProxy getEventByURI(java.lang.String eventURI)
                                 throws ConfigManagerProxyPropertyNotInitializedException
        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.
        Parameters:
        eventURI - URI of the event
        Returns:
        EventProxy object representing the requested event.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getEventByName

        public EventProxy getEventByName(java.lang.String eventName)
                                  throws ConfigManagerProxyPropertyNotInitializedException
        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.
        Parameters:
        eventName - Name of the event
        Returns:
        EventProxy object representing the requested event.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • setName

        public void setName(java.lang.String name)
                     throws ConfigManagerProxyLoggedException
        This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the name of the event manager.
        Overrides:
        setName in class AdministeredObject
        Parameters:
        name - (this is ignored)
        Throws:
        ConfigManagerProxyLoggedException - to indicate this method should not be called.