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

Class CswSubscriptionEndpoint

java.lang.Object

org.codice.ddf.spatial.ogc.csw.catalog.endpoint.CswSubscriptionEndpoint

All Implemented Interfaces:

Subscriber, CswSubscribe

@Path(value="/subscription")
public class CswSubscriptionEndpoint
extends Object
implements CswSubscribe, Subscriber

Constructor Summary

Constructors

Constructor and Description
CswSubscriptionEndpoint(EventProcessor eventProcessor, TransformerManager mimeTypeTransformerManager, TransformerManager schemaTransformerManager, TransformerManager inputTransformerManager, Validator validator, CswQueryFactory queryFactory)

Method Summary

Modifier and Type	Method and Description
String	addOrUpdateSubscription(GetRecordsType request, boolean persistSubscription)
javax.ws.rs.core.Response	createEvent(GetRecordsResponseType recordsResponse) Consume a create event
javax.ws.rs.core.Response	createOrUpdateSubscription(GetRecordsType request, String requestId)
javax.ws.rs.core.Response	createOrUpdateSubscription(GetRecordsType request, String requestId, boolean persist)
javax.ws.rs.core.Response	createRecordsSubscription(GetRecordsRequest request) Create a subscription
javax.ws.rs.core.Response	createRecordsSubscription(GetRecordsType request) Create a subscription
CswSubscription	createSubscription(GetRecordsType request)
javax.ws.rs.core.Response	deleteEvent(GetRecordsResponseType recordsResponse) Consume a delete event
javax.ws.rs.core.Response	deleteRecordsSubscription(String requestId) Deletes an active subscription
boolean	deleteSubscription(String subscriptionId) Deletes a subscription with the specified ID.
javax.ws.rs.core.Response	getRecordsSubscription(String requestId) Get an active subscription
boolean	hasSubscription(String subscriptionId)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CswSubscriptionEndpoint

public CswSubscriptionEndpoint(EventProcessor eventProcessor,
                               TransformerManager mimeTypeTransformerManager,
                               TransformerManager schemaTransformerManager,
                               TransformerManager inputTransformerManager,
                               Validator validator,
                               CswQueryFactory queryFactory)

Method Detail

deleteRecordsSubscription

@DELETE
 @Path(value="/{requestId}")
 @Produces(value="*/*")
public javax.ws.rs.core.Response deleteRecordsSubscription(@PathParam(value="requestId")
                                                                                                                        String requestId)
                                                                                                                 throws CswException

Deletes an active subscription

Specified by:

deleteRecordsSubscription in interface CswSubscribe

Parameters:

requestId - the requestId of the subscription to be removed

Returns:

Acknowledgment returns a CSW Acknowledgment message with the subscription that was deleted or an empty 404 if none are found

Throws:

CswException

getRecordsSubscription

@GET
 @Path(value="/{requestId}")
 @Produces(value="*/*")
public javax.ws.rs.core.Response getRecordsSubscription(@PathParam(value="requestId")
                                                                                                                  String requestId)

Get an active subscription

Specified by:

getRecordsSubscription in interface CswSubscribe

Parameters:

requestId - the requestId of the subscription to get

Returns:

Acknowledgment returns a CSW Acknowledgment message with the subscription that was found or an empty 404 if none are found

Throws:

CswException

updateRecordsSubscription

@PUT
 @Path(value="/{requestId}")
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value="*/*")
public javax.ws.rs.core.Response updateRecordsSubscription(@PathParam(value="requestId")
                                                                                                                                                                      String requestId,
                                                                                                                                                                      GetRecordsType request)
                                                                                                                                                               throws CswException

Updates an active subscription

Specified by:

updateRecordsSubscription in interface CswSubscribe

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 an create, update or delete event is received a CswRecordCollection will be sent via a POST, PUT or DELETE to the ResponseHandler URL.

Returns:

Acknowledgment returns a CSW Acknowledgment message with the subscription that was updated or added

Throws:

CswException

createRecordsSubscription

@GET
 @Produces(value="*/*")
public javax.ws.rs.core.Response createRecordsSubscription(@QueryParam(value="")
                                                                                        GetRecordsRequest request)
                                                                                 throws CswException

Create a subscription

Specified by:

createRecordsSubscription in interface CswSubscribe

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 an create, update or delete event is received a CswRecordCollection will be sent via a POST, PUT or DELETE to the ResponseHandler URL.

Returns:

Acknowledgment returns a CSW Acknowledgment message with the subscription that was added

Throws:

CswException

createRecordsSubscription

@POST
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value="*/*")
public javax.ws.rs.core.Response createRecordsSubscription(GetRecordsType request)
                                                                                                                                   throws CswException

Create a subscription

Specified by:

createRecordsSubscription in interface CswSubscribe

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 an create, update or delete event is received a CswRecordCollection will be sent via a POST, PUT or DELETE to the ResponseHandler URL

Returns:

Acknowledgment returns a CSW Acknowledgment message with the subscription that was added

Throws:

CswException

createOrUpdateSubscription

public javax.ws.rs.core.Response createOrUpdateSubscription(GetRecordsType request,
                                                            String requestId)
                                                     throws CswException

Throws:

CswException

createOrUpdateSubscription

public javax.ws.rs.core.Response createOrUpdateSubscription(GetRecordsType request,
                                                            String requestId,
                                                            boolean persist)
                                                     throws CswException

Throws:

CswException

createEvent

@POST
 @Path(value="/event")
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
public javax.ws.rs.core.Response createEvent(GetRecordsResponseType recordsResponse)
                                                                                                                                                                     throws CswException

Description copied from interface: CswSubscribe

Consume a create event

Specified by:

createEvent in interface CswSubscribe

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"})
public javax.ws.rs.core.Response updateEvent(GetRecordsResponseType recordsResponse)
                                                                                                                                                                    throws CswException

Description copied from interface: CswSubscribe

Consume an update event

Specified by:

updateEvent in interface CswSubscribe

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"})
public javax.ws.rs.core.Response deleteEvent(GetRecordsResponseType recordsResponse)
                                                                                                                                                                       throws CswException

Description copied from interface: CswSubscribe

Consume a delete event

Specified by:

deleteEvent in interface CswSubscribe

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")
public javax.ws.rs.core.Response ping()

Description copied from interface: CswSubscribe

Consume a ping event

Specified by:

ping in interface CswSubscribe

hasSubscription

public boolean hasSubscription(String subscriptionId)

createSubscription

public CswSubscription createSubscription(GetRecordsType request)
                                   throws CswException

Throws:

CswException

addOrUpdateSubscription

public String addOrUpdateSubscription(GetRecordsType request,
                                      boolean persistSubscription)
                               throws CswException

Throws:

CswException

deleteSubscription

public boolean deleteSubscription(String subscriptionId)

Description copied from interface: Subscriber

Deletes a subscription with the specified ID. Subscription deletion includes unregistering the Subscription's OSGi service, its associated DurableSubscription OSGi service (if any), and removing the subscription from the internal hashmaps maintained by the Subscriber.

Specified by:

deleteSubscription in interface Subscriber

Parameters:

subscriptionId - the globally unique UUID for a subscription

Returns:

true if subscription successfully deleted; false otherwise