com.wily.introscope.client.alerts.interfaces
Interface IIntroscopeClientRegisterer


public interface IIntroscopeClientRegisterer

This interface provides the ability to add/remove the IIntroscopeClient objects. An IIntroscopeClient object maps to an Enterprise Manager Connection. It also provides the following functionalities: -Pause Subscription for a list of given topics for an EM Connection. -Resume Subscription for a list of topics for an EM Connection. -Add/remove Consumers for the Webservice for alert related inventory updates. -Add/remove Consumers for the Webservice for alert related status updates. -Exposes functionalities for Metric/Event consumers to be added that can be implemented as the need arises. -Add/Remove Introscope life cycle event listeners.


Method Summary
 void addAlertInventoryUpdatesConsumer(IAlertInventoryUpdatesConsumer consumer)
          SDK user can call this method to add a consumer interested in receiving Alert Inventory Updates for all registered Introscope EMs.
 void addAlertStatusUpdatesConsumer(IAlertStatusUpdatesConsumer consumer)
          SDK user can call this method to add a consumer interested in receiving Alert Status Updates for all registered Introscope EMs.
 void addIntroscopeClient(IIntroscopeClient iscopeClient)
          This method needs to be called by the SDK user after creating an instance of IIntroscopeClient.
 void addIscopeLifeCycleListener(IIntroscopeLifecycleListener listener)
          SDK user can call this method to add a listener interested in receiving EM lifecycle events (start/stop/heartbeat) for all registered Introscope EMs.
 void pauseSubscription(IIntroscopeClient iscopeClient, IIntroscopeTopic[] topics)
          SDK user can call this method to pause subscription for specified topics on the Introscope EM referred to by the iscopeClient object.
 void removeAlertInventoryUpdatesConsumer(IAlertInventoryUpdatesConsumer consumer)
          SDK user can call this method to remove a listener listening for changes in Alert Definition Inventory Updates.
 void removeAlertStatusUpdatesConsumer(IAlertStatusUpdatesConsumer listener)
          Method to remove a listener listening for changes in Alert Status Updates.
 void removeIntroscopeClient(IIntroscopeClient iscopeClient)
          This method needs to be called by the SDK user after a particular IIntroscopeClient is destroyed or no longer needed.
 void removeIscopeLifeCycleListener(IIntroscopeLifecycleListener listener)
          SDK user can call this method to remove a registered listener.
 void resumeSubscription(IIntroscopeClient iscopeClient, IIntroscopeTopic[] topics)
          SDK user can call this method to resume subscription for specified topics on the Introscope EM referred to by the iscopeClient object.
 void setConsumerSpecifier(IConsumerSpecifier specifier)
          This method needs to be called by the SDK user only once after the TOMCAT starts up.
 

Method Detail

setConsumerSpecifier

void setConsumerSpecifier(IConsumerSpecifier specifier)
This method needs to be called by the SDK user only once after the TOMCAT starts up. This will register the consumer host/port and magic key information provided, so that notifications can be received by the TOMCAT where the SDk web application is running

Parameters:
specifier -

addIntroscopeClient

void addIntroscopeClient(IIntroscopeClient iscopeClient)
                         throws java.lang.Exception
This method needs to be called by the SDK user after creating an instance of IIntroscopeClient. This will register this client with EM, to receive all the (inventory and status) updates and lifecycle events.

Parameters:
iscopeClient -
Throws:
java.lang.Exception

removeIntroscopeClient

void removeIntroscopeClient(IIntroscopeClient iscopeClient)
                            throws java.lang.Exception
This method needs to be called by the SDK user after a particular IIntroscopeClient is destroyed or no longer needed. This will de-register the client from the EM. The listeners will stop getting updates and lifecycle events for this EM. The IIntroscopeClient will be garbage collected, if there are no other references in the JVM.

Parameters:
iscopeClient -
Throws:
java.lang.Exception

pauseSubscription

void pauseSubscription(IIntroscopeClient iscopeClient,
                       IIntroscopeTopic[] topics)
                       throws java.lang.Exception
SDK user can call this method to pause subscription for specified topics on the Introscope EM referred to by the iscopeClient object.

Parameters:
iscopeClient -
topics -
Throws:
java.lang.Exception

resumeSubscription

void resumeSubscription(IIntroscopeClient iscopeClient,
                        IIntroscopeTopic[] topics)
                        throws java.lang.Exception
SDK user can call this method to resume subscription for specified topics on the Introscope EM referred to by the iscopeClient object.

Parameters:
iscopeClient -
topics -
Throws:
java.lang.Exception

addIscopeLifeCycleListener

void addIscopeLifeCycleListener(IIntroscopeLifecycleListener listener)
SDK user can call this method to add a listener interested in receiving EM lifecycle events (start/stop/heartbeat) for all registered Introscope EMs.

Parameters:
listener -

removeIscopeLifeCycleListener

void removeIscopeLifeCycleListener(IIntroscopeLifecycleListener listener)
SDK user can call this method to remove a registered listener.

Parameters:
listener -

addAlertInventoryUpdatesConsumer

void addAlertInventoryUpdatesConsumer(IAlertInventoryUpdatesConsumer consumer)
SDK user can call this method to add a consumer interested in receiving Alert Inventory Updates for all registered Introscope EMs.

Parameters:
consumer -

removeAlertInventoryUpdatesConsumer

void removeAlertInventoryUpdatesConsumer(IAlertInventoryUpdatesConsumer consumer)
SDK user can call this method to remove a listener listening for changes in Alert Definition Inventory Updates.

Parameters:
consumer -

addAlertStatusUpdatesConsumer

void addAlertStatusUpdatesConsumer(IAlertStatusUpdatesConsumer consumer)
SDK user can call this method to add a consumer interested in receiving Alert Status Updates for all registered Introscope EMs.

Parameters:
consumer -

removeAlertStatusUpdatesConsumer

void removeAlertStatusUpdatesConsumer(IAlertStatusUpdatesConsumer listener)
Method to remove a listener listening for changes in Alert Status Updates.

Parameters:
listener -


Copyright © 2007 CA Inc. All Rights Reserved.