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

Interface CswSubscribe

All Known Implementing Classes:

CswSubscriptionEndpoint

@Path(value="/")
public interface CswSubscribe

JAX-RS Interface to define an CSW Subscription service.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createEvent(GetRecordsResponseType recordsResponse) Consume a create event
javax.ws.rs.core.Response	createRecordsSubscription(GetRecordsRequest request) Create a subscription
javax.ws.rs.core.Response	createRecordsSubscription(GetRecordsType request) Create a subscription
javax.ws.rs.core.Response	deleteEvent(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(GetRecordsResponseType recordsResponse) Consume an update event
javax.ws.rs.core.Response	updateRecordsSubscription(String requestId, GetRecordsType request) Updates an active subscription

Method Detail

deleteRecordsSubscription

@DELETE
 @Path(value="/{requestId}")
 @Produces(value="*/*")
javax.ws.rs.core.Response deleteRecordsSubscription(@PathParam(value="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(value="/{requestId}")
 @Produces(value="*/*")
javax.ws.rs.core.Response getRecordsSubscription(@PathParam(value="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(value="/{requestId}")
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value="*/*")
javax.ws.rs.core.Response updateRecordsSubscription(@PathParam(value="requestId")
                                                                                                                                                               String requestId,
                                                                                                                                                               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(value="*/*")
javax.ws.rs.core.Response createRecordsSubscription(@QueryParam(value="")
                                                                                 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(value={"text/xml","application/xml"})
 @Produces(value="*/*")
javax.ws.rs.core.Response createRecordsSubscription(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(value="/event")
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
javax.ws.rs.core.Response createEvent(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(value="/event")
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
javax.ws.rs.core.Response updateEvent(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(value="/event")
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
javax.ws.rs.core.Response deleteEvent(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(value="/event")
javax.ws.rs.core.Response ping()

Consume a ping event