Package org.yamcs.http.api

Class ManagementApi

  • All Implemented Interfaces:
    org.yamcs.api.Api<Context>
    public class ManagementApi
extends org.yamcs.protobuf.AbstractManagementApi<Context>

    • Constructor Summary

      Constructors 
      Constructor Description
      ManagementApi()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      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 getLink​(Context ctx, org.yamcs.protobuf.GetLinkRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.LinkInfo> 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 listLinks​(Context ctx, org.yamcs.protobuf.ListLinksRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ListLinksResponse> observer)  
      void listServices​(Context ctx, org.yamcs.protobuf.ListServicesRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ListServicesResponse> 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 subscribeLinks​(Context ctx, org.yamcs.protobuf.SubscribeLinksRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.LinkEvent> 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)  
      void updateLink​(Context ctx, org.yamcs.protobuf.EditLinkRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.LinkInfo> observer)  
      static String verifyInstance​(String instance)  
      static String verifyInstance​(String instance, boolean allowGlobal)  
      static YamcsServerInstance verifyInstanceObj​(String instance)  
      static org.yamcs.protobuf.LinkInfo verifyLink​(String instance, String linkName)  

      • Methods inherited from class org.yamcs.protobuf.AbstractManagementApi

        callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

    • Field Detail

      • ALLOWED_INSTANCE_NAMES

        public static final Pattern ALLOWED_INSTANCE_NAMES

    • Constructor Detail

      • ManagementApi

        public ManagementApi()

    • Method Detail

      • 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>

      • 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>

      • listLinks

        public void listLinks​(Context ctx,
                      org.yamcs.protobuf.ListLinksRequest request,
                      org.yamcs.api.Observer<org.yamcs.protobuf.ListLinksResponse> observer)
        Specified by:
        listLinks in class org.yamcs.protobuf.AbstractManagementApi<Context>

      • subscribeLinks

        public void subscribeLinks​(Context ctx,
                           org.yamcs.protobuf.SubscribeLinksRequest request,
                           org.yamcs.api.Observer<org.yamcs.protobuf.LinkEvent> observer)
        Specified by:
        subscribeLinks in class org.yamcs.protobuf.AbstractManagementApi<Context>

      • getLink

        public void getLink​(Context ctx,
                    org.yamcs.protobuf.GetLinkRequest request,
                    org.yamcs.api.Observer<org.yamcs.protobuf.LinkInfo> observer)
        Specified by:
        getLink in class org.yamcs.protobuf.AbstractManagementApi<Context>

      • updateLink

        public void updateLink​(Context ctx,
                       org.yamcs.protobuf.EditLinkRequest request,
                       org.yamcs.api.Observer<org.yamcs.protobuf.LinkInfo> observer)
        Specified by:
        updateLink in class org.yamcs.protobuf.AbstractManagementApi<Context>

      • toServiceInfo

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

      • verifyInstance

        public static String verifyInstance​(String instance,
                                    boolean allowGlobal)

      • verifyInstance

        public static String verifyInstance​(String instance)

      • verifyLink

        public static org.yamcs.protobuf.LinkInfo verifyLink​(String instance,
                                                     String linkName)