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	connect(String accessToken, boolean bypassUpCheck)	Establish a live communication channel using a previously acquired access token.
void	connect(String username, char[] password)	Login to the server with user/password credential, and establish a live communication channel.
void	connectAnonymously()	Establish a live communication channel without logging in to the server.
void	connectWithKerberos()
AlarmSubscription	createAlarmSubscription()
ArchiveClient	createArchiveClient(String instance)
ClearanceSubscription	createClearanceSubscription()
CommandSubscription	createCommandSubscription()
CompletableFuture<Yamcs.Event>	createEvent(CreateEventRequest request)
EventSubscription	createEventSubscription()
CompletableFuture<YamcsInstance>	createInstance(CreateInstanceRequest request)
LinkSubscription	createLinkSubscription()
MissionDatabaseClient	createMissionDatabaseClient(String instance)
PacketSubscription	createPacketSubscription()
ParameterSubscription	createParameterSubscription()
CompletableFuture<ProcessorClient>	createProcessor(CreateProcessorRequest request)
ProcessorClient	createProcessorClient(String instance, String processor)
ProcessorSubscription	createProcessorSubscription()
QueueEventSubscription	createQueueEventSubscription()
QueueStatisticsSubscription	createQueueStatisticsSubscription()
StorageClient	createStorageClient()
TimeSubscription	createTimeSubscription()
CompletableFuture<LinkInfo>	disableLink(String instance, String link)
CompletableFuture<Void>	editAlarm(EditAlarmRequest request)
CompletableFuture<LinkInfo>	enableLink(String instance, String link)
String	getContext()
String	getHost()
CompletableFuture<YamcsInstance>	getInstance(String instance)
CompletableFuture<LeapSecondsTable>	getLeapSeconds()
MethodHandler	getMethodHandler()
CompletableFuture<UserInfo>	getOwnUserInfo()
int	getPort()
CompletableFuture<GetServerInfoResponse>	getServerInfo()
String	getUrl()
WebSocketClient	getWebSocketClient()
boolean	isConnected()
CompletableFuture<ListAlarmsResponse>	listAlarms(String instance)
CompletableFuture<ListProcessorAlarmsResponse>	listAlarms(String instance, String processor)
CompletableFuture<List<YamcsInstance>>	listInstances()
CompletableFuture<ListInstancesResponse>	listInstances(InstanceFilter filter)
CompletableFuture<List<ProcessorInfo>>	listProcessors(String instance)
CompletableFuture<List<ServiceInfo>>	listServices(String instance)
static YamcsClient.Builder	newBuilder(String host, int port)
void	pollServer()	Polls the server, to see if it is ready.
CompletableFuture<YamcsInstance>	restartInstance(String instance)
CompletableFuture<YamcsInstance>	startInstance(String instance)
CompletableFuture<Void>	startService(String instance, String service)
CompletableFuture<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 Detail

newBuilder

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

connectAnonymously

public void connectAnonymously()
                        throws ClientException

Establish a live communication channel without logging in to the server.

Throws:

ClientException

connectWithKerberos

public void connectWithKerberos()
                         throws ClientException

Throws:

ClientException

connect

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

Login to the server with user/password credential, and establish a live communication channel.

Throws:

ClientException

pollServer

public void pollServer()
                throws ClientException

Polls the server, to see if it is ready.

Throws:

ClientException

connect

public void connect(String accessToken,
                    boolean bypassUpCheck)
             throws ClientException

Establish a live communication channel using a previously acquired access token.

Throws:

ClientException

createInstance

public CompletableFuture<YamcsInstance> createInstance(CreateInstanceRequest request)

listInstances

public CompletableFuture<List<YamcsInstance>> listInstances()

getInstance

public CompletableFuture<YamcsInstance> getInstance(String instance)

listInstances

public CompletableFuture<ListInstancesResponse> listInstances(InstanceFilter filter)

startInstance

public CompletableFuture<YamcsInstance> startInstance(String instance)

stopInstance

public CompletableFuture<YamcsInstance> stopInstance(String instance)

restartInstance

public CompletableFuture<YamcsInstance> restartInstance(String instance)

listProcessors

public CompletableFuture<List<ProcessorInfo>> listProcessors(String instance)

getServerInfo

public CompletableFuture<GetServerInfoResponse> getServerInfo()

getOwnUserInfo

public CompletableFuture<UserInfo> getOwnUserInfo()

listServices

public CompletableFuture<List<ServiceInfo>> listServices(String instance)

startService

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

enableLink

public CompletableFuture<LinkInfo> enableLink(String instance,
                                              String link)

disableLink

public CompletableFuture<LinkInfo> disableLink(String instance,
                                               String link)

stopService

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

getLeapSeconds

public CompletableFuture<LeapSecondsTable> getLeapSeconds()

createProcessor

public CompletableFuture<ProcessorClient> createProcessor(CreateProcessorRequest request)

createEvent

public CompletableFuture<Yamcs.Event> createEvent(CreateEventRequest request)

listAlarms

public CompletableFuture<ListAlarmsResponse> listAlarms(String instance)

listAlarms

public CompletableFuture<ListProcessorAlarmsResponse> listAlarms(String instance,
                                                                 String processor)

editAlarm

public CompletableFuture<Void> editAlarm(EditAlarmRequest request)

createStorageClient

public StorageClient createStorageClient()

createArchiveClient

public ArchiveClient createArchiveClient(String instance)

createMissionDatabaseClient

public MissionDatabaseClient createMissionDatabaseClient(String instance)

createProcessorClient

public ProcessorClient createProcessorClient(String instance,
                                             String processor)

getHost

public String getHost()

getPort

public int getPort()

getContext

public String getContext()

isConnected

public boolean isConnected()

addConnectionListener

public void addConnectionListener(ConnectionListener connectionListener)

getWebSocketClient

public WebSocketClient getWebSocketClient()

getMethodHandler

public MethodHandler getMethodHandler()

getUrl

public String getUrl()

createTimeSubscription

public TimeSubscription createTimeSubscription()

createClearanceSubscription

public ClearanceSubscription createClearanceSubscription()

createEventSubscription

public EventSubscription createEventSubscription()

createAlarmSubscription

public AlarmSubscription createAlarmSubscription()

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()

close

public void close()