Package org.yamcs.http.api

Class ProcessingApi

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

    • Constructor Summary

      Constructors 
      Constructor Description
      ProcessingApi()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void batchGetParameterValues​(Context ctx, org.yamcs.protobuf.BatchGetParameterValuesRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.BatchGetParameterValuesResponse> observer)  
      void batchSetParameterValues​(Context ctx, org.yamcs.protobuf.BatchSetParameterValuesRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)  
      void createProcessor​(Context ctx, org.yamcs.protobuf.CreateProcessorRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)  
      void deleteProcessor​(Context ctx, org.yamcs.protobuf.DeleteProcessorRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)  
      void editProcessor​(Context ctx, org.yamcs.protobuf.EditProcessorRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)  
      void getParameterValue​(Context ctx, org.yamcs.protobuf.GetParameterValueRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Pvalue.ParameterValue> observer)  
      void getProcessor​(Context ctx, org.yamcs.protobuf.GetProcessorRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ProcessorInfo> observer)  
      void listProcessors​(Context ctx, org.yamcs.protobuf.ListProcessorsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ListProcessorsResponse> observer)  
      void listProcessorTypes​(Context ctx, com.google.protobuf.Empty request, org.yamcs.api.Observer<org.yamcs.protobuf.ListProcessorTypesResponse> observer)  
      void setParameterValue​(Context ctx, org.yamcs.protobuf.SetParameterValueRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)  
      org.yamcs.api.Observer<org.yamcs.protobuf.SubscribeParametersRequest> subscribeParameters​(Context ctx, org.yamcs.api.Observer<org.yamcs.protobuf.SubscribeParametersData> observer)  
      void subscribeProcessors​(Context ctx, org.yamcs.protobuf.SubscribeProcessorsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.ProcessorInfo> observer)  
      void subscribeTMStatistics​(Context ctx, org.yamcs.protobuf.SubscribeTMStatisticsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Statistics> observer)  
      static org.yamcs.protobuf.ProcessorInfo toProcessorInfo​(Processor processor)  
      static void verifyClientsBelongToUser​(String username, Set<Integer> clientIds)
      verifies that clients with ids are all belonging to this username.
      static Processor verifyProcessor​(String instance, String processorName)  

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

        callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

    • Constructor Detail

      • ProcessingApi

        public ProcessingApi()

    • Method Detail

      • listProcessorTypes

        public void listProcessorTypes​(Context ctx,
                               com.google.protobuf.Empty request,
                               org.yamcs.api.Observer<org.yamcs.protobuf.ListProcessorTypesResponse> observer)
        Specified by:
        listProcessorTypes in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • listProcessors

        public void listProcessors​(Context ctx,
                           org.yamcs.protobuf.ListProcessorsRequest request,
                           org.yamcs.api.Observer<org.yamcs.protobuf.ListProcessorsResponse> observer)
        Specified by:
        listProcessors in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • getProcessor

        public void getProcessor​(Context ctx,
                         org.yamcs.protobuf.GetProcessorRequest request,
                         org.yamcs.api.Observer<org.yamcs.protobuf.ProcessorInfo> observer)
        Specified by:
        getProcessor in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • deleteProcessor

        public void deleteProcessor​(Context ctx,
                            org.yamcs.protobuf.DeleteProcessorRequest request,
                            org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
        Specified by:
        deleteProcessor in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • createProcessor

        public void createProcessor​(Context ctx,
                            org.yamcs.protobuf.CreateProcessorRequest request,
                            org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
        Specified by:
        createProcessor in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • editProcessor

        public void editProcessor​(Context ctx,
                          org.yamcs.protobuf.EditProcessorRequest request,
                          org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
        Specified by:
        editProcessor in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • getParameterValue

        public void getParameterValue​(Context ctx,
                              org.yamcs.protobuf.GetParameterValueRequest request,
                              org.yamcs.api.Observer<org.yamcs.protobuf.Pvalue.ParameterValue> observer)
        Specified by:
        getParameterValue in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • setParameterValue

        public void setParameterValue​(Context ctx,
                              org.yamcs.protobuf.SetParameterValueRequest request,
                              org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
        Specified by:
        setParameterValue in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • subscribeParameters

        public org.yamcs.api.Observer<org.yamcs.protobuf.SubscribeParametersRequest> subscribeParameters​(Context ctx,
                                                                                                 org.yamcs.api.Observer<org.yamcs.protobuf.SubscribeParametersData> observer)
        Specified by:
        subscribeParameters in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • subscribeProcessors

        public void subscribeProcessors​(Context ctx,
                                org.yamcs.protobuf.SubscribeProcessorsRequest request,
                                org.yamcs.api.Observer<org.yamcs.protobuf.ProcessorInfo> observer)
        Specified by:
        subscribeProcessors in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • batchGetParameterValues

        public void batchGetParameterValues​(Context ctx,
                                    org.yamcs.protobuf.BatchGetParameterValuesRequest request,
                                    org.yamcs.api.Observer<org.yamcs.protobuf.BatchGetParameterValuesResponse> observer)
        Specified by:
        batchGetParameterValues in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • batchSetParameterValues

        public void batchSetParameterValues​(Context ctx,
                                    org.yamcs.protobuf.BatchSetParameterValuesRequest request,
                                    org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
        Specified by:
        batchSetParameterValues in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • subscribeTMStatistics

        public void subscribeTMStatistics​(Context ctx,
                                  org.yamcs.protobuf.SubscribeTMStatisticsRequest request,
                                  org.yamcs.api.Observer<org.yamcs.protobuf.Statistics> observer)
        Specified by:
        subscribeTMStatistics in class org.yamcs.protobuf.AbstractProcessingApi<Context>

      • toProcessorInfo

        public static org.yamcs.protobuf.ProcessorInfo toProcessorInfo​(Processor processor)

      • verifyClientsBelongToUser

        public static void verifyClientsBelongToUser​(String username,
                                             Set<Integer> clientIds)
                                      throws ForbiddenException
        verifies that clients with ids are all belonging to this username. If not, throw a ForbiddenException If there is any invalid id (maybe client disconnected), remove it from the set
        Throws:
        ForbiddenException