org.lsst.ccs.localdb.trendserver

Class TrendingClientService

java.lang.Object

org.lsst.ccs.localdb.trendserver.TrendingClientService

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.AgentPresenceListener, org.lsst.ccs.ServiceLifecycle, org.lsst.ccs.services.AgentService

public class TrendingClientService
extends Object
implements org.lsst.ccs.services.AgentService, org.lsst.ccs.ServiceLifecycle, org.lsst.ccs.messaging.AgentPresenceListener, org.lsst.ccs.framework.HasLifecycle

An AgentService to be used by Agents that need to interact with the Rest Server on the buses. Connections can be established by either creating a custom connection to a known host:port combination or by listening to the buses for available rest services.

Author:

The LSST CCS Team

Field Summary

Fields

Modifier and Type	Field and Description
static String	USES_TRENDING_SERVICE

Constructor Summary

Constructors

Constructor and Description
TrendingClientService()

Method Summary

Modifier and Type	Method and Description
void	build()
void	connected(org.lsst.ccs.bus.data.AgentInfo... agents)
TrendingConnectionUtils	createClientRequestUtils(String name, String host, int port) Create a named ClientRequestUtils object given a fixed host/port combination.
void	disconnecting(org.lsst.ccs.bus.data.AgentInfo agent)
String	getAgentServiceName()
TrendingConnectionUtils	getBusTrendingConnection() Get one of the available TrendingConnections over the buses.
Set<String>	getNamedTrendingConnections() Get a list of available named client connections to the Trending rest server.
TrendingConnectionUtils	getTrendingConnection(String name) Get named Trending Connection.
void	preStart()
boolean	startForAgent(org.lsst.ccs.bus.data.AgentInfo agentInfo)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, afterStart, preBuild, preInit, preShutdown

Methods inherited from interface org.lsst.ccs.messaging.AgentPresenceListener

connecting, disconnected

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

init, postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

USES_TRENDING_SERVICE

public static final String USES_TRENDING_SERVICE

See Also:

Constant Field Values

Constructor Detail

TrendingClientService

public TrendingClientService()

Method Detail

getAgentServiceName

public String getAgentServiceName()

Specified by:

getAgentServiceName in interface org.lsst.ccs.services.AgentService

startForAgent

public boolean startForAgent(org.lsst.ccs.bus.data.AgentInfo agentInfo)

Specified by:

startForAgent in interface org.lsst.ccs.services.AgentService

build

public void build()

Specified by:

build in interface org.lsst.ccs.framework.HasLifecycle

preStart

public void preStart()

Specified by:

preStart in interface org.lsst.ccs.ServiceLifecycle

connected

public void connected(org.lsst.ccs.bus.data.AgentInfo... agents)

Specified by:

connected in interface org.lsst.ccs.messaging.AgentPresenceListener

disconnecting

public void disconnecting(org.lsst.ccs.bus.data.AgentInfo agent)

Specified by:

disconnecting in interface org.lsst.ccs.messaging.AgentPresenceListener

createClientRequestUtils

public TrendingConnectionUtils createClientRequestUtils(String name,
                                                        String host,
                                                        int port)

Create a named ClientRequestUtils object given a fixed host/port combination.

Parameters:

name - The name for this custom connection to a rest server.

host - The host on which the rest server is running.

port - The port on which the reset server is running.

Returns:

a ClientRequestUtils object.

Throws:

This - method can throw unchecked exceptions form the underlying classes if there is a failure in connecting to the trending client. Users of this method must protect against this by sorrounding this call in a try-catch block.

getNamedTrendingConnections

public Set<String> getNamedTrendingConnections()

Get a list of available named client connections to the Trending rest server.

Returns:

a Set with the available named connections.

getTrendingConnection

public TrendingConnectionUtils getTrendingConnection(String name)

Get named Trending Connection.

Returns:

the named TrendingConnectionUtils.

getBusTrendingConnection

public TrendingConnectionUtils getBusTrendingConnection()

Get one of the available TrendingConnections over the buses.

Returns:

a TrendingConnectionUtils established from listening to the buses. null will be returned if no connection is available.