Package net.solarnetwork.node.service

Interface PlatformService

All Known Implementing Classes:

DefaultPlatformService

public interface PlatformService

API for SolarNode platform-wide support.

Since:

1.56

Version:

1.0

Author:

matt

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PlatformService.PlatformState	An enumeration of possible platform states.
static interface	PlatformService.PlatformTask<T>	A platform task.
static interface	PlatformService.PlatformTaskInfo	Information about a task.
static interface	PlatformService.PlatformTaskStatus	Status information about a task.
static interface	PlatformService.PlatformTaskStatusHandler	A callback handler for dealing with real-time status updates.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT_TOPIC_PLATFORM_STATE_CHANGED	An Event topic for when a the platform state has changed.
static final String	MSG_TOPIC_PLATFORM_TASK_INFO	A message topic for task info updates.
static final String	OLD_PLATFORM_STATE_PROPERTY	A Event property name for a PlatformService.PlatformState string value that represents an "old" state.
static final String	PLATFORM_STATE_PROPERTY	A Event property name for a PlatformService.PlatformState string value that represents the "active" state.

Method Summary

Modifier and Type	Method	Description
PlatformService.PlatformState	activePlatformState()	Get the current active platform state.
PlatformService.PlatformTaskInfo	activePlatformTaskInfo(Locale locale)	Get the current active platform task status, localized into task info.
PlatformService.PlatformTaskStatus	activePlatformTaskStatus()	Get the current active platform task status.
<T> Future<T>	performTaskWithState(PlatformService.PlatformState state, PlatformService.PlatformTask<T> task)	Perform a platform state-altering task.
void	subscribeToActivePlatformTaskInfo(Locale locale)	Register a subscription to the active platform task's status updates for a specific locale.

Field Details

EVENT_TOPIC_PLATFORM_STATE_CHANGED

static final String EVENT_TOPIC_PLATFORM_STATE_CHANGED

An Event topic for when a the platform state has changed.

See Also:

• Constant Field Values

PLATFORM_STATE_PROPERTY

static final String PLATFORM_STATE_PROPERTY

A Event property name for a PlatformService.PlatformState string value that represents the "active" state.

See Also:

• Constant Field Values

OLD_PLATFORM_STATE_PROPERTY

static final String OLD_PLATFORM_STATE_PROPERTY

A Event property name for a PlatformService.PlatformState string value that represents an "old" state.

See Also:

• Constant Field Values

MSG_TOPIC_PLATFORM_TASK_INFO

static final String MSG_TOPIC_PLATFORM_TASK_INFO

A message topic for task info updates.

The message body will contain a new.solarnetwork.domain.Result with PlatformService.PlatformTaskInfo content.

See Also:

• Constant Field Values

Method Details

activePlatformState

PlatformService.PlatformState activePlatformState()

Get the current active platform state.

Returns:

the active platform state

activePlatformTaskStatus

PlatformService.PlatformTaskStatus activePlatformTaskStatus()

Get the current active platform task status.

Returns:

the task info, or null if no task is active

activePlatformTaskInfo

PlatformService.PlatformTaskInfo activePlatformTaskInfo(Locale locale)

Get the current active platform task status, localized into task info.

Parameters:

locale - the desired locale of the info, or null for the system default

Returns:

the localized platform task info

subscribeToActivePlatformTaskInfo

void subscribeToActivePlatformTaskInfo(Locale locale)

Register a subscription to the active platform task's status updates for a specific locale.

Once registered, this service will post messages to the MSG_TOPIC_PLATFORM_TASK_INFO topic.

Parameters:

locale - the locale to register for updates

performTaskWithState

<T> Future<T> performTaskWithState(PlatformService.PlatformState state,
 PlatformService.PlatformTask<T> task)

Perform a platform state-altering task.

This method will schedule a task such that while that task is running the provided state is applied to the platform. While task is executing the activePlatformState() method will return the given state.

Type Parameters:

T - the task result type

Parameters:

state - the state the task must run with

task - the task to execute

Returns:

a future with the task results