2008-09-10 1.1.0

org.eclipse.soda.dk.notification.client
Class NotificationController

java.lang.Object
  extended by org.eclipse.soda.dk.notification.client.NotificationController
All Implemented Interfaces:
NotificationListener, NotificationService

public class NotificationController
extends java.lang.Object
implements NotificationService, NotificationListener

Version:
1.1.0

Field Summary
protected  char idSparator
          Define the id separator (char) field.
 
Fields inherited from interface org.eclipse.soda.dk.notification.service.NotificationService
BROADCAST_THRESHOLD_KEY, BUNDLE_DATA_KEY, Capabilities, CAPABILITIES_EXTERNAL_KEY, CAPABILITIES_GET_EXTERNAL_KEY, CAPABILITIES_READ_EXTERNAL_KEY, Configuration, CONFIGURATION_DATA_KEY, CONFIGURATION_EXTERNAL_KEY, CONFIGURATION_GET_EXTERNAL_KEY, CONFIGURATION_READ_EXTERNAL_KEY, ERROR_EXTERNAL_KEY, EVENT_DATA_KEY, EXCEPTION_DATA_KEY, EXECUTE_EXTERNAL_KEY, FACTORY_SERVICE_NAME, GET_EXTERNAL_KEY, ID_DATA_KEY, LEVEL_DATA_KEY, LEVEL_DEFAULT, LEVEL_EXTENSION, LEVEL_KEY, LEVEL_MAXIMUM, LEVEL_MAXIMUM_KEY, LEVEL_MINIMUM, LEVEL_MINIMUM_KEY, LEVEL_MONITOR, MESSAGE_DATA_KEY, Metrics, METRICS_EXTERNAL_KEY, METRICS_GET_EXTERNAL_KEY, NOTIFICATION_HOST_DATA_KEY, NOTIFICATION_ID_DATA_KEY, NOTIFICATION_TIMESTAMP_DATA_KEY, NOTIFY_THRESHOLD_KEY, READ_EXTERNAL_KEY, RECEIVED_EVENT_DATA_KEY, RECEIVED_ID_DATA_KEY, SERVICE_NAME, SET_EXTERNAL_KEY, Status, STATUS_EXTERNAL_KEY, STATUS_GET_EXTERNAL_KEY, STATUS_READ_EXTERNAL_KEY, TIMESTAMP_DATA_KEY, TOPIC_DELIMITER, TOPIC_DELIMITER_STRING, TOPIC_WILDCARD, TOPIC_WILDCARD_STRING, TRIGGER_EXTERNAL_KEY, VALUE_DATA_KEY, VALUE_OLD_DATA_KEY, WRITE_EXTERNAL_KEY
 
Constructor Summary
NotificationController()
          Constructs an instance of this class.
NotificationController(NotificationService notificationService, NotificationClient container)
           
 
Method Summary
 void broadcast(java.lang.String externalKey, java.util.Dictionary data)
           
 java.lang.String getId()
          Gets the id (String) value.
 NotificationClient getNotificationClient()
          Gets the notification client value.
 NotificationService getNotificationService()
          Gets the notification service value.
 void notificationReceived(java.lang.String externalKey, java.util.Dictionary data)
           
protected  void notificationServiceAdded()
          Notification service added.
protected  void notificationServiceRemoving()
          Notification service removing.
 void register(java.lang.String externalKey)
           
 void register(java.lang.String[] externalKeys)
           
 void register(java.lang.String[] externalKeys, NotificationListener listener)
          Register with the specified externalKeys and listener parameters.
 void register(java.lang.String externalKey, NotificationListener listener)
          Register with the specified externalKey and listener parameters.
protected  void removeQualifiedKeys()
          Remove qualified keys.
 void setId(java.lang.String id)
           
 void setNotificationClient(NotificationClient container)
           
 void setNotificationService(NotificationService notificationService)
           
 java.lang.String toString()
          Returns the string value.
 void unregister()
          Unregister.
 void unregister(NotificationListener listener)
          Unregister with the specified listener parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

idSparator

protected char idSparator
Define the id separator (char) field.

Constructor Detail

NotificationController

public NotificationController()
Constructs an instance of this class.

See Also:
NotificationController(NotificationService,NotificationClient)

NotificationController

public NotificationController(NotificationService notificationService,
                              NotificationClient container)
Parameters:
notificationService - The notification service (NotificationService) parameter.
container - The container (NotificationClient) parameter.
See Also:
NotificationController()
Method Detail

broadcast

public void broadcast(java.lang.String externalKey,
                      java.util.Dictionary data)
Specified by:
broadcast in interface NotificationService
Parameters:
externalKey - The external key (String) parameter.
data - The data (Dictionary) parameter.

getId

public java.lang.String getId()
Gets the id (String) value.

Returns:
The id (String) value.
See Also:
setId(String)

getNotificationClient

public NotificationClient getNotificationClient()
Gets the notification client value.

Returns:
The notification client (NotificationClient) value.
See Also:
setNotificationClient(NotificationClient)

getNotificationService

public NotificationService getNotificationService()
Gets the notification service value.

Returns:
The notification service (NotificationService) value.
See Also:
setNotificationService(NotificationService)

notificationReceived

public void notificationReceived(java.lang.String externalKey,
                                 java.util.Dictionary data)
Specified by:
notificationReceived in interface NotificationListener
Parameters:
externalKey - The external key (String) parameter.
data - The data (Dictionary) parameter.

notificationServiceAdded

protected void notificationServiceAdded()
Notification service added.


notificationServiceRemoving

protected void notificationServiceRemoving()
Notification service removing.


register

public void register(java.lang.String externalKey)
Parameters:
externalKey - The external key (String) parameter.
See Also:
register(String,NotificationListener), register(String[]), register(String[],NotificationListener)

register

public void register(java.lang.String externalKey,
                     NotificationListener listener)
Description copied from interface: NotificationService
Register with the specified externalKey and listener parameters. The externalKey (String) parameter. The listener (NotificationListener) parameter.

Specified by:
register in interface NotificationService
Parameters:
externalKey - The external key (String) parameter.
listener - The listener (NotificationListener) parameter.
See Also:
register(String), register(String[]), register(String[],NotificationListener)

register

public void register(java.lang.String[] externalKeys)
Parameters:
externalKeys - The external keys (String[]) parameter.
See Also:
register(String), register(String,NotificationListener), register(String[],NotificationListener)

register

public void register(java.lang.String[] externalKeys,
                     NotificationListener listener)
Description copied from interface: NotificationService
Register with the specified externalKeys and listener parameters. The externalKeys (String[]) parameter. The listener (NotificationListener) parameter.

Specified by:
register in interface NotificationService
Parameters:
externalKeys - The external keys (String[]) parameter.
listener - The listener (NotificationListener) parameter.
See Also:
register(String), register(String,NotificationListener), register(String[])

removeQualifiedKeys

protected void removeQualifiedKeys()
Remove qualified keys.


setId

public void setId(java.lang.String id)
Parameters:
id - The id (String) parameter.
See Also:
getId()

setNotificationClient

public void setNotificationClient(NotificationClient container)
Parameters:
container - The container (NotificationClient) parameter.
See Also:
getNotificationClient()

setNotificationService

public void setNotificationService(NotificationService notificationService)
Parameters:
notificationService - The notification service (NotificationService) parameter.
See Also:
getNotificationService()

toString

public java.lang.String toString()
Returns the string value.

Overrides:
toString in class java.lang.Object
Returns:
The string (String) value.

unregister

public void unregister()
Unregister.

See Also:
unregister(NotificationListener)

unregister

public void unregister(NotificationListener listener)
Description copied from interface: NotificationService
Unregister with the specified listener parameter. The listener (NotificationListener) parameter.

Specified by:
unregister in interface NotificationService
Parameters:
listener - The listener (NotificationListener) parameter.
See Also:
unregister()

2008-09-10 1.1.0

Copyright (c) 1999, 2008 IBM and others. See license in Legal section. OSGi Framework Version 3.4.0.v20080605-1900