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

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.notification.client.NotificationClient

Direct Known Subclasses:

AdapterTest, AgentTest, DeviceTest, ProfileTest

public class NotificationClient
extends EscObject

Version:

1.1.0

Field Summary

static char

TOPIC_DELIMITER Define the topic delimiter (char) constant.

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, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, 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

Constructor Summary

NotificationClient()
Constructs an instance of this class.

Method Summary

void	broadcast(java.lang.String topic, java.util.Dictionary data)
protected NotificationController	getNotificationController() Gets the notification controller value.
NotificationService	getNotificationService() Gets the pub sub service value.
void	notificationReceived(java.lang.String externalKey, java.lang.Object data)
java.lang.String	prependPrefix(java.lang.String topicPrefix, java.lang.String topic) Prepend prefix with the specified topic prefix and topic parameters and return the String result.
void	register(java.lang.String topic)
void	register(java.lang.String[] topics)
protected void	setNotificationController(NotificationController notificationController) Sets the notification controller value.
void	setNotificationService(NotificationService notificationService) Sets the pub sub service value.
void	unregister() Unregister.

Methods inherited from class org.eclipse.soda.dk.core.EscObject

attemptRecoveryFromError, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getErrorSeverity, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getResource, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isDebug, isTrace, loadService, 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

Field Detail

TOPIC_DELIMITER

public static final char TOPIC_DELIMITER

Define the topic delimiter (char) constant.

See Also:

Constant Field Values

Constructor Detail

NotificationClient

public NotificationClient()

Constructs an instance of this class.

Method Detail

broadcast

public void broadcast(java.lang.String topic,
                      java.util.Dictionary data)

Parameters:

topic - The topic (String) parameter.

data - The data (Dictionary) parameter.

getNotificationController

protected NotificationController getNotificationController()

Gets the notification controller value.

Returns:

The notification controller (NotificationController) value.

See Also:

setNotificationController(NotificationController)

getNotificationService

public NotificationService getNotificationService()

Gets the pub sub service value.

Returns:

The pub sub service (NotificationService) value.

See Also:

setNotificationService(NotificationService)

notificationReceived

public void notificationReceived(java.lang.String externalKey,
                                 java.lang.Object data)

Parameters:

externalKey - The external key (String) parameter.

data - The data (Object) parameter.

prependPrefix

public java.lang.String prependPrefix(java.lang.String topicPrefix,
                                      java.lang.String topic)

Prepend prefix with the specified topic prefix and topic parameters and return the String result.

Parameters:

topicPrefix - The topic prefix (String) parameter.

topic - The topic (String) parameter.

Returns:

Results of the prepend prefix (String) value.

register

public void register(java.lang.String topic)

Parameters:

topic - The topic (String) parameter.

See Also:

register(String[])

register

public void register(java.lang.String[] topics)

Parameters:

topics - The topics (String[]) parameter.

See Also:

register(String)

setNotificationController

protected void setNotificationController(NotificationController notificationController)

Sets the notification controller value. The notification controller (NotificationController) parameter.

Parameters:

notificationController - The notification controller (NotificationController) parameter.

See Also:

getNotificationController()

setNotificationService

public void setNotificationService(NotificationService notificationService)

Sets the pub sub service value. The pub sub service (NotificationService) parameter. The pub sub service (NotificationService) parameter. The notification service (NotificationService) parameter.

Parameters:

notificationService - The notification service (NotificationService) parameter.

See Also:

getNotificationService()

unregister

public void unregister()

Unregister.