org.deegree.protocol.ows.capabilities
Class GetCapabilities

java.lang.Object
  org.deegree.protocol.ows.capabilities.GetCapabilities

public class GetCapabilities
extends java.lang.Object

Generic representation of an OWS/OGC GetCapabilities request. Used for GetCapabilities requests to all kinds of OGC web services.

Compliance has been checked with the following specifications:

• OWS Common 1.0.0
• OWS Common 1.1.0
• WFS 1.0.0
• WPS 1.0.0 (= OWS Commons 1.1.0 + multilanguage support)

Supports multilingual services according to OWS Common change request OGC 08-016r2. This is already used by the WPS Specification 1.0.0.

Version:

$Revision:$, $Date:$

Author:

Markus Schneider , last edited by: $Author:$

Constructor Summary

GetCapabilities(java.util.Collection<java.lang.String> acceptVersions, java.util.Collection<java.lang.String> sections, java.util.Collection<java.lang.String> acceptFormats, java.lang.String updateSequence, java.util.Collection<java.lang.String> languages)
Constructs a new GetCapabilities request.

GetCapabilities(java.lang.String version)
Constructs a new GetCapabilities request that specifies the requested version in a pre-OWS fashion (see section D.11 of OGC 06-121r3).

GetCapabilities(java.lang.String version, java.util.Collection<java.lang.String> sections, java.util.Collection<java.lang.String> acceptFormats, java.lang.String updateSequence, java.util.Collection<java.lang.String> languages)
Constructs a new GetCapabilities request that specifies the requested version in a pre-OWS fashion (see section D.11 of OGC 06-121r3).

GetCapabilities(Version version)
Constructs a new GetCapabilities request that specifies the requested version in a pre-OWS fashion (see section D.11 of OGC 06-121r3).

Method Summary

java.util.Set<java.lang.String>	getAcceptFormats() Returns the formats accepted by the client.
java.util.List<java.lang.String>	getAcceptVersions() Returns the acceptable versions in order of client preference (most preferred version first).
java.util.List<Version>	getAcceptVersionsAsVersions() Returns the acceptable versions in order of client preference (most preferred version first).
java.util.List<java.lang.String>	getLanguages() Returns the languages for human readable text requested by the client.
java.util.Set<java.lang.String>	getSections() Returns the sections requested by the client.
java.lang.String	getUpdateSequence() Returns the update sequence value.
java.lang.String	getVersion() Returns the old-style version information (used by pre-OWS GetCapabilities requests, see section D.11 of OGC 06-121r3).
Version	getVersionAsVersion() Returns the old-style version information (used by pre-OWS GetCapabilities requests, see section D.11 of OGC 06-121r3).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GetCapabilities

public GetCapabilities(java.util.Collection<java.lang.String> acceptVersions,
                       java.util.Collection<java.lang.String> sections,
                       java.util.Collection<java.lang.String> acceptFormats,
                       java.lang.String updateSequence,
                       java.util.Collection<java.lang.String> languages)

Constructs a new GetCapabilities request.

Parameters:

acceptVersions - acceptable protocol versions in order of client preference, may be empty or null

sections - queried section names, may be empty or null

acceptFormats - acceptable response formats, may be empty or null

updateSequence - TODO (what does it do exactly), may be null

languages - RFC 4646 language codes for human readable text (e.g. "en-CA,fr-CA"), may be emtpy or null

GetCapabilities

public GetCapabilities(java.lang.String version,
                       java.util.Collection<java.lang.String> sections,
                       java.util.Collection<java.lang.String> acceptFormats,
                       java.lang.String updateSequence,
                       java.util.Collection<java.lang.String> languages)

Constructs a new GetCapabilities request that specifies the requested version in a pre-OWS fashion (see section D.11 of OGC 06-121r3).

Parameters:

version - old-style version information, may be null

sections - queried section names, may be empty or null

acceptFormats - acceptable response formats, may be empty or null

updateSequence - TODO (what does it do exactly), may be null

languages - RFC 4646 language codes for human readable text (e.g. "en-CA,fr-CA"), may be emtpy or null

GetCapabilities

public GetCapabilities(java.lang.String version)

Constructs a new GetCapabilities request that specifies the requested version in a pre-OWS fashion (see section D.11 of OGC 06-121r3).

Parameters:

version - old-style version information, may be null

GetCapabilities

public GetCapabilities(Version version)

Constructs a new GetCapabilities request that specifies the requested version in a pre-OWS fashion (see section D.11 of OGC 06-121r3).

Parameters:

version - old-style version information, may be null

Method Detail

getVersion

public java.lang.String getVersion()

Returns the old-style version information (used by pre-OWS GetCapabilities requests, see section D.11 of OGC 06-121r3).

Returns:

old-style version information, may be null (if this is an OWS-style request or an pre-OWS request without version specification)

getVersionAsVersion

public Version getVersionAsVersion()
                            throws InvalidParameterValueException

Returns the old-style version information (used by pre-OWS GetCapabilities requests, see section D.11 of OGC 06-121r3).

Returns:

old-style version information, may be null (if this is an OWS-style request or an pre-OWS request without version specification)

Throws:

InvalidParameterValueException - if any of the versions is not syntactically correct

getAcceptVersions

public java.util.List<java.lang.String> getAcceptVersions()

Returns the acceptable versions in order of client preference (most preferred version first).

Returns:

the acceptable versions, in order of preference, may be empty, but not null

getAcceptVersionsAsVersions

public java.util.List<Version> getAcceptVersionsAsVersions()
                                                    throws InvalidParameterValueException

Returns the acceptable versions in order of client preference (most preferred version first).

Returns:

the acceptable versions, in order of preference, may be empty, but not null

Throws:

InvalidParameterValueException - if any of the versions is not syntactically correct

See Also:

Version

getSections

public java.util.Set<java.lang.String> getSections()

Returns the sections requested by the client.

Returns:

the requested sections, may be empty, but not null

getAcceptFormats

public java.util.Set<java.lang.String> getAcceptFormats()

Returns the formats accepted by the client.

Returns:

the accepted formats, may be empty, but not null

getUpdateSequence

public java.lang.String getUpdateSequence()

Returns the update sequence value.

Returns:

the update sequence value or null if unspecified

getLanguages

public java.util.List<java.lang.String> getLanguages()

Returns the languages for human readable text requested by the client.

Returns:

list of RFC 4646 language codes, may be empty, but not null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object