org.opengis.cite.kml2

Class CommonFixture

java.lang.Object

org.opengis.cite.kml2.CommonFixture

Direct Known Subclasses:

CL2LinearRingTests, CL2OverlayTests, CL2TourTests, CL3ModelTests, CommonFeatureTests, KmlDocumentTests, KmlResourceTests, LinearRingTests, LineStringTests, ModelTests, ModelTests, NetworkLinkControlTests, PlacemarkGeometryTests, PointTests, PolygonTests, StyleTests, TimeSpanTests, TimeStampTests

public class CommonFixture
extends Object

A supporting base class that sets up a common test fixture. These configuration methods are invoked before those defined in a subclass.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CommonFixture.TargetElementsIterator An Iterator suitable for use by a "lazy" data provider.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.jersey.api.client.Client	client HTTP client component (JAX-RS Client API).
protected int	conformanceLevel The conformance level.
protected Document	kmlDoc A DOM Document representing the main KML document.
protected com.sun.jersey.api.client.ClientRequest	request An HTTP request message.
protected com.sun.jersey.api.client.ClientResponse	response An HTTP response message.
static String	ROOT_PKG_PATH Root test suite package (absolute path).
protected NodeList	targetElements The elements to which the tests apply.

Constructor Summary

Constructors

Constructor and Description
CommonFixture()

Method Summary

Modifier and Type	Method and Description
com.sun.jersey.api.client.ClientRequest	buildGetRequest(URI endpoint, Map<String,String> qryParams, javax.ws.rs.core.MediaType... mediaTypes) Builds an HTTP request message that uses the GET method.
void	clearMessages()
protected void	findTargetElements(String... localNames) Finds KML elements (of type kml:AbstractObjectType) by (local) name.
Document	getResponseEntityAsDocument(com.sun.jersey.api.client.ClientResponse response, String targetURI) Obtains the (XML) response entity as a DOM Document.
void	initCommonFixture(ITestContext testContext) Initializes the common test fixture with a client component for interacting with HTTP endpoints, the KML document to be tested, and the effective conformance level.
void	setTargetElements(NodeList targetElements) Facilitates unit testing.
protected Iterator<Object>	targetElementsProvider()

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_PKG_PATH

public static final String ROOT_PKG_PATH

Root test suite package (absolute path).

See Also:

Constant Field Values

client

protected com.sun.jersey.api.client.Client client

HTTP client component (JAX-RS Client API).

request

protected com.sun.jersey.api.client.ClientRequest request

An HTTP request message.

response

protected com.sun.jersey.api.client.ClientResponse response

An HTTP response message.

kmlDoc

protected Document kmlDoc

A DOM Document representing the main KML document.

targetElements

protected NodeList targetElements

The elements to which the tests apply.

conformanceLevel

protected int conformanceLevel

The conformance level.

Constructor Detail

CommonFixture

public CommonFixture()

Method Detail

setTargetElements

public void setTargetElements(NodeList targetElements)

Facilitates unit testing.

Parameters:

targetElements - The collection of elements to which the tests apply.

findTargetElements

protected void findTargetElements(String... localNames)

Finds KML elements (of type kml:AbstractObjectType) by (local) name. Only elements that occur outside of an update context are sought; that is, the element does not have a targetId attribute.

Parameters:

localNames - A list of KML element names.

See Also:

"OGC KML 2.3, 13.5: kml:Update"

initCommonFixture

public void initCommonFixture(ITestContext testContext)

Initializes the common test fixture with a client component for interacting with HTTP endpoints, the KML document to be tested, and the effective conformance level.

Parameters:

testContext - The test context that contains all the information for a test run, including suite attributes.

clearMessages

public void clearMessages()

getResponseEntityAsDocument

public Document getResponseEntityAsDocument(com.sun.jersey.api.client.ClientResponse response,
                                            String targetURI)

Obtains the (XML) response entity as a DOM Document. This convenience method wraps a static method call to facilitate unit testing (Mockito workaround).

Parameters:

response - A representation of an HTTP response message.

targetURI - The target URI from which the entity was retrieved (may be null).

Returns:

A Document representing the entity.

See Also:

HttpClientUtils.getResponseEntityAsDocument(com.sun.jersey.api.client.ClientResponse, java.lang.String)

buildGetRequest

public com.sun.jersey.api.client.ClientRequest buildGetRequest(URI endpoint,
                                                               Map<String,String> qryParams,
                                                               javax.ws.rs.core.MediaType... mediaTypes)

Builds an HTTP request message that uses the GET method. This convenience method wraps a static method call to facilitate unit testing (Mockito workaround).

Parameters:

endpoint - A URI indicating the target resource.

qryParams - A Map containing query parameters (may be null);

mediaTypes - A list of acceptable media types; if not specified, generic XML ("application/xml") is preferred.

Returns:

A ClientRequest object.

See Also:

HttpClientUtils.buildGetRequest(java.net.URI, java.util.Map, javax.ws.rs.core.MediaType...)

targetElementsProvider

protected Iterator<Object> targetElementsProvider()