Package org.codice.ddf.spatial.ogc.csw.catalog.common

Interface CswSubscribe

@Path("/") public interface CswSubscribe
JAX-RS Interface to define an CSW Subscription service.

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.ws.rs.core.Response
    createEvent(net.opengis.cat.csw.v_2_0_2.GetRecordsResponseType recordsResponse)
    Consume a create event
    javax.ws.rs.core.Response
    createRecordsSubscription(net.opengis.cat.csw.v_2_0_2.GetRecordsType request)
    Create a subscription
    javax.ws.rs.core.Response
    createRecordsSubscription(GetRecordsRequest request)
    Create a subscription
    javax.ws.rs.core.Response
    deleteEvent(net.opengis.cat.csw.v_2_0_2.GetRecordsResponseType recordsResponse)
    Consume a delete event
    javax.ws.rs.core.Response
    deleteRecordsSubscription(String requestId)
    Deletes an active subscription
    javax.ws.rs.core.Response
    getRecordsSubscription(String requestId)
    Get an active subscription
    javax.ws.rs.core.Response
    ping()
    Consume a ping event
    javax.ws.rs.core.Response
    updateEvent(net.opengis.cat.csw.v_2_0_2.GetRecordsResponseType recordsResponse)
    Consume an update event
    javax.ws.rs.core.Response
    updateRecordsSubscription(String requestId, net.opengis.cat.csw.v_2_0_2.GetRecordsType request)
    Updates an active subscription

  • Method Details

    • deleteRecordsSubscription

      @DELETE @Path("/{requestId}") @Produces("*/*") javax.ws.rs.core.Response deleteRecordsSubscription(@PathParam("requestId") String requestId) throws CswException
      Deletes an active subscription
      Parameters:
      requestId - the requestId of the subscription to be removed
      Returns:
      Response will contain a CSW Acknowledgment message with the subscription that was deleted or an empty 404 if none are found
      Throws:
      CswException - for validation errors returns a 400

    • getRecordsSubscription

      @GET @Path("/{requestId}") @Produces("*/*") javax.ws.rs.core.Response getRecordsSubscription(@PathParam("requestId") String requestId) throws CswException
      Get an active subscription
      Parameters:
      requestId - the requestId of the subscription to get
      Returns:
      returns a response containing a CSW Acknowledgment message with the subscription that was found or an empty 404 if none are found
      Throws:
      CswException - for validation errors returns a 400

    • updateRecordsSubscription

      @PUT @Path("/{requestId}") @Consumes({"text/xml","application/xml"}) @Produces("*/*") javax.ws.rs.core.Response updateRecordsSubscription(@PathParam("requestId") String requestId, net.opengis.cat.csw.v_2_0_2.GetRecordsType request) throws CswException
      Updates an active subscription
      Parameters:
      requestId - the requestId of the subscription to get
      request - the GetRocordsType request which contains the filter that the subscription is subscribing too and a ResponseHandler URL that will handle the CswRecordCollection response messages. When a create, update or delete event is received a CswRecordCollection will be sent via a POST, PUT or DELETE to the ResponseHandler URL.
      Returns:
      Response will contain a CSW Acknowledgment message with the subscription that was updated or added
      Throws:
      CswException - for validation errors returns a 400

    • createRecordsSubscription

      @GET @Produces("*/*") javax.ws.rs.core.Response createRecordsSubscription(@QueryParam("") GetRecordsRequest request) throws CswException
      Create a subscription
      Parameters:
      request - the GetRecordsRequest request which contains the filter that the subscription is subscribing too and a ResponseHandler URL that will handle the CswRecordCollection response messages. When a create, update or delete event is received a CswRecordCollection will be sent via a POST, PUT or DELETE to the ResponseHandler URL.
      Returns:
      Response will contain a CSW Acknowledgment message with the subscription that was added
      Throws:
      CswException - for validation errors returns a 400

    • createRecordsSubscription

      @POST @Consumes({"text/xml","application/xml"}) @Produces("*/*") javax.ws.rs.core.Response createRecordsSubscription(net.opengis.cat.csw.v_2_0_2.GetRecordsType request) throws CswException
      Create a subscription
      Parameters:
      request - the GetRecordsType request which contains the filter that the subscription is subscribing too and a ResponseHandler URL that will handle the CswRecordCollection response messages. When a create, update or delete event is received a CswRecordCollection will be sent via a POST, PUT or DELETE to the ResponseHandler URL
      Returns:
      Response will contain a CSW Acknowledgment message with the subscription that was added
      Throws:
      CswException - for validation errors returns a 400

    • createEvent

      @POST @Path("/event") @Consumes({"text/xml","application/xml"}) @Produces({"text/xml","application/xml"}) javax.ws.rs.core.Response createEvent(net.opengis.cat.csw.v_2_0_2.GetRecordsResponseType recordsResponse) throws CswException
      Consume a create event
      Parameters:
      recordsResponse - the GetRecordsResponseType search results must be urn:catalog:metacard format
      Throws:
      CswException - for validation errors returns a 400

    • updateEvent

      @PUT @Path("/event") @Consumes({"text/xml","application/xml"}) @Produces({"text/xml","application/xml"}) javax.ws.rs.core.Response updateEvent(net.opengis.cat.csw.v_2_0_2.GetRecordsResponseType recordsResponse) throws CswException
      Consume an update event
      Parameters:
      recordsResponse - the GetRecordsResponseType search results must be urn:catalog:metacard format with two metacards the updated one being the first and the previous version being the seconds
      Throws:
      CswException - for validation errors returns a 400

    • deleteEvent

      @DELETE @Path("/event") @Consumes({"text/xml","application/xml"}) @Produces({"text/xml","application/xml"}) javax.ws.rs.core.Response deleteEvent(net.opengis.cat.csw.v_2_0_2.GetRecordsResponseType recordsResponse) throws CswException
      Consume a delete event
      Parameters:
      recordsResponse - the GetRecordsResponseType search results must be urn:catalog:metacard format
      Throws:
      CswException - for validation errors returns a 400

    • ping

      @HEAD @Path("/event") javax.ws.rs.core.Response ping()
      Consume a ping event