java.lang.Object
org.yamcs.client.YamcsClient
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addConnectionListener
(ConnectionListener connectionListener) void
close()
void
Establish a live communication channel.createArchiveClient
(String instance) CompletableFuture<org.yamcs.protobuf.Event>
createEvent
(org.yamcs.protobuf.CreateEventRequest request) CompletableFuture<org.yamcs.protobuf.YamcsInstance>
createInstance
(org.yamcs.protobuf.CreateInstanceRequest request) createMissionDatabaseClient
(String instance) createProcessor
(org.yamcs.protobuf.CreateProcessorRequest request) createProcessorClient
(String instance, String processor) createTimelineClient
(String instance, String processor) CompletableFuture<org.yamcs.protobuf.links.LinkInfo>
disableLink
(String instance, String link) editAlarm
(org.yamcs.protobuf.alarms.EditAlarmRequest request) CompletableFuture<org.yamcs.protobuf.links.LinkInfo>
enableLink
(String instance, String link) CompletableFuture<List<org.yamcs.protobuf.FileTransferServiceInfo>>
getFileTransferServices
(String instance) getHost()
CompletableFuture<org.yamcs.protobuf.YamcsInstance>
getInstance
(String instance) CompletableFuture<org.yamcs.protobuf.LeapSecondsTable>
org.yamcs.api.MethodHandler
CompletableFuture<org.yamcs.protobuf.UserInfo>
int
getPort()
CompletableFuture<org.yamcs.protobuf.GetServerInfoResponse>
getUrl()
boolean
isTLS()
boolean
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>>
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
void
void
loginWithKerberos
(String principal) static YamcsClient.Builder
newBuilder
(String serverUrl) static YamcsClient.Builder
newBuilder
(String host, int port) void
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) startService
(String instance, String service) CompletableFuture<org.yamcs.protobuf.YamcsInstance>
stopInstance
(String instance) stopService
(String instance, String service)
-
Method Details
-
newBuilder
-
newBuilder
-
loginWithKerberos
- Throws:
ClientException
-
loginWithKerberos
- Throws:
ClientException
-
login
- Throws:
ClientException
-
pollServer
Polls the server, to see if it is ready.- Throws:
ClientException
-
connectWebSocket
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
-
getInstance
-
listInstances
public CompletableFuture<org.yamcs.protobuf.ListInstancesResponse> listInstances(InstanceFilter filter) -
startInstance
-
stopInstance
-
restartInstance
-
listProcessors
-
getServerInfo
-
getServerURL
-
getOwnUserInfo
-
listServices
-
startService
-
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
-
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
-
listAlarms
public CompletableFuture<org.yamcs.protobuf.alarms.ListProcessorAlarmsResponse> listAlarms(String instance, String processor) -
editAlarm
-
getFileTransferServices
public CompletableFuture<List<org.yamcs.protobuf.FileTransferServiceInfo>> getFileTransferServices(String instance) -
createStorageClient
-
createArchiveClient
-
createMissionDatabaseClient
-
createProcessorClient
-
createTimelineClient
-
getHost
-
getPort
public int getPort() -
isTLS
public boolean isTLS() -
getContext
-
isVerifyTLS
public boolean isVerifyTLS() -
addConnectionListener
-
removeConnectionListener
-
getWebSocketClient
-
getMethodHandler
public org.yamcs.api.MethodHandler getMethodHandler() -
getUrl
-
createTimeSubscription
-
createClearanceSubscription
-
createEventSubscription
-
createAlarmSubscription
-
createGlobalAlarmStatusSubscription
-
createPacketSubscription
-
createProcessorSubscription
-
createCommandSubscription
-
createQueueEventSubscription
-
createQueueStatisticsSubscription
-
createParameterSubscription
-
createLinkSubscription
-
createContainerSubscription
-
close
public void close()
-