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

Interface Csw

All Known Implementing Classes:

CswEndpoint

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

JAX-RS Interface to define an OGC Catalogue Service for Web (CSW).

Method Summary

Modifier and Type	Method and Description
DescribeRecordResponseType	describeRecord(DescribeRecordRequest request) DescribeRecord - HTTP GET
DescribeRecordResponseType	describeRecord(DescribeRecordType request) DescribeRecord - HTTP POST
CapabilitiesType	getCapabilities(GetCapabilitiesRequest request) GetCapabilities - HTTP GET
CapabilitiesType	getCapabilities(GetCapabilitiesType request) GetCapabilities - HTTP POST
CswRecordCollection	getRecordById(GetRecordByIdRequest request, String rangeValue) GetRecordById - HTTP GET
CswRecordCollection	getRecordById(GetRecordByIdType request, String rangeValue) GetRecordById - HTTP POST
CswRecordCollection	getRecords(GetRecordsRequest request) ' GetRecords - HTTP GET
CswRecordCollection	getRecords(GetRecordsType request) GetRecords - HTTP POST
TransactionResponseType	transaction(CswTransactionRequest request) Transaction - HTTP POST

Method Detail

getCapabilities

@GET
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
CapabilitiesType getCapabilities(@QueryParam(value="")
                                                                                                                                        GetCapabilitiesRequest request)
                                                                                                                                 throws CswException

GetCapabilities - HTTP GET

Parameters:

request -

Returns:

Throws:

CswException

getCapabilities

@POST
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
CapabilitiesType getCapabilities(GetCapabilitiesType request)
                                                                                                                                  throws CswException

GetCapabilities - HTTP POST

Parameters:

request -

Returns:

Throws:

CswException

describeRecord

@GET
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
DescribeRecordResponseType describeRecord(@QueryParam(value="")
                                                                                                                                                 DescribeRecordRequest request)
                                                                                                                                          throws CswException

DescribeRecord - HTTP GET

Parameters:

request -

Returns:

Throws:

CswException

describeRecord

@POST
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
DescribeRecordResponseType describeRecord(DescribeRecordType request)
                                                                                                                                           throws CswException

DescribeRecord - HTTP POST

Parameters:

request -

Returns:

Throws:

CswException

getRecords

@GET
 @Produces(value={"text/xml","application/xml"})
CswRecordCollection getRecords(@QueryParam(value="")
                                                                                     GetRecordsRequest request)
                                                                              throws CswException

' GetRecords - HTTP GET

Parameters:

request -

Returns:

Throws:

CswException

getRecords

@POST
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
CswRecordCollection getRecords(GetRecordsType request)
                                                                                                                                throws CswException

GetRecords - HTTP POST

Parameters:

request -

Returns:

Throws:

CswException

getRecordById

@GET
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
CswRecordCollection getRecordById(@QueryParam(value="")
                                                                                                                                         GetRecordByIdRequest request,
                                                                                                                                         @HeaderParam(value="Range")
                                                                                                                                         String rangeValue)
                                                                                                                                  throws CswException

GetRecordById - HTTP GET

Parameters:

request -

Returns:

Throws:

CswException

getRecordById

@POST
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
CswRecordCollection getRecordById(GetRecordByIdType request,
                                                                                                                                          @HeaderParam(value="Range")
                                                                                                                                          String rangeValue)
                                                                                                                                   throws CswException

GetRecordById - HTTP POST

Parameters:

request -

Returns:

Throws:

CswException

transaction

@POST
 @Consumes(value={"text/xml","application/xml"})
 @Produces(value={"text/xml","application/xml"})
TransactionResponseType transaction(CswTransactionRequest request)
                                                                                                                                     throws CswException

Transaction - HTTP POST

Parameters:

request -

Returns:

Throws:

CswException