org.opengis.cite.cat30.opensearch

Class OpenSearchDescriptionTests

java.lang.Object

org.opengis.cite.cat30.CommonFixture

org.opengis.cite.cat30.opensearch.OpenSearchDescriptionTests

public class OpenSearchDescriptionTests
extends CommonFixture

Verifies the structure and content of the OpenSearch description document obtained from the SUT. The document is obtained in response to a GET request submitted to the base service endpoint where the Accept request header expresses a preference for any of the following media types:

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

Note: None of the media types listed above appear in the IANA media type registry. Registrations in the standards tree must be approved by the IESG or originate from a recognized standards-related organization (see RFC 6838); third-party registrations are allowed in the vendor tree.

Sources

• OGC 12-176r5, 6.4: Obtaining service metadata
• OGC 12-176r5, 6.5.6: Enabling OpenSearch
• OpenSearch description elements

Field Summary

Fields inherited from class org.opengis.cite.cat30.CommonFixture

client, ROOT_PKG_PATH

Constructor Summary

Constructors

Constructor and Description
OpenSearchDescriptionTests()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkOpenSearchImplementationStatus(ITestContext testContext) Checks that the capabilities document indicates support for OpenSearch.
void	getOpenSearchDescription() [Test] Retrieves an OpenSearch description document and validates it.
void	initFixture(ITestContext testContext) Initializes the test fixture by: building a Relax NG schema validator for an OpenSearch description document; the schema resource is located on the classpath at this location: /org/opengis/cite/cat30/rnc/osd-1.1-draft5.rnc extracting the base GetCapabilities URL (for the GET method binding) from the capabilities document
void	preferOpenSearchDescription() [Test] Requests an OpenSearch description document as the most preferred media type.

Methods inherited from class org.opengis.cite.cat30.CommonFixture

initCommonFixture

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchDescriptionTests

public OpenSearchDescriptionTests()

Method Detail

checkOpenSearchImplementationStatus

public void checkOpenSearchImplementationStatus(ITestContext testContext)

Checks that the capabilities document indicates support for OpenSearch. If not, all relevant tests will be marked as skipped. The implementation status of the corresponding conformance class must be set to "TRUE".

<OperationsMetadata xmlns="http://www.opengis.net/ows/2.0">
  <!-- Operation elements omitted -->
  <Constraint name="OpenSearch">
    <AllowedValues>
      <Value>FALSE</Value>
      <Value>TRUE</Value>
    </AllowedValues>
    <DefaultValue>TRUE</DefaultValue>
    <Meaning>Conformance class</Meaning>
  </Constraint>
</OperationsMetadata>

 

Parameters:

testContext - Information about the pending test run.

See Also:

"OGC 12-176r5, Table 17: Service constraints"

initFixture

public void initFixture(ITestContext testContext)

Initializes the test fixture by:

• building a Relax NG schema validator for an OpenSearch description document; the schema resource is located on the classpath at this location: /org/opengis/cite/cat30/rnc/osd-1.1-draft5.rnc
• extracting the base GetCapabilities URL (for the GET method binding) from the capabilities document

Parameters:

testContext - The test context containing various suite attributes.

preferOpenSearchDescription

public void preferOpenSearchDescription()

[Test] Requests an OpenSearch description document as the most preferred media type. The generic XML media type is included in the Accept header with a q parameter value < 1 ("application/xml; q=0.5").

getOpenSearchDescription

public void getOpenSearchDescription()
                              throws SAXException,
                                     IOException

[Test] Retrieves an OpenSearch description document and validates it. A GET request is submitted to the base URL for the GetCapabilities endpoint. The Accept header indicates a preference for either of the following media types:

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

Throws:

SAXException - If the response entity cannot be parsed.

IOException - If an I/O error occurs while trying to access the service endpoint.

See Also:

"OGC 12-176r5, 6.5.6.5: Requirements for an OpenSearch enabled CSW"