Package be.vlaanderen.vip.magda.client

Interface MagdaConnector

public interface MagdaConnector
An interface to send MagdaRequests to MAGDA and receive a MagdaResponses. If something goes wrong, a ServerException may be thrown.

  • Method Details

    • send

      MagdaResponse send(MagdaRequest magdaRequest) throws ServerException
      Sends a MAGDA request.
      Parameters:
      magdaRequest - the request to MAGDA.
      Returns:
      the response from MAGDA.
      Throws:
      ServerException - an error that may be thrown in cases of no response or validation errors from the server.

    • send

      MagdaResponse send(MagdaRequest magdaRequest, UUID requestId) throws ServerException
      Sends a MAGDA request with a specific request ID.
      Parameters:
      magdaRequest - the request to MAGDA.
      requestId - the request ID.
      Returns:
      the response from MAGDA.
      Throws:
      ServerException - an error that may be thrown in cases of no response or validation errors from the server.

    • sendRestRequest

      MagdaResponseJson sendRestRequest(MagdaRestRequest request) throws ServerException
      Sends a MAGDA REST request.
      Parameters:
      request - the REST request to MAGDA.
      Returns:
      the response from MAGDA.
      Throws:
      ServerException - an error that may be thrown in cases of no response or validation errors from the server.