Module org.yamcs.client

Package org.yamcs.client

Class YamcsClient

java.lang.Object

org.yamcs.client.YamcsClient

public class YamcsClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YamcsClient.Builder

Method Summary

Modifier and Type	Method	Description
void	addConnectionListener(ConnectionListener connectionListener)
void	close()
void	connectWebSocket()	Establish a live communication channel.
AlarmSubscription	createAlarmSubscription()
ArchiveClient	createArchiveClient(String instance)
ClearanceSubscription	createClearanceSubscription()
CommandSubscription	createCommandSubscription()
ContainerSubscription	createContainerSubscription()
CompletableFuture<org.yamcs.protobuf.Event>	createEvent(org.yamcs.protobuf.CreateEventRequest request)
EventSubscription	createEventSubscription()
GlobalAlarmStatusSubscription	createGlobalAlarmStatusSubscription()
CompletableFuture<org.yamcs.protobuf.YamcsInstance>	createInstance(org.yamcs.protobuf.CreateInstanceRequest request)
LinkSubscription	createLinkSubscription()
MissionDatabaseClient	createMissionDatabaseClient(String instance)
PacketSubscription	createPacketSubscription()
ParameterSubscription	createParameterSubscription()
CompletableFuture<ProcessorClient>	createProcessor(org.yamcs.protobuf.CreateProcessorRequest request)
ProcessorClient	createProcessorClient(String instance, String processor)
ProcessorSubscription	createProcessorSubscription()
QueueEventSubscription	createQueueEventSubscription()
QueueStatisticsSubscription	createQueueStatisticsSubscription()
StorageClient	createStorageClient()
TimelineClient	createTimelineClient(String instance, String processor)
TimeSubscription	createTimeSubscription()
CompletableFuture<org.yamcs.protobuf.links.LinkInfo>	disableLink(String instance, String link)
CompletableFuture<Void>	editAlarm(org.yamcs.protobuf.alarms.EditAlarmRequest request)
CompletableFuture<org.yamcs.protobuf.links.LinkInfo>	enableLink(String instance, String link)
String	getContext()
CompletableFuture<List<org.yamcs.protobuf.FileTransferServiceInfo>>	getFileTransferServices(String instance)
String	getHost()
CompletableFuture<org.yamcs.protobuf.YamcsInstance>	getInstance(String instance)
CompletableFuture<org.yamcs.protobuf.LeapSecondsTable>	getLeapSeconds()
org.yamcs.api.MethodHandler	getMethodHandler()
CompletableFuture<org.yamcs.protobuf.UserInfo>	getOwnUserInfo()
int	getPort()
CompletableFuture<org.yamcs.protobuf.GetServerInfoResponse>	getServerInfo()
String	getServerURL()
String	getUrl()
WebSocketClient	getWebSocketClient()
boolean	isTLS()
boolean	isVerifyTLS()
CompletableFuture<org.yamcs.protobuf.alarms.ListAlarmsResponse>	listAlarms(String instance)
CompletableFuture<org.yamcs.protobuf.alarms.ListProcessorAlarmsResponse>	listAlarms(String instance, String processor)
CompletableFuture<List<org.yamcs.protobuf.YamcsInstance>>	listInstances()
CompletableFuture<org.yamcs.protobuf.ListInstancesResponse>	listInstances(InstanceFilter filter)
CompletableFuture<List<org.yamcs.protobuf.ProcessorInfo>>	listProcessors(String instance)
CompletableFuture<List<org.yamcs.protobuf.ServiceInfo>>	listServices(String instance)
void	login(String username, char[] password)
void	loginWithKerberos()
void	loginWithKerberos(String principal)
static YamcsClient.Builder	newBuilder(String serverUrl)
static YamcsClient.Builder	newBuilder(String host, int port)
void	pollServer()	Polls the server, to see if it is ready.
CompletableFuture<org.yamcs.protobuf.YamcsInstance>	reconfigureInstance(org.yamcs.protobuf.ReconfigureInstanceRequest request)
void	removeConnectionListener(ConnectionListener connectionListener)
CompletableFuture<org.yamcs.protobuf.YamcsInstance>	restartInstance(String instance)
CompletableFuture<org.yamcs.protobuf.YamcsInstance>	startInstance(String instance)
CompletableFuture<Void>	startService(String instance, String service)
CompletableFuture<org.yamcs.protobuf.YamcsInstance>	stopInstance(String instance)
CompletableFuture<Void>	stopService(String instance, String service)

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static YamcsClient.Builder newBuilder(String serverUrl)

newBuilder

public static YamcsClient.Builder newBuilder(String host,
 int port)

loginWithKerberos

public void loginWithKerberos()
                       throws ClientException

Throws:

ClientException

loginWithKerberos

public void loginWithKerberos(String principal)
                       throws ClientException

Throws:

ClientException

login

public void login(String username,
 char[] password)
           throws ClientException

Throws:

ClientException

pollServer

public void pollServer()
                throws ClientException

Polls the server, to see if it is ready.

Throws:

ClientException

connectWebSocket

public void connectWebSocket()
                      throws ClientException

Establish a live communication channel.

Throws:

ClientException

createInstance

public CompletableFuture<org.yamcs.protobuf.YamcsInstance> createInstance(org.yamcs.protobuf.CreateInstanceRequest request)

reconfigureInstance

public CompletableFuture<org.yamcs.protobuf.YamcsInstance> reconfigureInstance(org.yamcs.protobuf.ReconfigureInstanceRequest request)

listInstances

public CompletableFuture<List<org.yamcs.protobuf.YamcsInstance>> listInstances()

getInstance

public CompletableFuture<org.yamcs.protobuf.YamcsInstance> getInstance(String instance)

listInstances

public CompletableFuture<org.yamcs.protobuf.ListInstancesResponse> listInstances(InstanceFilter filter)

startInstance

public CompletableFuture<org.yamcs.protobuf.YamcsInstance> startInstance(String instance)

stopInstance

public CompletableFuture<org.yamcs.protobuf.YamcsInstance> stopInstance(String instance)

restartInstance

public CompletableFuture<org.yamcs.protobuf.YamcsInstance> restartInstance(String instance)

listProcessors

public CompletableFuture<List<org.yamcs.protobuf.ProcessorInfo>> listProcessors(String instance)

getServerInfo

public CompletableFuture<org.yamcs.protobuf.GetServerInfoResponse> getServerInfo()

getServerURL

public String getServerURL()

getOwnUserInfo

public CompletableFuture<org.yamcs.protobuf.UserInfo> getOwnUserInfo()

listServices

public CompletableFuture<List<org.yamcs.protobuf.ServiceInfo>> listServices(String instance)

startService

public CompletableFuture<Void> startService(String instance,
 String service)

enableLink

public CompletableFuture<org.yamcs.protobuf.links.LinkInfo> enableLink(String instance,
 String link)

disableLink

public CompletableFuture<org.yamcs.protobuf.links.LinkInfo> disableLink(String instance,
 String link)

stopService

public CompletableFuture<Void> stopService(String instance,
 String service)

getLeapSeconds

public CompletableFuture<org.yamcs.protobuf.LeapSecondsTable> getLeapSeconds()

createProcessor

public CompletableFuture<ProcessorClient> createProcessor(org.yamcs.protobuf.CreateProcessorRequest request)

createEvent

public CompletableFuture<org.yamcs.protobuf.Event> createEvent(org.yamcs.protobuf.CreateEventRequest request)

listAlarms

public CompletableFuture<org.yamcs.protobuf.alarms.ListAlarmsResponse> listAlarms(String instance)

listAlarms

public CompletableFuture<org.yamcs.protobuf.alarms.ListProcessorAlarmsResponse> listAlarms(String instance,
 String processor)

editAlarm

public CompletableFuture<Void> editAlarm(org.yamcs.protobuf.alarms.EditAlarmRequest request)

getFileTransferServices

public CompletableFuture<List<org.yamcs.protobuf.FileTransferServiceInfo>> getFileTransferServices(String instance)

createStorageClient

public StorageClient createStorageClient()

createArchiveClient

public ArchiveClient createArchiveClient(String instance)

createMissionDatabaseClient

public MissionDatabaseClient createMissionDatabaseClient(String instance)

createProcessorClient

public ProcessorClient createProcessorClient(String instance,
 String processor)

createTimelineClient

public TimelineClient createTimelineClient(String instance,
 String processor)

getHost

public String getHost()

getPort

public int getPort()

isTLS

public boolean isTLS()

getContext

public String getContext()

isVerifyTLS

public boolean isVerifyTLS()

addConnectionListener

public void addConnectionListener(ConnectionListener connectionListener)

removeConnectionListener

public void removeConnectionListener(ConnectionListener connectionListener)

getWebSocketClient

public WebSocketClient getWebSocketClient()

getMethodHandler

public org.yamcs.api.MethodHandler getMethodHandler()

getUrl

public String getUrl()

createTimeSubscription

public TimeSubscription createTimeSubscription()

createClearanceSubscription

public ClearanceSubscription createClearanceSubscription()

createEventSubscription

public EventSubscription createEventSubscription()

createAlarmSubscription

public AlarmSubscription createAlarmSubscription()

createGlobalAlarmStatusSubscription

public GlobalAlarmStatusSubscription createGlobalAlarmStatusSubscription()

createPacketSubscription

public PacketSubscription createPacketSubscription()

createProcessorSubscription

public ProcessorSubscription createProcessorSubscription()

createCommandSubscription

public CommandSubscription createCommandSubscription()

createQueueEventSubscription

public QueueEventSubscription createQueueEventSubscription()

createQueueStatisticsSubscription

public QueueStatisticsSubscription createQueueStatisticsSubscription()

createParameterSubscription

public ParameterSubscription createParameterSubscription()

createLinkSubscription

public LinkSubscription createLinkSubscription()

createContainerSubscription

public ContainerSubscription createContainerSubscription()

close

public void close()