ds.desktop.notify.service

Class NotifyService

java.lang.Object

ds.desktop.notify.service.NotifyService

Direct Known Subclasses:

NotifyClient, NotifyServer

public abstract class NotifyService
extends java.lang.Object

A NotifyService makes it possible to centralize control and display notifications in a single process for the current host (either a physical or virtual machine), in such a way several processes can make use of DS Desktop Notify without colliding with each other, even those where the Java platform is not necesarily present.

Handling notifications this way has some limitations, as it is not possible to set any action events or use custom themes and icons. This is because the service is meant to dispatch notification requests coming from different VMs or native processes, being input through command line and/or network, and all the avaialble assets belong only to the process running the service.

Since:

0.9 (2019-06-18)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DARK_THEME String for the stock dark theme.
static java.lang.String	LIGHT_THEME String for the stock light theme.
static int	LISTENING_PORT The port that will be used for instance control.

Constructor Summary

Constructors

Constructor and Description
NotifyService()

Method Summary

Methods

Modifier and Type	Method and Description
static NotifyService	get() Returns the currently active notification service for this device.
abstract void	postNotification(java.lang.String title, java.lang.String message, java.lang.Integer type, java.lang.Integer align, java.lang.Long timeout, java.lang.String themeName) Posts a new notification to the service, setting the parameters needed for it.
protected static void	reset() Called by the inner system, clears any existing instance data so the service lookup can be done once again.
abstract void	start() Starts the service, in case it hasn't been started yet.
abstract void	stop() Stops the service, in case it's running.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LISTENING_PORT

public static final int LISTENING_PORT

The port that will be used for instance control.

See Also:

Constant Field Values

DARK_THEME

public static final java.lang.String DARK_THEME

String for the stock dark theme.

See Also:

Constant Field Values

LIGHT_THEME

public static final java.lang.String LIGHT_THEME

String for the stock light theme.

See Also:

Constant Field Values

Constructor Detail

NotifyService

public NotifyService()

Method Detail

get

public static NotifyService get()

Returns the currently active notification service for this device. If there isn't any service running, a new service will be started and returned from here.

Notification services work in such a way that only one service can be running at a time per host, across several VMs. For this, a socket port is internally reserved and used for communication.

Returns:

The notification service.

reset

protected static void reset()

Called by the inner system, clears any existing instance data so the service lookup can be done once again.

start

public abstract void start()

Starts the service, in case it hasn't been started yet.

postNotification

public abstract void postNotification(java.lang.String title,
                    java.lang.String message,
                    java.lang.Integer type,
                    java.lang.Integer align,
                    java.lang.Long timeout,
                    java.lang.String themeName)

Posts a new notification to the service, setting the parameters needed for it.

Parameters:

title - The title to display.

message - The message to display.

type - The notification type (0~7).

align - The text/layout alignment (0,1).

timeout - The maximum time in milliseconds the notification will stay on screen.

themeName - Either "light" or "dark", refering to the two stock themes available.

See Also:

DARK_THEME, LIGHT_THEME

stop

public abstract void stop()

Stops the service, in case it's running.