Module org.yamcs.api

Package org.yamcs.protobuf

Class ManagementApiClient

java.lang.Object

org.yamcs.protobuf.AbstractManagementApi<Void>

org.yamcs.protobuf.ManagementApiClient

All Implemented Interfaces:

Api<Void>

public class ManagementApiClient
extends AbstractManagementApi<Void>

Constructor Summary

Constructors

Constructor	Description
ManagementApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	createInstance(Void ctx, CreateInstanceRequest request, Observer<YamcsInstance> observer)	Create an instance
final void	getInstance(Void 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.
final void	getInstanceTemplate(Void ctx, GetInstanceTemplateRequest request, Observer<InstanceTemplate> observer)	Get an instance template
final void	getService(Void ctx, GetServiceRequest request, Observer<ServiceInfo> observer)	Get a service
final void	getSystemInfo(Void ctx, com.google.protobuf.Empty request, Observer<SystemInfo> observer)	Get system info
final void	listInstances(Void ctx, ListInstancesRequest request, Observer<ListInstancesResponse> observer)	List instances
final void	listInstanceTemplates(Void ctx, com.google.protobuf.Empty request, Observer<ListInstanceTemplatesResponse> observer)	List instance templates
final void	listServices(Void ctx, ListServicesRequest request, Observer<ListServicesResponse> observer)	List services
final void	reconfigureInstance(Void 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.
final void	restartInstance(Void ctx, RestartInstanceRequest request, Observer<YamcsInstance> observer)	Restart an instance If the instance state is RUNNING, the instance will be stopped and then restarted.
final void	startInstance(Void ctx, StartInstanceRequest request, Observer<YamcsInstance> observer)	Start an instance If the instance is in the RUNNING state, this call will do nothing.
final void	startService(Void ctx, StartServiceRequest request, Observer<com.google.protobuf.Empty> observer)	Start a service
final void	stopInstance(Void ctx, StopInstanceRequest request, Observer<YamcsInstance> observer)	Stop an instance Stop all services of the instance.
final void	stopService(Void ctx, StopServiceRequest request, Observer<com.google.protobuf.Empty> observer)	Stop a service Once stopped, a service cannot be resumed.
final void	subscribeInstances(Void ctx, com.google.protobuf.Empty request, Observer<YamcsInstance> observer)	Receive instance updates

Methods inherited from class org.yamcs.protobuf.AbstractManagementApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

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

Constructor Details

ManagementApiClient

public ManagementApiClient(MethodHandler handler)

Method Details

getSystemInfo

public final void getSystemInfo(Void ctx,
 com.google.protobuf.Empty request,
 Observer<SystemInfo> observer)

  Get system info
 

Specified by:

getSystemInfo in class AbstractManagementApi<Void>

listInstanceTemplates

public final void listInstanceTemplates(Void ctx,
 com.google.protobuf.Empty request,
 Observer<ListInstanceTemplatesResponse> observer)

  List instance templates
 

Specified by:

listInstanceTemplates in class AbstractManagementApi<Void>

getInstanceTemplate

public final void getInstanceTemplate(Void ctx,
 GetInstanceTemplateRequest request,
 Observer<InstanceTemplate> observer)

  Get an instance template
 

Specified by:

getInstanceTemplate in class AbstractManagementApi<Void>

listInstances

public final void listInstances(Void ctx,
 ListInstancesRequest request,
 Observer<ListInstancesResponse> observer)

  List instances
 

Specified by:

listInstances in class AbstractManagementApi<Void>

subscribeInstances

public final void subscribeInstances(Void ctx,
 com.google.protobuf.Empty request,
 Observer<YamcsInstance> observer)

  Receive instance updates
 

Specified by:

subscribeInstances in class AbstractManagementApi<Void>

getInstance

public final void getInstance(Void 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.
 

Specified by:

getInstance in class AbstractManagementApi<Void>

createInstance

public final void createInstance(Void ctx,
 CreateInstanceRequest request,
 Observer<YamcsInstance> observer)

  Create an instance
 

Specified by:

createInstance in class AbstractManagementApi<Void>

reconfigureInstance

public final void reconfigureInstance(Void 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.
 

Specified by:

reconfigureInstance in class AbstractManagementApi<Void>

startInstance

public final void startInstance(Void 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.
 

Specified by:

startInstance in class AbstractManagementApi<Void>

stopInstance

public final void stopInstance(Void 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.
 

Specified by:

stopInstance in class AbstractManagementApi<Void>

restartInstance

public final void restartInstance(Void 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.
 

Specified by:

restartInstance in class AbstractManagementApi<Void>

listServices

public final void listServices(Void ctx,
 ListServicesRequest request,
 Observer<ListServicesResponse> observer)

  List services
 

Specified by:

listServices in class AbstractManagementApi<Void>

getService

public final void getService(Void ctx,
 GetServiceRequest request,
 Observer<ServiceInfo> observer)

  Get a service
 

Specified by:

getService in class AbstractManagementApi<Void>

startService

public final void startService(Void ctx,
 StartServiceRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Start a service
 

Specified by:

startService in class AbstractManagementApi<Void>

stopService

public final void stopService(Void 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.
 

Specified by:

stopService in class AbstractManagementApi<Void>