org.ccsds.moims.mo.common.directory.consumer.DirectoryAdapter Maven / Gradle / Ivy

package org.ccsds.moims.mo.common.directory.consumer;

/**
 * Consumer adapter for Directory service.
 */
public abstract class DirectoryAdapter extends org.ccsds.moims.mo.mal.consumer.MALInteractionAdapter {

    /**
     * Called by the MAL when a REQUEST response is received from a provider for 
     * the operation lookupProvider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param matchingProviders The operation shall return a list of service providers 
     * that match the filter. 
     * If no service providers match the supplied filter then an empty list shall 
     * be returned. 
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     */
    public void lookupProviderResponseReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.common.directory.structures.ProviderSummaryList matchingProviders,
            java.util.Map qosProperties) {
    }

    /**
     * Called by the MAL when a REQUEST response error is received from a provider 
     * for the operation lookupProvider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param error error The received error message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     */
    public void lookupProviderErrorReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.mal.MOErrorException error,
            java.util.Map qosProperties) {
    }

    /**
     * Called by the MAL when a REQUEST response is received from a provider for 
     * the operation publishProvider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param providerObjId If the providerId field of the PublishDetails structure 
     * matches an existing ServiceProvider COM object, the operation shall update 
     * the existing details of that provider. 
     * If the providerId field of the PublishDetails structure does not match 
     * an existing ServiceProvider COM object, then the operation shall create 
     * a new ServiceProvider COM object to represent the new service provider. 
     * A new ProviderCapabilities COM object shall be created to store the capabilities 
     * of the provider. 
     * The created objects should be stored in the COM archive by the directory 
     * service provider. 
     * The operation shall return the COM object instance identifiers of the ServiceProvider 
     * and ProviderCapabilities COM objects representing the provider. 
     * @param capabilitiesObjId capabilitiesObjId Argument number 1 as defined 
     * by the service operation. 
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     */
    public void publishProviderResponseReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            Long providerObjId,
            Long capabilitiesObjId,
            java.util.Map qosProperties) {
    }

    /**
     * Called by the MAL when a REQUEST response error is received from a provider 
     * for the operation publishProvider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param error error The received error message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     */
    public void publishProviderErrorReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.mal.MOErrorException error,
            java.util.Map qosProperties) {
    }

    /**
     * Called by the MAL when a SUBMIT acknowledgement is received from a provider 
     * for the operation withdrawProvider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     */
    public void withdrawProviderAckReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            java.util.Map qosProperties) {
    }

    /**
     * Called by the MAL when a SUBMIT acknowledgement error is received from 
     * a provider for the operation withdrawProvider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param error error The received error message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     */
    public void withdrawProviderErrorReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.mal.MOErrorException error,
            java.util.Map qosProperties) {
    }

    /**
     * Called by the MAL when a REQUEST response is received from a provider for 
     * the operation getServiceXML. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param xmlFiles The list of XML files supplied during the publishProvider 
     * operation for the matched provider shall be returned. 
     * If no XML files were supplied by the provider then an empty list shall 
     * be returned. 
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     */
    public void getServiceXMLResponseReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.mal.structures.FileList xmlFiles,
            java.util.Map qosProperties) {
    }

    /**
     * Called by the MAL when a REQUEST response error is received from a provider 
     * for the operation getServiceXML. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param error error The received error message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     */
    public void getServiceXMLErrorReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.mal.MOErrorException error,
            java.util.Map qosProperties) {
    }

    /**
     * Called by the MAL when a SUBMIT acknowledgement is received from a provider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     * @throws org.ccsds.moims.mo.mal.MALException if an error is detected processing 
     * the message. 
     */
    public final void submitAckReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            java.util.Map qosProperties) throws org.ccsds.moims.mo.mal.MALException {
        switch (msgHeader.getOperation().getValue()) {
          case org.ccsds.moims.mo.common.directory.DirectoryServiceInfo._WITHDRAWPROVIDER_OP_NUMBER:
            withdrawProviderAckReceived(msgHeader, qosProperties);
            break;
          default:
            throw new org.ccsds.moims.mo.mal.MALException("Consumer adapter was not expecting operation number " + msgHeader.getOperation().getValue());
        }
    }

    /**
     * Called by the MAL when a SUBMIT acknowledgement error is received from 
     * a provider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param body body The body of the received message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     * @throws org.ccsds.moims.mo.mal.MALException if an error is detected processing 
     * the message. 
     */
    public final void submitErrorReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.mal.transport.MALErrorBody body,
            java.util.Map qosProperties) throws org.ccsds.moims.mo.mal.MALException {
        switch (msgHeader.getOperation().getValue()) {
          case org.ccsds.moims.mo.common.directory.DirectoryServiceInfo._WITHDRAWPROVIDER_OP_NUMBER:
            withdrawProviderErrorReceived(msgHeader, body.getError(), qosProperties);
            break;
          default:
            throw new org.ccsds.moims.mo.mal.MALException("Consumer adapter was not expecting operation number " + msgHeader.getOperation().getValue());
        }
    }

    /**
     * Called by the MAL when a REQUEST response is received from a provider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param body body The body of the received message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     * @throws org.ccsds.moims.mo.mal.MALException if an error is detected processing 
     * the message. 
     */
    public final void requestResponseReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.mal.transport.MALMessageBody body,
            java.util.Map qosProperties) throws org.ccsds.moims.mo.mal.MALException {
        switch (msgHeader.getOperation().getValue()) {
          case org.ccsds.moims.mo.common.directory.DirectoryServiceInfo._LOOKUPPROVIDER_OP_NUMBER:
            lookupProviderResponseReceived(msgHeader,
                (org.ccsds.moims.mo.common.directory.structures.ProviderSummaryList) body.getBodyElement(0, new org.ccsds.moims.mo.common.directory.structures.ProviderSummaryList()), qosProperties);
            break;
          case org.ccsds.moims.mo.common.directory.DirectoryServiceInfo._PUBLISHPROVIDER_OP_NUMBER:
            publishProviderResponseReceived(msgHeader,
                (body.getBodyElement(0, new org.ccsds.moims.mo.mal.structures.Union(Long.MAX_VALUE)) == null) ? null : ((org.ccsds.moims.mo.mal.structures.Union) body.getBodyElement(0, new org.ccsds.moims.mo.mal.structures.Union(Long.MAX_VALUE))).getLongValue(),
                (body.getBodyElement(1, new org.ccsds.moims.mo.mal.structures.Union(Long.MAX_VALUE)) == null) ? null : ((org.ccsds.moims.mo.mal.structures.Union) body.getBodyElement(1, new org.ccsds.moims.mo.mal.structures.Union(Long.MAX_VALUE))).getLongValue(), qosProperties);
            break;
          case org.ccsds.moims.mo.common.directory.DirectoryServiceInfo._GETSERVICEXML_OP_NUMBER:
            getServiceXMLResponseReceived(msgHeader,
                (org.ccsds.moims.mo.mal.structures.FileList) body.getBodyElement(0, new org.ccsds.moims.mo.mal.structures.FileList()), qosProperties);
            break;
          default:
            throw new org.ccsds.moims.mo.mal.MALException("Consumer adapter was not expecting operation number " + msgHeader.getOperation().getValue());
        }
    }

    /**
     * Called by the MAL when a REQUEST response error is received from a provider. 
     * 
     * @param msgHeader msgHeader The header of the received message.
     * @param body body The body of the received message.
     * @param qosProperties qosProperties The QoS properties associated with the 
     * message. 
     * @throws org.ccsds.moims.mo.mal.MALException if an error is detected processing 
     * the message. 
     */
    public final void requestErrorReceived(org.ccsds.moims.mo.mal.transport.MALMessageHeader msgHeader,
            org.ccsds.moims.mo.mal.transport.MALErrorBody body,
            java.util.Map qosProperties) throws org.ccsds.moims.mo.mal.MALException {
        switch (msgHeader.getOperation().getValue()) {
          case org.ccsds.moims.mo.common.directory.DirectoryServiceInfo._LOOKUPPROVIDER_OP_NUMBER:
            lookupProviderErrorReceived(msgHeader, body.getError(), qosProperties);
            break;
          case org.ccsds.moims.mo.common.directory.DirectoryServiceInfo._PUBLISHPROVIDER_OP_NUMBER:
            publishProviderErrorReceived(msgHeader, body.getError(), qosProperties);
            break;
          case org.ccsds.moims.mo.common.directory.DirectoryServiceInfo._GETSERVICEXML_OP_NUMBER:
            getServiceXMLErrorReceived(msgHeader, body.getError(), qosProperties);
            break;
          default:
            throw new org.ccsds.moims.mo.mal.MALException("Consumer adapter was not expecting operation number " + msgHeader.getOperation().getValue());
        }
    }

}