Package org.yamcs.protobuf
Class AbstractManagementApi<T>
java.lang.Object
org.yamcs.protobuf.AbstractManagementApi<T>
- All Implemented Interfaces:
Api<T>
- Direct Known Subclasses:
ManagementApi
,ManagementApiClient
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
callMethod
(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, com.google.protobuf.Message request, Observer<com.google.protobuf.Message> future) final Observer<com.google.protobuf.Message>
callMethod
(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, Observer<com.google.protobuf.Message> future) abstract void
createInstance
(T ctx, CreateInstanceRequest request, Observer<YamcsInstance> observer) Create an instancefinal com.google.protobuf.Descriptors.ServiceDescriptor
abstract void
getInstance
(T ctx, GetInstanceRequest request, Observer<YamcsInstance> observer) Get an instance If an instance does not have web services enabled, it will be listed among the results, but none of its URLs will be filled in.abstract void
getInstanceTemplate
(T ctx, GetInstanceTemplateRequest request, Observer<InstanceTemplate> observer) Get an instance templatefinal com.google.protobuf.Message
getRequestPrototype
(com.google.protobuf.Descriptors.MethodDescriptor method) final com.google.protobuf.Message
getResponsePrototype
(com.google.protobuf.Descriptors.MethodDescriptor method) abstract void
getService
(T ctx, GetServiceRequest request, Observer<ServiceInfo> observer) Get a serviceabstract void
getSystemInfo
(T ctx, com.google.protobuf.Empty request, Observer<SystemInfo> observer) Get system infoabstract void
listInstances
(T ctx, ListInstancesRequest request, Observer<ListInstancesResponse> observer) List instancesabstract void
listInstanceTemplates
(T ctx, com.google.protobuf.Empty request, Observer<ListInstanceTemplatesResponse> observer) List instance templatesabstract void
listServices
(T ctx, ListServicesRequest request, Observer<ListServicesResponse> observer) List servicesabstract void
reconfigureInstance
(T ctx, ReconfigureInstanceRequest request, Observer<YamcsInstance> observer) Reconfigure a templated instance Regenerates the instance configuration based on the latest template source, and with optionally modified template variables.abstract void
restartInstance
(T ctx, RestartInstanceRequest request, Observer<YamcsInstance> observer) Restart an instance If the instance state is RUNNING, the instance will be stopped and then restarted.abstract void
startInstance
(T ctx, StartInstanceRequest request, Observer<YamcsInstance> observer) Start an instance If the instance is in the RUNNING state, this call will do nothing.abstract void
startService
(T ctx, StartServiceRequest request, Observer<com.google.protobuf.Empty> observer) Start a serviceabstract void
stopInstance
(T ctx, StopInstanceRequest request, Observer<YamcsInstance> observer) Stop an instance Stop all services of the instance.abstract void
stopService
(T ctx, StopServiceRequest request, Observer<com.google.protobuf.Empty> observer) Stop a service Once stopped, a service cannot be resumed.abstract void
subscribeInstances
(T ctx, com.google.protobuf.Empty request, Observer<YamcsInstance> observer) Receive instance updatesabstract void
subscribeSystemInfo
(T ctx, com.google.protobuf.Empty request, Observer<SystemInfo> observer) Receive system info updates
-
Constructor Details
-
AbstractManagementApi
public AbstractManagementApi()
-
-
Method Details
-
getSystemInfo
public abstract void getSystemInfo(T ctx, com.google.protobuf.Empty request, Observer<SystemInfo> observer) Get system info
-
subscribeSystemInfo
public abstract void subscribeSystemInfo(T ctx, com.google.protobuf.Empty request, Observer<SystemInfo> observer) Receive system info updates
-
listInstanceTemplates
public abstract void listInstanceTemplates(T ctx, com.google.protobuf.Empty request, Observer<ListInstanceTemplatesResponse> observer) List instance templates
-
getInstanceTemplate
public abstract void getInstanceTemplate(T ctx, GetInstanceTemplateRequest request, Observer<InstanceTemplate> observer) Get an instance template
-
listInstances
public abstract void listInstances(T ctx, ListInstancesRequest request, Observer<ListInstancesResponse> observer) List instances
-
subscribeInstances
public abstract void subscribeInstances(T ctx, com.google.protobuf.Empty request, Observer<YamcsInstance> observer) Receive instance updates
-
getInstance
public abstract void getInstance(T ctx, GetInstanceRequest request, Observer<YamcsInstance> observer) Get an instance If an instance does not have web services enabled, it will be listed among the results, but none of its URLs will be filled in.
-
createInstance
public abstract void createInstance(T ctx, CreateInstanceRequest request, Observer<YamcsInstance> observer) Create an instance
-
reconfigureInstance
public abstract void reconfigureInstance(T ctx, ReconfigureInstanceRequest request, Observer<YamcsInstance> observer) Reconfigure a templated instance Regenerates the instance configuration based on the latest template source, and with optionally modified template variables.
-
startInstance
public abstract void startInstance(T ctx, StartInstanceRequest request, Observer<YamcsInstance> observer) Start an instance If the instance is in the RUNNING state, this call will do nothing. Otherwise the instance will be started.
-
stopInstance
public abstract void stopInstance(T ctx, StopInstanceRequest request, Observer<YamcsInstance> observer) Stop an instance Stop all services of the instance. The instance state will be OFFLINE. If the instance state is already OFFLINE, this call will do nothing.
-
restartInstance
public abstract void restartInstance(T ctx, RestartInstanceRequest request, Observer<YamcsInstance> observer) Restart an instance If the instance state is RUNNING, the instance will be stopped and then restarted. Otherwise the instance will be started. Note that the Mission Database will also be reloaded before restart.
-
listServices
public abstract void listServices(T ctx, ListServicesRequest request, Observer<ListServicesResponse> observer) List services
-
getService
Get a service
-
startService
public abstract void startService(T ctx, StartServiceRequest request, Observer<com.google.protobuf.Empty> observer) Start a service
-
stopService
public abstract void stopService(T ctx, StopServiceRequest request, Observer<com.google.protobuf.Empty> observer) Stop a service Once stopped, a service cannot be resumed. Instead a new service instance will be created and started.
-
getDescriptorForType
public final com.google.protobuf.Descriptors.ServiceDescriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfaceApi<T>
-
getRequestPrototype
public final com.google.protobuf.Message getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method) - Specified by:
getRequestPrototype
in interfaceApi<T>
-
getResponsePrototype
public final com.google.protobuf.Message getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method) - Specified by:
getResponsePrototype
in interfaceApi<T>
-
callMethod
public final void callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, com.google.protobuf.Message request, Observer<com.google.protobuf.Message> future) - Specified by:
callMethod
in interfaceApi<T>
-
callMethod
public final Observer<com.google.protobuf.Message> callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, Observer<com.google.protobuf.Message> future) - Specified by:
callMethod
in interfaceApi<T>
-