org.lsst.ccs.localdb.statusdb.server

Class DataServer

java.lang.Object

org.lsst.ccs.localdb.statusdb.server.DataServer

@Path(value="/dataserver")
 @Singleton
public class DataServer
extends Object

The DataServer receives requests for trending data analysis. It delivers the requested data as the result of requests to the database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataServer.StatEntry

Constructor Summary

Constructors

Constructor and Description
DataServer()

Method Summary

Modifier and Type	Method and Description
protected Data	exportRawData(String path, long rawId, long t1, long t2, org.hibernate.Session sess)
protected Data	exportStatDataFromRaw(String path, long rawId, long t1, long t2, int nsamples, org.hibernate.Session sess)
protected Data	exportStatDataFromStat(String path, StatDesc statDesc, long t1, long t2, int nsamples, org.hibernate.Session sess)
AlertEvent.AlertEventList	getActiveAlerts(List<Long> ids) Returns a list of active alerts.
AlertEvent.AlertEventList	getAlertHistories(List<Long> ids, long t1, long t2) Returns an history of alerts that have been raised within the given time interval.
AlertInfo.AlertInfoList	getAlertInfo()
AlertInfo.AlertInfoList	getAlertInfo(String subsystem)
List<StatDesc>	getAvailableStats(long rawId, org.hibernate.Session sess) Get the StatDesc for a given raw Id
DataChannel.DataChannelList	getChannels(long dt)
DataChannel[]	getChannels(String partialPath, int level)
DataChannel.DataChannelList	getChannels(String subsystemName, long dt)
StateChange.StateChangesList	getComponentStateChangeList(String subsystem, String component, List<String> states, long t1, long t2) Gets the state changes events for the given list of states, between the time interval [t1,t2], for a given component of a subsystem.
List<Data>	getData(List<Long> ids, long t1, long t2, String flavor, int nbins)
Data	getData(long id, long t1, long t2, String flavor, int nbins)
List<Data>	getDataByPath(List<String> paths, long t1, long t2, String flavor, int nbins)
TrendingData	getLatestDataByPath(String path)
StateInfo.StateChannelList	getListOfStates() Get the state tree structure for a given subsystem.
StateInfo.StateChannelList	getListOfStates(String subsystem) Get the state tree structure for a given subsystem.
List<ChannelMetaData>	getMetadataForChannel(int channelId, long t1, long t2)
ChannelMetaData.ChannelMetadataList	getMetadataList(long channelId)
List<RawData>	getRawData(long id, long t1, long t2, org.hibernate.Session sess)
List<StatData>	getStatData(StatDesc statDesc, long t1, long t2, org.hibernate.Session sess) Returns the list of StatData with the given statDesc that overlap the interval [t1,t2[.
StateChange.StateChangesList	getStateChangeList(String subsystem, List<String> states, List<String> components, long t1, long t2) Gets the state changes events for the given list of states, between the time interval [t1,t2], for the given subsystem.
StateInfo.StateInfoList	getStateInfo(String subsystem) Lists all the existing states for a given subsystem.
DataSubsystem.DataSubsystemList	getSubsystems()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataServer

public DataServer()

Method Detail

getLatestDataByPath

@GET
 @Path(value="/data/latest/")
 @Produces(value={"text/xml","application/xml","application/json"})
public TrendingData getLatestDataByPath(@QueryParam(value="path")
                                                                                                                                               String path)

getDataByPath

@GET
 @Path(value="/data/search/")
 @Produces(value={"text/xml","application/xml","application/json"})
public List<Data> getDataByPath(@QueryParam(value="path")
                                                                                                                                       List<String> paths,
                                                                                                                                       @QueryParam(value="t1") @DefaultValue(value="-1")
                                                                                                                                       long t1,
                                                                                                                                       @QueryParam(value="t2") @DefaultValue(value="-1")
                                                                                                                                       long t2,
                                                                                                                                       @QueryParam(value="flavor")
                                                                                                                                       String flavor,
                                                                                                                                       @QueryParam(value="n") @DefaultValue(value="30")
                                                                                                                                       int nbins)

getData

@GET
 @Path(value="/data/")
 @Produces(value={"text/xml","application/xml","application/json"})
public List<Data> getData(@QueryParam(value="id")
                                                                                                                          List<Long> ids,
                                                                                                                          @QueryParam(value="t1") @DefaultValue(value="-1")
                                                                                                                          long t1,
                                                                                                                          @QueryParam(value="t2") @DefaultValue(value="-1")
                                                                                                                          long t2,
                                                                                                                          @QueryParam(value="flavor")
                                                                                                                          String flavor,
                                                                                                                          @QueryParam(value="n") @DefaultValue(value="30")
                                                                                                                          int nbins)

getData

@GET
 @Path(value="/data/{id:  \\d+}")
 @Produces(value={"text/xml","application/xml","application/json"})
public Data getData(@PathParam(value="id")
                                                                                                                               long id,
                                                                                                                               @QueryParam(value="t1") @DefaultValue(value="-1")
                                                                                                                               long t1,
                                                                                                                               @QueryParam(value="t2") @DefaultValue(value="-1")
                                                                                                                               long t2,
                                                                                                                               @QueryParam(value="flavor")
                                                                                                                               String flavor,
                                                                                                                               @QueryParam(value="n") @DefaultValue(value="30")
                                                                                                                               int nbins)

getMetadataForChannel

@GET
 @Path(value="/metadata/")
 @Produces(value={"text/xml","application/xml","application/json"})
public List<ChannelMetaData> getMetadataForChannel(@QueryParam(value="id")
                                                                                                                                                       int channelId,
                                                                                                                                                       @QueryParam(value="t1") @DefaultValue(value="-1")
                                                                                                                                                       long t1,
                                                                                                                                                       @QueryParam(value="t2") @DefaultValue(value="-1")
                                                                                                                                                       long t2)

getMetadataList

@GET
 @Path(value="/channelinfo/{id}")
 @Produces(value={"text/xml","application/xml","application/json"})
public ChannelMetaData.ChannelMetadataList getMetadataList(@PathParam(value="id")
                                                                                                                                                                      long channelId)

getSubsystems

@GET
 @Path(value="listsubsystems")
 @Produces(value={"text/xml","application/xml","application/json"})
public DataSubsystem.DataSubsystemList getSubsystems()

getChannels

@GET
 @Path(value="/listchannels")
 @Produces(value={"text/xml","application/xml","application/json"})
public DataChannel.DataChannelList getChannels(@QueryParam(value="maxIdleSeconds") @DefaultValue(value="604800")
                                                                                                                                                      long dt)

Returns:

the whole channels list for all CCS. optional query parameter maxIdleSeconds with default value 86400: only returns parameters seen since that delay. Negative value: returns all channels.

getChannels

@GET
 @Path(value="/listchannels/{subsystem}")
 @Produces(value={"text/xml","application/xml","application/json"})
public DataChannel.DataChannelList getChannels(@PathParam(value="subsystem")
                                                                                                                                                                  String subsystemName,
                                                                                                                                                                  @QueryParam(value="maxIdleSeconds") @DefaultValue(value="604800")
                                                                                                                                                                  long dt)

Parameters:

subsystemName -

Returns:

a channels list for a subsystem optional query parameter maxIdleSeconds with default value 36000: only returns parameters seen since that delay. Negative value: returns all channels.

getChannels

public DataChannel[] getChannels(String partialPath,
                                 int level)

Parameters:

partialPath -

level -

Returns:

the list of channels within a partial path and a level

getAvailableStats

public List<StatDesc> getAvailableStats(long rawId,
                                        org.hibernate.Session sess)

Get the StatDesc for a given raw Id

Parameters:

rawId - the DataDesc id

Returns:

The List of StatDesc.

getRawData

public List<RawData> getRawData(long id,
                                long t1,
                                long t2,
                                org.hibernate.Session sess)

getStatData

public List<StatData> getStatData(StatDesc statDesc,
                                  long t1,
                                  long t2,
                                  org.hibernate.Session sess)

Returns the list of StatData with the given statDesc that overlap the interval [t1,t2[.

Parameters:

statDesc - the statistical description

t1 -

t2 -

Returns:

exportRawData

protected Data exportRawData(String path,
                             long rawId,
                             long t1,
                             long t2,
                             org.hibernate.Session sess)

exportStatDataFromRaw

protected Data exportStatDataFromRaw(String path,
                                     long rawId,
                                     long t1,
                                     long t2,
                                     int nsamples,
                                     org.hibernate.Session sess)

exportStatDataFromStat

protected Data exportStatDataFromStat(String path,
                                      StatDesc statDesc,
                                      long t1,
                                      long t2,
                                      int nsamples,
                                      org.hibernate.Session sess)

getStateInfo

@GET
 @Path(value="statesinfo/{subsystem}")
 @Produces(value={"text/xml","application/xml","application/json"})
public StateInfo.StateInfoList getStateInfo(@PathParam(value="subsystem")
                                                                                                                                                            String subsystem)

Lists all the existing states for a given subsystem.

Parameters:

subsystem - the subsystem name.

Returns:

getStateChangeList

@GET
 @Path(value="/statechanges/{subsystem}")
 @Produces(value={"text/xml","application/xml","application/json"})
public StateChange.StateChangesList getStateChangeList(@PathParam(value="subsystem")
                                                                                                                                                                          String subsystem,
                                                                                                                                                                          @QueryParam(value="state")
                                                                                                                                                                          List<String> states,
                                                                                                                                                                          @QueryParam(value="component")
                                                                                                                                                                          List<String> components,
                                                                                                                                                                          @QueryParam(value="t1") @DefaultValue(value="-1")
                                                                                                                                                                          long t1,
                                                                                                                                                                          @QueryParam(value="t2") @DefaultValue(value="-1")
                                                                                                                                                                          long t2)

Gets the state changes events for the given list of states, between the time interval [t1,t2], for the given subsystem.

Parameters:

subsystem - the subsystem

states - if empty, returns all state changes for all found states.

components - if empty, return all state changes for all components.

t1 -

t2 -

Returns:

getComponentStateChangeList

@GET
 @Path(value="/statechanges/{subsystem}/{component}")
 @Produces(value={"text/xml","application/xml","application/json"})
public StateChange.StateChangesList getComponentStateChangeList(@PathParam(value="subsystem")
                                                                                                                                                                                               String subsystem,
                                                                                                                                                                                               @PathParam(value="component")
                                                                                                                                                                                               String component,
                                                                                                                                                                                               @QueryParam(value="state")
                                                                                                                                                                                               List<String> states,
                                                                                                                                                                                               @QueryParam(value="t1") @DefaultValue(value="-1")
                                                                                                                                                                                               long t1,
                                                                                                                                                                                               @QueryParam(value="t2") @DefaultValue(value="-1")
                                                                                                                                                                                               long t2)

Gets the state changes events for the given list of states, between the time interval [t1,t2], for a given component of a subsystem.

Parameters:

subsystem - the subsystem

component - the component for which to list state changes

states - if empty, returns all state changes for all found states

t1 -

t2 -

Returns:

getListOfStates

@GET
 @Path(value="liststates/{subsystem}")
 @Produces(value={"text/xml","application/xml","application/json"})
public StateInfo.StateChannelList getListOfStates(@PathParam(value="subsystem")
                                                                                                                                                                  String subsystem)

Get the state tree structure for a given subsystem.

Parameters:

subsystem - the subsystem name.

Returns:

getListOfStates

@GET
 @Path(value="liststates")
 @Produces(value={"text/xml","application/xml","application/json"})
public StateInfo.StateChannelList getListOfStates()

Get the state tree structure for a given subsystem.

Parameters:

subsystem - the subsystem name.

Returns:

getAlertInfo

@Path(value="/listalerts")
 @GET
public AlertInfo.AlertInfoList getAlertInfo()

getAlertInfo

@Path(value="/listalerts/{subsystem}")
 @GET
public AlertInfo.AlertInfoList getAlertInfo(@PathParam(value="subsystem")
                                                                                         String subsystem)

getActiveAlerts

@Path(value="activealerts")
 @GET
 @Produces(value={"text/xml","application/xml","application/json"})
public AlertEvent.AlertEventList getActiveAlerts(@QueryParam(value="id")
                                                                                                                                                       List<Long> ids)

Returns a list of active alerts. Active alerts are alerts that have been raised during the current subsystem run.

Parameters:

ids - a list of ids.

Returns:

getAlertHistories

@Path(value="alerthistory")
 @GET
 @Produces(value={"text/xml","application/xml","application/json"})
public AlertEvent.AlertEventList getAlertHistories(@QueryParam(value="id")
                                                                                                                                                         List<Long> ids,
                                                                                                                                                         @QueryParam(value="t1") @DefaultValue(value="-1")
                                                                                                                                                         long t1,
                                                                                                                                                         @QueryParam(value="t2") @DefaultValue(value="-1")
                                                                                                                                                         long t2)

Returns an history of alerts that have been raised within the given time interval.

Parameters:

ids - a list of alertdesc ids.

t1 -

t2 -

Returns: