Package org.yamcs.http.api

Class InstancesApi

java.lang.Object

org.yamcs.protobuf.AbstractInstancesApi<Context>

org.yamcs.http.api.InstancesApi

All Implemented Interfaces:

Api<Context>

public class InstancesApi
extends AbstractInstancesApi<Context>

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	ALLOWED_INSTANCE_NAMES

Constructor Summary

Constructors

Constructor	Description
InstancesApi()

Method Summary

Modifier and Type	Method	Description
void	createInstance(Context ctx, CreateInstanceRequest request, Observer<YamcsInstance> observer)	Create an instance
void	getInstance(Context 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.
void	getInstanceTemplate(Context ctx, GetInstanceTemplateRequest request, Observer<InstanceTemplate> observer)	Get an instance template
void	listInstances(Context ctx, ListInstancesRequest request, Observer<ListInstancesResponse> observer)	List instances
void	listInstanceTemplates(Context ctx, com.google.protobuf.Empty request, Observer<ListInstanceTemplatesResponse> observer)	List instance templates
void	reconfigureInstance(Context 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.
void	restartInstance(Context ctx, RestartInstanceRequest request, Observer<YamcsInstance> observer)	Restart an instance If the instance state is RUNNING, the instance will be stopped and then restarted.
void	startInstance(Context ctx, StartInstanceRequest request, Observer<YamcsInstance> observer)	Start an instance If the instance is in the RUNNING state, this call will do nothing.
void	stopInstance(Context ctx, StopInstanceRequest request, Observer<YamcsInstance> observer)	Stop an instance Stop all services of the instance.
void	subscribeInstances(Context ctx, com.google.protobuf.Empty request, Observer<YamcsInstance> observer)	Receive instance updates
static String	verifyInstance(String instance)
static String	verifyInstance(String instance, boolean allowGlobal)
static YamcsServerInstance	verifyInstanceObj(String instance)

Methods inherited from class org.yamcs.protobuf.AbstractInstancesApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

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

Field Details

ALLOWED_INSTANCE_NAMES

public static final Pattern ALLOWED_INSTANCE_NAMES

Constructor Details

InstancesApi

public InstancesApi()

Method Details

listInstanceTemplates

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

Description copied from class: AbstractInstancesApi

  List instance templates
 

Specified by:

listInstanceTemplates in class AbstractInstancesApi<Context>

getInstanceTemplate

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

Description copied from class: AbstractInstancesApi

  Get an instance template
 

Specified by:

getInstanceTemplate in class AbstractInstancesApi<Context>

listInstances

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

Description copied from class: AbstractInstancesApi

  List instances
 

Specified by:

listInstances in class AbstractInstancesApi<Context>

subscribeInstances

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

Description copied from class: AbstractInstancesApi

  Receive instance updates
 

Specified by:

subscribeInstances in class AbstractInstancesApi<Context>

getInstance

public void getInstance(Context ctx,
 GetInstanceRequest request,
 Observer<YamcsInstance> observer)

Description copied from class: AbstractInstancesApi

  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 AbstractInstancesApi<Context>

reconfigureInstance

public void reconfigureInstance(Context ctx,
 ReconfigureInstanceRequest request,
 Observer<YamcsInstance> observer)

Description copied from class: AbstractInstancesApi

  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 AbstractInstancesApi<Context>

createInstance

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

Description copied from class: AbstractInstancesApi

  Create an instance
 

Specified by:

createInstance in class AbstractInstancesApi<Context>

startInstance

public void startInstance(Context ctx,
 StartInstanceRequest request,
 Observer<YamcsInstance> observer)

Description copied from class: AbstractInstancesApi

  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 AbstractInstancesApi<Context>

stopInstance

public void stopInstance(Context ctx,
 StopInstanceRequest request,
 Observer<YamcsInstance> observer)

Description copied from class: AbstractInstancesApi

  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 AbstractInstancesApi<Context>

restartInstance

public void restartInstance(Context ctx,
 RestartInstanceRequest request,
 Observer<YamcsInstance> observer)

Description copied from class: AbstractInstancesApi

  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 AbstractInstancesApi<Context>

verifyInstance

public static String verifyInstance(String instance,
 boolean allowGlobal)

verifyInstance

public static String verifyInstance(String instance)

verifyInstanceObj

public static YamcsServerInstance verifyInstanceObj(String instance)