2008-07-29 1.1.0

org.eclipse.soda.dk.notification.event.admin
Class NotificationEventAdmin

java.lang.Object
  extended by org.eclipse.soda.dk.core.EscObject
      extended by org.eclipse.soda.dk.core.ConfigurableObject
          extended by org.eclipse.soda.dk.notification.NotificationResourceBase
              extended by org.eclipse.soda.dk.notification.NotificationBase
                  extended by org.eclipse.soda.dk.notification.event.admin.NotificationEventAdmin
All Implemented Interfaces:
ConfigurableService, NotificationExtendableService, NotificationService

public class NotificationEventAdmin
extends org.eclipse.soda.dk.notification.NotificationBase
implements NotificationExtendableService

Version:
1.1.0

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.soda.dk.notification.NotificationResourceBase
org.eclipse.soda.dk.notification.NotificationResourceBase.ConfigurationInformationProxy
 
Field Summary
protected  org.osgi.framework.BundleContext bundleContext
          Define the bundle context (BundleContext) field.
protected  org.osgi.service.event.EventAdmin eventAdmin
          Define the event administration (EventAdmin) field.
protected  java.util.Map notificationListeners
          Define the notification listener (NotificationListener) field.
 
Fields inherited from class org.eclipse.soda.dk.notification.NotificationBase
broadcastCount, broadcastThreshold, broadcastThresholdCount, BroadcastThresholdDefault, level, levelMaximum, levelMinimum, notificationExtension, NotificationHost, NotificationId, notificationMonitor, notifyCount, notifyThreshold, notifyThresholdCount, NotifyThresholdDefault, prefixStatus
 
Fields inherited from class org.eclipse.soda.dk.notification.NotificationResourceBase
DefaultResourceBundle, NOTIFICATION_BROADCAST_EXCEEDED_RESOURCE, NOTIFICATION_BROADCAST_THRESHOLD_DEFAULT, NOTIFICATION_BROADCAST_THRESHOLD_KEY, NOTIFICATION_NOTIFY_EXCEEDED_RESOURCE, NOTIFICATION_NOTIFY_THRESHOLD_DEFAULT, NOTIFICATION_NOTIFY_THRESHOLD_KEY, NOTIFICATION_START_RESOURCE, NOTIFICATION_STOP_RESOURCE
 
Fields inherited from class org.eclipse.soda.dk.core.ConfigurableObject
BUNDLE_VERSION_PROPERTY
 
Fields inherited from class org.eclipse.soda.dk.core.EscObject
CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, ID_NAME_KEY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_DEFAULT, LOG_ERROR, LOG_INFO, LOG_LEVEL_KEY, LOG_TRACE, LOG_WARNING, LONG_TABLE, LONG_TABLE_SIZE, PREFIX_KEY, READONLY_EMPTY_COLLECTION, READONLY_EMPTY_LIST, READONLY_EMPTY_MAP, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE
 
Fields inherited from interface org.eclipse.soda.dk.notification.service.NotificationExtendableService
SERVICE_NAME
 
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, 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
NotificationEventAdmin()
          Constructs an instance of this class.
 
Method Summary
 void broadcast(java.lang.String externalKey, java.util.Dictionary data)
           
 org.osgi.framework.BundleContext getBundleContext()
          Gets the bundle context value.
 org.osgi.service.event.EventAdmin getEventAdmin()
          Gets the event administration value.
 NotificationExtensionService getNotificationExtension()
          Gets the notification extension (NotificationExtensionService) value.
 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.
 void setBundleContext(org.osgi.framework.BundleContext bundleContext)
           
 void setEventAdmin(org.osgi.service.event.EventAdmin eventAdmin)
           
 void setNotificationExtension(NotificationExtensionService notificationExtension)
          Sets the notification extension value.
 void unregister(NotificationListener listener)
          Unregister with the specified listener parameter.
 
Methods inherited from class org.eclipse.soda.dk.notification.NotificationBase
addNotificationExtension, addNotificationMonitor, broadcastStatus, exit, getBroadcastThreshold, getBroadcastThresholdDefault, getConfigurationInformation, getHost, getLevel, getLevelMaximum, getLevelMinimum, getNotificationMonitor, getNotifyThreshold, getNotifyThresholdDefault, getResource, getStatusInfo, putConfigurationInformation, removeNotificationExtension, removeNotificationMonitor, setBroadcastThreshold, setBroadcastThresholdDefault, setConfigurationInformation, setLevel, setLevelMaximum, setLevelMinimum, setNotificationMonitor, setNotifyThreshold, setNotifyThresholdDefault, setup, start, updateConfiguration, updateConfiguration
 
Methods inherited from class org.eclipse.soda.dk.notification.NotificationResourceBase
getErrorSeverity, getLogDetails2
 
Methods inherited from class org.eclipse.soda.dk.core.ConfigurableObject
createPropertiesFromHeaders, getConfigurationService, setConfigurationService, validateConfiguration
 
Methods inherited from class org.eclipse.soda.dk.core.EscObject
attemptRecoveryFromError, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isDebug, isLogging, isTrace, loadService, log, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys, toStringInfo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.soda.dk.notification.service.NotificationExtendableService
addNotificationExtension, addNotificationMonitor, getNotificationMonitor, removeNotificationExtension, removeNotificationMonitor, setNotificationMonitor
 

Field Detail

eventAdmin

protected org.osgi.service.event.EventAdmin eventAdmin
Define the event administration (EventAdmin) field.


bundleContext

protected org.osgi.framework.BundleContext bundleContext
Define the bundle context (BundleContext) field.


notificationListeners

protected java.util.Map notificationListeners
Define the notification listener (NotificationListener) field.

Constructor Detail

NotificationEventAdmin

public NotificationEventAdmin()
Constructs an instance of this class.

Method Detail

broadcast

public void broadcast(java.lang.String externalKey,
                      java.util.Dictionary data)
Specified by:
broadcast in interface NotificationService
Overrides:
broadcast in class org.eclipse.soda.dk.notification.NotificationBase
Parameters:
externalKey - The external key (String) parameter.
data - The data (Dictionary) parameter.

getBundleContext

public org.osgi.framework.BundleContext getBundleContext()
Gets the bundle context value.

Returns:
The bundle context (BundleContext) value.
See Also:
setBundleContext(BundleContext)

getEventAdmin

public org.osgi.service.event.EventAdmin getEventAdmin()
Gets the event administration value.

Returns:
The event administration (EventAdmin) value.
See Also:
NotificationEventAdmin(), setEventAdmin(EventAdmin)

getNotificationExtension

public NotificationExtensionService getNotificationExtension()
Gets the notification extension (NotificationExtensionService) value.

Specified by:
getNotificationExtension in interface NotificationExtendableService
Overrides:
getNotificationExtension in class org.eclipse.soda.dk.notification.NotificationBase
Returns:
The notification extension (NotificationExtensionService) value.
See Also:
setNotificationExtension(NotificationExtensionService)

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[],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,NotificationListener)

setBundleContext

public void setBundleContext(org.osgi.framework.BundleContext bundleContext)
Parameters:
bundleContext - The bundle context (BundleContext) parameter.
See Also:
getBundleContext()

setEventAdmin

public void setEventAdmin(org.osgi.service.event.EventAdmin eventAdmin)
Parameters:
eventAdmin - The event administration (EventAdmin) parameter.
See Also:
NotificationEventAdmin(), getEventAdmin()

setNotificationExtension

public void setNotificationExtension(NotificationExtensionService notificationExtension)
Sets the notification extension value.

Specified by:
setNotificationExtension in interface NotificationExtendableService
Overrides:
setNotificationExtension in class org.eclipse.soda.dk.notification.NotificationBase
Parameters:
notificationExtension - The notification extension (NotificationExtensionService) parameter.
See Also:
getNotificationExtension()

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.

2008-07-29 1.1.0

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