org.lsst.ccs.gconsole.services.rest

Class LsstRestService

java.lang.Object

org.lsst.ccs.gconsole.base.ConsolePlugin

org.lsst.ccs.gconsole.services.rest.LsstRestService

@Plugin(name="LSST Rest Service Plugin",
        id="rest-service",
        description="Plugin that handles connection to the REST server.")
public class LsstRestService
extends ConsolePlugin

Service plugin for retrieving data from the REST server. This service provides methods for retrieving trending data, and accepts registration of listeners to be notified when the service is (re)connected to a new REST server.

This class is thread-safe, public methods can be called on any thread. Listeners are notified on EDT. Getters might block waiting for the REST server connection to be (re)established. Getters return null if the server is not available.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECT_ON_STARTUP_PROPERTY
static String	FROM_BUS_PROPERTY
static String	HOST_PROPERTY
static String	PORT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
LsstRestService()

Method Summary

Modifier and Type	Method and Description
void	addListener(ChangeListener listener) Registers a listener to be notified when the service is (re)connected to a new REST server.
List<org.lsst.ccs.localdb.statusdb.server.AlertEvent>	geAlerts(long begin, long end, String... ids) Retrieves and returns alerts history.If the REST service has not been started earlier, if will be initialized before the data is retrieved.
org.lsst.ccs.localdb.statusdb.server.AlertInfo.AlertInfoList	getAlertList(long begin) Retrieves and returns the list of alert channels available from the REST server.
org.lsst.ccs.localdb.statusdb.server.StateInfo.StateInfoList	getStateInfo(String agent) Retrieves and returns the list of states and their possible values for the specified subsystem.
org.lsst.ccs.localdb.statusdb.server.DataChannel.DataChannelList	getStateList(long begin) Retrieves and returns the list of state channels currently available from the REST server.
List<org.lsst.ccs.localdb.statusdb.server.StateChange>	getStateTransitions(long begin, long end, String agent, Collection<String> components, Collection<String> states) Retrieves and returns state transitions history.
org.lsst.ccs.localdb.statusdb.server.TrendingResult[]	getTrendingData(long begin, long end, String flavor, int nBins, String... paths) Retrieves and returns data for the specified channels and time window.
org.lsst.ccs.localdb.statusdb.server.DataChannel.DataChannelList	getTrendingList(long begin) Retrieves and returns the list of trending data channels currently available from the REST server.
void	initialize() Called by the framework when the console starts, to initialize this plugin..
void	propertiesChanged(Object source, Map<String,Object> changes) Called by the framework in response to change in preferences.
void	refreshConnection(boolean queue) Requests reestablishing connection based on current preferences.
void	removeAllListeners() Removes all listeners.
void	removeListener(ChangeListener listener) Removes a listener.
void	shutdown() Called by the framework when the graphical console is shut down.
void	start() Called by the framework when the console starts, after all plugins have been initialized.

Methods inherited from class org.lsst.ccs.gconsole.base.ConsolePlugin

getConsole, getServices, restore, save, setServicesProvider, stop

Methods inherited from class java.lang.Object

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

Field Detail

FROM_BUS_PROPERTY

public static final String FROM_BUS_PROPERTY

See Also:

Constant Field Values

HOST_PROPERTY

public static final String HOST_PROPERTY

See Also:

Constant Field Values

PORT_PROPERTY

public static final String PORT_PROPERTY

See Also:

Constant Field Values

CONNECT_ON_STARTUP_PROPERTY

public static final String CONNECT_ON_STARTUP_PROPERTY

See Also:

Constant Field Values

Constructor Detail

LsstRestService

public LsstRestService()

Method Detail

initialize

public void initialize()

Description copied from class: ConsolePlugin

Called by the framework when the console starts, to initialize this plugin..

Overrides:

initialize in class ConsolePlugin

start

public void start()

Description copied from class: ConsolePlugin

Called by the framework when the console starts, after all plugins have been initialized. May also be called interactively through the graphical console GUI.

Overrides:

start in class ConsolePlugin

shutdown

public void shutdown()

Description copied from class: ConsolePlugin

Called by the framework when the graphical console is shut down.

Overrides:

shutdown in class ConsolePlugin

propertiesChanged

public void propertiesChanged(Object source,
                              Map<String,Object> changes)

Called by the framework in response to change in preferences. This method should not be called by service clients.

Overrides:

propertiesChanged in class ConsolePlugin

Parameters:

source - Source of notification.

changes - For the changed properties, map of keys to their new values.

refreshConnection

public void refreshConnection(boolean queue)

Requests reestablishing connection based on current preferences. If the connection is already being reestablished, the outcome depends on the argument value. This method returns immediately, connecting is done on a dedicated thread, listeners are notified on EDT once the connection is established.

Parameters:

queue - Defines what happens if connection is already being reestablished when this method is called. If true, a flag is set to tell the connecting thread that once the current attempt is finished, it should be repeated (regardless of the result). If false, the call is ignored.

addListener

public void addListener(ChangeListener listener)

Registers a listener to be notified when the service is (re)connected to a new REST server. Listeners are notified on EDT.

Parameters:

listener - Listener to be registered.

removeListener

public void removeListener(ChangeListener listener)

Removes a listener.

Parameters:

listener - Listener to be removed.

removeAllListeners

public void removeAllListeners()

Removes all listeners.

getTrendingList

public org.lsst.ccs.localdb.statusdb.server.DataChannel.DataChannelList getTrendingList(long begin)

Retrieves and returns the list of trending data channels currently available from the REST server. Only channels that have data recorded in the last begin seconds are included. If the REST service has not been started earlier, if will be initialized before the data is retrieved.

Parameters:

begin - Maximum time with no data, in seconds. If zero, the default set on the server side is used.

Returns:

List of channels, or null if the REST server is not available.

getStateList

public org.lsst.ccs.localdb.statusdb.server.DataChannel.DataChannelList getStateList(long begin)

Retrieves and returns the list of state channels currently available from the REST server. Only channels that have data recorded in the last begin seconds are included. If the REST service has not been started earlier, if will be initialized before the data is retrieved.

Parameters:

begin - Maximum time with no data, in seconds. If zero, the default set on the server side is used.

Returns:

List of channels, or null if the REST server is not available.

getAlertList

public org.lsst.ccs.localdb.statusdb.server.AlertInfo.AlertInfoList getAlertList(long begin)

Retrieves and returns the list of alert channels available from the REST server. If the REST service has not been started earlier, if will be initialized before the data is retrieved.

Parameters:

begin - Maximum time with no data, in seconds. CURRENTLY IGNORED..

Returns:

List of channels, or null if the REST server is not available.

getStateInfo

public org.lsst.ccs.localdb.statusdb.server.StateInfo.StateInfoList getStateInfo(String agent)

Retrieves and returns the list of states and their possible values for the specified subsystem. If the REST service has not been started earlier, if will be initialized before the data is retrieved.

Parameters:

agent - Subsystem name.

Returns:

List of channels, or null if the REST server is not available.

getTrendingData

public org.lsst.ccs.localdb.statusdb.server.TrendingResult[] getTrendingData(long begin,
                                                                             long end,
                                                                             String flavor,
                                                                             int nBins,
                                                                             String... paths)

Retrieves and returns data for the specified channels and time window. If the REST service has not been started earlier, if will be initialized before the data is retrieved.

Parameters:

begin - Start of the time window, milliseconds since January 1, 1970, 00:00:00 GMT.

end - End of the time window, milliseconds since January 1, 1970, 00:00:00 GMT.

flavor - Data flavor, "raw" or "stat".

nBins - Requested number of bins. If non-positive, the number of bins is not specified in the request.

paths - Paths of the data channels.

Returns:

Data (including all available metadata), or null if the REST server is not available.

getStateTransitions

public List<org.lsst.ccs.localdb.statusdb.server.StateChange> getStateTransitions(long begin,
                                                                                  long end,
                                                                                  String agent,
                                                                                  Collection<String> components,
                                                                                  Collection<String> states)

Retrieves and returns state transitions history. If the REST service has not been started earlier, if will be initialized before the data is retrieved.

Parameters:

begin - Start of the time window, milliseconds since January 1, 1970, 00:00:00 GMT.

end - End of the time window, milliseconds since January 1, 1970, 00:00:00 GMT.

agent - Subsystem name.

components - Names of components, or null if all components should be included.

states - Names of states, or null if all states should be included.

Returns:

List of state transitions.

geAlerts

public List<org.lsst.ccs.localdb.statusdb.server.AlertEvent> geAlerts(long begin,
                                                                      long end,
                                                                      String... ids)

Retrieves and returns alerts history.If the REST service has not been started earlier, if will be initialized before the data is retrieved.

Parameters:

begin - Start of the time window, milliseconds since January 1, 1970, 00:00:00 GMT.

end - End of the time window, milliseconds since January 1, 1970, 00:00:00 GMT.

ids - Alert IDs (long as string).

Returns:

List of raised alerts.