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

Class MdbApi

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    MdbApi()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    batchGetParameters(Context ctx, org.yamcs.protobuf.Mdb.BatchGetParametersRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.BatchGetParametersResponse> observer)
    Batch get of multiple parameters
    void
    createParameter(Context ctx, org.yamcs.protobuf.Mdb.CreateParameterRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ParameterInfo> observer)
    Create a parameter
    void
    createParameterType(Context ctx, org.yamcs.protobuf.Mdb.CreateParameterTypeRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ParameterTypeInfo> observer)
    Create a parameter type
    void
    exportJavaMissionDatabase(Context ctx, org.yamcs.protobuf.Mdb.ExportJavaMissionDatabaseRequest request, org.yamcs.api.Observer<org.yamcs.api.HttpBody> observer)
    Export a java serialized dump of the mission database
    void
    exportXtce(Context ctx, org.yamcs.protobuf.Mdb.ExportXtceRequest request, org.yamcs.api.Observer<org.yamcs.api.HttpBody> observer)
    Export an XTCE representation of a space system.
    void
    getAlgorithm(Context ctx, org.yamcs.protobuf.Mdb.GetAlgorithmRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.AlgorithmInfo> observer)
    Get an algorithm
    void
    getCommand(Context ctx, org.yamcs.protobuf.Mdb.GetCommandRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.CommandInfo> observer)
    Get a command
    void
    getContainer(Context ctx, org.yamcs.protobuf.Mdb.GetContainerRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ContainerInfo> observer)
    Get a container
    void
    getMissionDatabase(Context ctx, org.yamcs.protobuf.Mdb.GetMissionDatabaseRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.MissionDatabase> observer)
    Get a mission database
    void
    getParameter(Context ctx, org.yamcs.protobuf.Mdb.GetParameterRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ParameterInfo> observer)
    Get a parameter
    void
    getParameterType(Context ctx, org.yamcs.protobuf.Mdb.GetParameterTypeRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ParameterTypeInfo> observer)
    Get a parameter type
    void
    getSpaceSystem(Context ctx, org.yamcs.protobuf.Mdb.GetSpaceSystemRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.SpaceSystemInfo> observer)
    Get a space system
    void
    listAlgorithms(Context ctx, org.yamcs.protobuf.Mdb.ListAlgorithmsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListAlgorithmsResponse> observer)
    List algorithms
    void
    listCommands(Context ctx, org.yamcs.protobuf.Mdb.ListCommandsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListCommandsResponse> observer)
    List commands
    void
    listContainers(Context ctx, org.yamcs.protobuf.Mdb.ListContainersRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListContainersResponse> observer)
    List containers
    void
    listParameters(Context ctx, org.yamcs.protobuf.Mdb.ListParametersRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListParametersResponse> observer)
    List parameters
    void
    listParameterTypes(Context ctx, org.yamcs.protobuf.Mdb.ListParameterTypesRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListParameterTypesResponse> observer)
    List parameter types
    void
    listSpaceSystems(Context ctx, org.yamcs.protobuf.Mdb.ListSpaceSystemsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListSpaceSystemsResponse> observer)
    List space systems
    void
    streamMissionDatabase(Context ctx, org.yamcs.protobuf.Mdb.StreamMissionDatabaseRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.MissionDatabaseItem> observer)
    Stream Mission Database items.
    static org.yamcs.protobuf.Mdb.MissionDatabase
    toMissionDatabase(String instanceName, Mdb mdb)
     
    static org.yamcs.xtce.Parameter
    verifyParameter(Context ctx, Mdb mdb, String pathName)
     

    Methods inherited from class org.yamcs.protobuf.AbstractMdbApi

    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

    • MdbApi

      public MdbApi()

  • Method Details

    • getMissionDatabase

      public void getMissionDatabase(Context ctx, org.yamcs.protobuf.Mdb.GetMissionDatabaseRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.MissionDatabase> observer)
      Description copied from class: AbstractMdbApi
        Get a mission database
      Specified by:
      getMissionDatabase in class AbstractMdbApi<Context>

    • exportJavaMissionDatabase

      public void exportJavaMissionDatabase(Context ctx, org.yamcs.protobuf.Mdb.ExportJavaMissionDatabaseRequest request, org.yamcs.api.Observer<org.yamcs.api.HttpBody> observer)
      Description copied from class: AbstractMdbApi
        Export a java serialized dump of the mission database
      Specified by:
      exportJavaMissionDatabase in class AbstractMdbApi<Context>

    • streamMissionDatabase

      public void streamMissionDatabase(Context ctx, org.yamcs.protobuf.Mdb.StreamMissionDatabaseRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.MissionDatabaseItem> observer)
      Description copied from class: AbstractMdbApi
        Stream Mission Database items.
 
  This operation is intended for tools that need to efficiently fetch
  the full list of parameters or commands, without using repeated
  pagination-based requests.
      Specified by:
      streamMissionDatabase in class AbstractMdbApi<Context>

    • listSpaceSystems

      public void listSpaceSystems(Context ctx, org.yamcs.protobuf.Mdb.ListSpaceSystemsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListSpaceSystemsResponse> observer)
      Description copied from class: AbstractMdbApi
        List space systems
      Specified by:
      listSpaceSystems in class AbstractMdbApi<Context>

    • exportXtce

      public void exportXtce(Context ctx, org.yamcs.protobuf.Mdb.ExportXtceRequest request, org.yamcs.api.Observer<org.yamcs.api.HttpBody> observer)
      Description copied from class: AbstractMdbApi
        Export an XTCE representation of a space system.
 
  If the requested space system is not the root, containers will have
  their qualified name stripped by the top name. In addition there may
  also be references to objects from space systems that are not part of
  the export.
      Specified by:
      exportXtce in class AbstractMdbApi<Context>

    • getSpaceSystem

      public void getSpaceSystem(Context ctx, org.yamcs.protobuf.Mdb.GetSpaceSystemRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.SpaceSystemInfo> observer)
      Description copied from class: AbstractMdbApi
        Get a space system
      Specified by:
      getSpaceSystem in class AbstractMdbApi<Context>

    • listParameters

      public void listParameters(Context ctx, org.yamcs.protobuf.Mdb.ListParametersRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListParametersResponse> observer)
      Description copied from class: AbstractMdbApi
        List parameters
      Specified by:
      listParameters in class AbstractMdbApi<Context>

    • getParameter

      public void getParameter(Context ctx, org.yamcs.protobuf.Mdb.GetParameterRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ParameterInfo> observer)
      Description copied from class: AbstractMdbApi
        Get a parameter
      Specified by:
      getParameter in class AbstractMdbApi<Context>

    • createParameterType

      public void createParameterType(Context ctx, org.yamcs.protobuf.Mdb.CreateParameterTypeRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ParameterTypeInfo> observer)
      Description copied from class: AbstractMdbApi
        Create a parameter type
      Specified by:
      createParameterType in class AbstractMdbApi<Context>

    • createParameter

      public void createParameter(Context ctx, org.yamcs.protobuf.Mdb.CreateParameterRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ParameterInfo> observer)
      Description copied from class: AbstractMdbApi
        Create a parameter
      Specified by:
      createParameter in class AbstractMdbApi<Context>

    • batchGetParameters

      public void batchGetParameters(Context ctx, org.yamcs.protobuf.Mdb.BatchGetParametersRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.BatchGetParametersResponse> observer)
      Description copied from class: AbstractMdbApi
        Batch get of multiple parameters
      Specified by:
      batchGetParameters in class AbstractMdbApi<Context>

    • listParameterTypes

      public void listParameterTypes(Context ctx, org.yamcs.protobuf.Mdb.ListParameterTypesRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListParameterTypesResponse> observer)
      Description copied from class: AbstractMdbApi
        List parameter types
      Specified by:
      listParameterTypes in class AbstractMdbApi<Context>

    • getParameterType

      public void getParameterType(Context ctx, org.yamcs.protobuf.Mdb.GetParameterTypeRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ParameterTypeInfo> observer)
      Description copied from class: AbstractMdbApi
        Get a parameter type
      Specified by:
      getParameterType in class AbstractMdbApi<Context>

    • listContainers

      public void listContainers(Context ctx, org.yamcs.protobuf.Mdb.ListContainersRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListContainersResponse> observer)
      Description copied from class: AbstractMdbApi
        List containers
      Specified by:
      listContainers in class AbstractMdbApi<Context>

    • getContainer

      public void getContainer(Context ctx, org.yamcs.protobuf.Mdb.GetContainerRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ContainerInfo> observer)
      Description copied from class: AbstractMdbApi
        Get a container
      Specified by:
      getContainer in class AbstractMdbApi<Context>

    • listCommands

      public void listCommands(Context ctx, org.yamcs.protobuf.Mdb.ListCommandsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListCommandsResponse> observer)
      Description copied from class: AbstractMdbApi
        List commands
      Specified by:
      listCommands in class AbstractMdbApi<Context>

    • getCommand

      public void getCommand(Context ctx, org.yamcs.protobuf.Mdb.GetCommandRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.CommandInfo> observer)
      Description copied from class: AbstractMdbApi
        Get a command
      Specified by:
      getCommand in class AbstractMdbApi<Context>

    • listAlgorithms

      public void listAlgorithms(Context ctx, org.yamcs.protobuf.Mdb.ListAlgorithmsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.ListAlgorithmsResponse> observer)
      Description copied from class: AbstractMdbApi
        List algorithms
      Specified by:
      listAlgorithms in class AbstractMdbApi<Context>

    • getAlgorithm

      public void getAlgorithm(Context ctx, org.yamcs.protobuf.Mdb.GetAlgorithmRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.Mdb.AlgorithmInfo> observer)
      Description copied from class: AbstractMdbApi
        Get an algorithm
      Specified by:
      getAlgorithm in class AbstractMdbApi<Context>

    • verifyParameter

      public static org.yamcs.xtce.Parameter verifyParameter(Context ctx, Mdb mdb, String pathName)

    • toMissionDatabase

      public static org.yamcs.protobuf.Mdb.MissionDatabase toMissionDatabase(String instanceName, Mdb mdb)