org.opengis.cite.cat30.util

Class CSWClient

java.lang.Object

org.opengis.cite.cat30.util.CSWClient

public class CSWClient
extends Object

A CSW 3.0 client component.

Constructor Summary

Constructors

Constructor and Description
CSWClient()

Method Summary

Modifier and Type	Method and Description
Document	getCapabilities(URI uri) Retrieves a complete capabilities document from the specified endpoint.
Document	getOpenSearchDescription(URI uri) Retrieves an OpenSearch description document from the IUT.
Document	getServiceDescription()
File	saveFullRecords(int maxRecords, javax.ws.rs.core.MediaType mediaType) Submits a GetRecords request and saves the response entity to a (temporary) file.
void	setServiceDescription(Document capabilities)

Methods inherited from class java.lang.Object

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

Constructor Detail

CSWClient

public CSWClient()

Method Detail

getServiceDescription

public Document getServiceDescription()

setServiceDescription

public void setServiceDescription(Document capabilities)

saveFullRecords

public File saveFullRecords(int maxRecords,
                            javax.ws.rs.core.MediaType mediaType)

Submits a GetRecords request and saves the response entity to a (temporary) file. The "elementSetName" parameter is set to "full".

Parameters:

maxRecords - The maximum number of records to retrieve.

mediaType - The preferred response media type; this will constitute the value of the Accept header field (generic XML or Atom content).

Returns:

A File containing the response entity (csw:GetRecordsResponse); it will be located in the default temporary file directory.

getCapabilities

public Document getCapabilities(URI uri)

Retrieves a complete capabilities document from the specified endpoint.

Parameters:

uri - An absolute URI from which the capabilities can be retrieved; if null, the endpoint from a known capabilities document (which may differ from the one presented by the IUT) is used.

Returns:

A Document representing a capabilities document, or null if one is not available.

getOpenSearchDescription

public Document getOpenSearchDescription(URI uri)

Retrieves an OpenSearch description document from the IUT. The default endpoint is the one corresponding to the (mandatory) GET method binding for the GetCapabilities request. The Accept header indicates a preference for the following media types:

• "application/vnd.a9.opensearchdescription+xml"
• "application/opensearchdescription+xml"

An alternative endpoint may be presented in the capabilities document using the "OpenSearchDescriptionDocument" constraint.

Parameters:

uri - An absolute URI from which the OpenSearch description can be retrieved; if null, the default endpoint is used.

Returns:

A Document representing an OpenSearch description document, or null if one is not available.

See Also:

OpenSearch description document