Module org.yamcs.core
Package org.yamcs.http.api

Class ManagementApi

java.lang.Object
org.yamcs.protobuf.AbstractManagementApi<Context>
org.yamcs.http.api.ManagementApi
All Implemented Interfaces:
org.yamcs.api.Api<Context>
public class ManagementApi extends org.yamcs.protobuf.AbstractManagementApi<Context>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Pattern
    ALLOWED_INSTANCE_NAMES
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ManagementApi()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createInstance(Context ctx, org.yamcs.protobuf.CreateInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
     
    void
    getInstance(Context ctx, org.yamcs.protobuf.GetInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
     
    void
    getInstanceTemplate(Context ctx, org.yamcs.protobuf.GetInstanceTemplateRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.InstanceTemplate> observer)
     
    void
    getService(Context ctx, org.yamcs.protobuf.GetServiceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ServiceInfo> observer)
     
    void
    getSystemInfo(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.SystemInfo> observer)
     
    void
    listInstances(Context ctx, org.yamcs.protobuf.ListInstancesRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ListInstancesResponse> observer)
     
    void
    listInstanceTemplates(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.ListInstanceTemplatesResponse> observer)
     
    void
    listServices(Context ctx, org.yamcs.protobuf.ListServicesRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ListServicesResponse> observer)
     
    void
    reconfigureInstance(Context ctx, org.yamcs.protobuf.ReconfigureInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
     
    void
    restartInstance(Context ctx, org.yamcs.protobuf.RestartInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
     
    void
    startInstance(Context ctx, org.yamcs.protobuf.StartInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
     
    void
    startService(Context ctx, org.yamcs.protobuf.StartServiceRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
     
    void
    stopInstance(Context ctx, org.yamcs.protobuf.StopInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
     
    void
    stopService(Context ctx, org.yamcs.protobuf.StopServiceRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
     
    void
    subscribeInstances(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
     
    void
    subscribeSystemInfo(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.SystemInfo> observer)
     
    static org.yamcs.protobuf.ServiceInfo
    toServiceInfo(ProcessorServiceWithConfig serviceWithConfig, String instance, String processor)
     
    static org.yamcs.protobuf.ServiceInfo
    toServiceInfo(ServiceWithConfig serviceWithConfig, String instance, String processor)
     
    static String
    verifyInstance(String instance)
     
    static String
    verifyInstance(String instance, boolean allowGlobal)
     
    static YamcsServerInstance
    verifyInstanceObj(String instance)
     

    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

  • Field Details

    • ALLOWED_INSTANCE_NAMES

      public static final Pattern ALLOWED_INSTANCE_NAMES

  • Constructor Details

    • ManagementApi

      public ManagementApi()

  • Method Details

    • subscribeSystemInfo

      public void subscribeSystemInfo(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.SystemInfo> observer)
      Specified by:
      subscribeSystemInfo in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • getSystemInfo

      public void getSystemInfo(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.SystemInfo> observer)
      Specified by:
      getSystemInfo in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • listInstanceTemplates

      public void listInstanceTemplates(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.ListInstanceTemplatesResponse> observer)
      Specified by:
      listInstanceTemplates in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • getInstanceTemplate

      public void getInstanceTemplate(Context ctx, org.yamcs.protobuf.GetInstanceTemplateRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.InstanceTemplate> observer)
      Specified by:
      getInstanceTemplate in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • listInstances

      public void listInstances(Context ctx, org.yamcs.protobuf.ListInstancesRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ListInstancesResponse> observer)
      Specified by:
      listInstances in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • subscribeInstances

      public void subscribeInstances(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
      Specified by:
      subscribeInstances in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • getInstance

      public void getInstance(Context ctx, org.yamcs.protobuf.GetInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
      Specified by:
      getInstance in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • reconfigureInstance

      public void reconfigureInstance(Context ctx, org.yamcs.protobuf.ReconfigureInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
      Specified by:
      reconfigureInstance in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • createInstance

      public void createInstance(Context ctx, org.yamcs.protobuf.CreateInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
      Specified by:
      createInstance in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • startInstance

      public void startInstance(Context ctx, org.yamcs.protobuf.StartInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
      Specified by:
      startInstance in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • stopInstance

      public void stopInstance(Context ctx, org.yamcs.protobuf.StopInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
      Specified by:
      stopInstance in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • restartInstance

      public void restartInstance(Context ctx, org.yamcs.protobuf.RestartInstanceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.YamcsInstance> observer)
      Specified by:
      restartInstance in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • listServices

      public void listServices(Context ctx, org.yamcs.protobuf.ListServicesRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ListServicesResponse> observer)
      Specified by:
      listServices in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • getService

      public void getService(Context ctx, org.yamcs.protobuf.GetServiceRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ServiceInfo> observer)
      Specified by:
      getService in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • startService

      public void startService(Context ctx, org.yamcs.protobuf.StartServiceRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
      Specified by:
      startService in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • stopService

      public void stopService(Context ctx, org.yamcs.protobuf.StopServiceRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
      Specified by:
      stopService in class org.yamcs.protobuf.AbstractManagementApi<Context>

    • toServiceInfo

      public static org.yamcs.protobuf.ServiceInfo toServiceInfo(ServiceWithConfig serviceWithConfig, String instance, String processor)

    • toServiceInfo

      public static org.yamcs.protobuf.ServiceInfo toServiceInfo(ProcessorServiceWithConfig serviceWithConfig, String instance, String processor)

    • verifyInstance

      public static String verifyInstance(String instance, boolean allowGlobal)

    • verifyInstance

      public static String verifyInstance(String instance)

    • verifyInstanceObj

      public static YamcsServerInstance verifyInstanceObj(String instance)