it.geosolutions.geoserver.rest
Class GeoServerRESTReader

java.lang.Object
  it.geosolutions.geoserver.rest.GeoServerRESTReader

public class GeoServerRESTReader
extends Object

Connect to a GeoServer instance to read its data.
Info are returned as Strings or, for complex data, as XML elements wrapped in proper parsers (e.g.: RESTLayer, RESTCoverageStore, ...).

Author:

ETj (etj at geo-solutions.it)

Constructor Summary

GeoServerRESTReader(String gsUrl)
Creates a GeoServerRESTReader for a given GeoServer instance and no auth credentials.

GeoServerRESTReader(String gsUrl, String username, String password)
Creates a GeoServerRESTReader for a given GeoServer instance with the given auth credentials.

GeoServerRESTReader(URL gsUrl)
Creates a GeoServerRESTReader for a given GeoServer instance and no auth credentials.

GeoServerRESTReader(URL gsUrl, String username, String password)
Creates a GeoServerRESTReader for a given GeoServer instance with the given auth credentials.

Method Summary

boolean	existGeoserver() Check if a GeoServer instance is running at the given URL.
boolean	existsStyle(String styleName) Check if a Style exists in the configured GeoServer instance.
boolean	existsStyle(String workspace, String styleName)
RESTCoverage	getCoverage(RESTLayer layer) Get detailed info about a Coverage given the Layer where it's published with.
RESTCoverage	getCoverage(String workspace, String store, String name) Get detailed info about a given Coverage.
RESTCoverageList	getCoverages(String workspace, String csName) Get list of coverages (usually only one).
RESTCoverageStore	getCoverageStore(RESTCoverage coverage) Get detailed info about a Coverage's Datastore.
RESTCoverageStore	getCoverageStore(String workspace, String csName) Get detailed info about a given CoverageStore in a given Workspace.
RESTCoverageStoreList	getCoverageStores(String workspace) Get summary info about all CoverageStores in a WorkSpace.
RESTDataStore	getDatastore(RESTFeatureType featureType) Get detailed info about a FeatureType's Datastore.
RESTDataStore	getDatastore(String workspace, String dsName) Get detailed info about a given Datastore in a given Workspace.
RESTDataStoreList	getDatastores(String workspace) Get summary info about all DataStores in a WorkSpace.
RESTFeatureType	getFeatureType(RESTLayer layer) Get detailed info about a FeatureType given the Layer where it's published with.
RESTFeatureTypeList	getFeatureTypes(String workspace) Get summary info about all FeatureTypes of a workspace.
GSVersionDecoder	getGeoserverVersion() Return the version of the target GeoServer
RESTStructuredCoverageGranulesList	getGranuleById(String workspace, String coverageStore, String coverage, String id) Get information about a granule for a structured coverage.
RESTStructuredCoverageIndexSchema	getGranuleIndexSchema(String workspace, String coverageStore, String coverage) Get information about the schema of the index for a structured coverage.
RESTStructuredCoverageGranulesList	getGranules(String workspace, String coverageStore, String coverage, String filter, Integer offset, Integer limit) Get information about the granules for a coverage with optional filter and paging.
RESTLayer	getLayer(String name) Deprecated. use getLayer(String, String)
RESTLayer	getLayer(String workspace, String name) Get detailed info about a given Layer.
RESTLayerGroup	getLayerGroup(String name) Get detailed info about a given LayerGroup.
RESTLayerGroup	getLayerGroup(String workspace, String name) Get detailed info about a given LayerGroup.
RESTLayerGroupList	getLayerGroups() Get summary info about all LayerGroups.
RESTLayerGroupList	getLayerGroups(String workspace) Get summary info about all LayerGroups in the given workspace.
RESTLayerList	getLayers() Get summary info about all Layers.
RESTNamespace	getNamespace(String prefix) Get a namespace.
List<String>	getNamespaceNames() Get the names of all the Namespaces.
RESTNamespaceList	getNamespaces() Get summary info about all Namespaces.
RESTResource	getResource(RESTLayer layer) Get detailed info about a Resource given the Layer where it's published with.
String	getSLD(String styleName) Get the SLD body of a Style.
String	getSLD(String workspace, String styleName)
RESTStyle	getStyle(String name)
RESTStyle	getStyle(String workspace, String name)
RESTStyleList	getStyles() Get summary info about all Styles.
RESTStyleList	getStyles(String workspace)
List<String>	getWorkspaceNames() Get the names of all the Workspaces.
RESTWorkspaceList	getWorkspaces() Get summary info about all Workspaces.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoServerRESTReader

public GeoServerRESTReader(URL gsUrl)

Creates a GeoServerRESTReader for a given GeoServer instance and no auth credentials.

Note that GeoServer 2.0 REST interface requires username/password credentials by default, if not otherwise configured. .

Parameters:

gsUrl - the base GeoServer URL(e.g.: http://localhost:8080/geoserver)

GeoServerRESTReader

public GeoServerRESTReader(String gsUrl)
                    throws MalformedURLException

Creates a GeoServerRESTReader for a given GeoServer instance and no auth credentials.

Note that GeoServer 2.0 REST interface requires username/password credentials by default, if not otherwise configured. .

Parameters:

gsUrl - the base GeoServer URL (e.g.: http://localhost:8080/geoserver)

Throws:

MalformedURLException

GeoServerRESTReader

public GeoServerRESTReader(String gsUrl,
                           String username,
                           String password)
                    throws MalformedURLException

Creates a GeoServerRESTReader for a given GeoServer instance with the given auth credentials.

Parameters:

gsUrl - the base GeoServer URL (e.g.: http://localhost:8080/geoserver)

username - username auth credential

password - password auth credential

Throws:

MalformedURLException

GeoServerRESTReader

public GeoServerRESTReader(URL gsUrl,
                           String username,
                           String password)

Creates a GeoServerRESTReader for a given GeoServer instance with the given auth credentials.

Parameters:

gsUrl - the base GeoServer URL (e.g.: http://localhost:8080/geoserver)

username - username auth credential

password - password auth credential

Method Detail

existGeoserver

public boolean existGeoserver()

Check if a GeoServer instance is running at the given URL.
Return true if the configured GeoServer is up and replies to REST requests.
Send a HTTP GET request to the configured URL.
Return true if a HTTP 200 code (OK) is read from the HTTP response; any other response code, or connection error, will return a false boolean.

Returns:

true if a GeoServer instance was found at the configured URL.

getGeoserverVersion

public GSVersionDecoder getGeoserverVersion()

Return the version of the target GeoServer

existsStyle

public boolean existsStyle(String styleName)
                    throws RuntimeException

Check if a Style exists in the configured GeoServer instance.

Parameters:

styleName - the name of the style to check for.

Returns:

true on HTTP 200, false on HTTP 404

Throws:

RuntimeException - if any other HTTP code than 200 or 404 was retrieved.

existsStyle

public boolean existsStyle(String workspace,
                           String styleName)
                    throws RuntimeException

Throws:

RuntimeException

Since:

GeoServer 2.2

See Also:

GeoServerRESTStyleManager.existsStyle(java.lang.String, java.lang.String)

getStyle

public RESTStyle getStyle(String name)

Since:

GeoServer 2.2

See Also:

GeoServerRESTStyleManager.getStyle(java.lang.String)

getStyle

public RESTStyle getStyle(String workspace,
                          String name)

Since:

GeoServer 2.2

See Also:

GeoServerRESTStyleManager.getStyle(java.lang.String, java.lang.String)

getStyles

public RESTStyleList getStyles()

Get summary info about all Styles.

Returns:

summary info about Styles as a RESTStyleList

getStyles

public RESTStyleList getStyles(String workspace)

Since:

GeoServer 2.2

See Also:

GeoServerRESTStyleManager.getStyles(java.lang.String)

getSLD

public String getSLD(String styleName)

Get the SLD body of a Style.

getSLD

public String getSLD(String workspace,
                     String styleName)

Since:

GeoServer 2.2

See Also:

GeoServerRESTStyleManager.getSLD(java.lang.String, java.lang.String)

getDatastores

public RESTDataStoreList getDatastores(String workspace)

Get summary info about all DataStores in a WorkSpace.

Parameters:

workspace - The name of the workspace

Returns:

summary info about Datastores as a RESTDataStoreList

getDatastore

public RESTDataStore getDatastore(String workspace,
                                  String dsName)

Get detailed info about a given Datastore in a given Workspace.

Parameters:

workspace - The name of the workspace

dsName - The name of the Datastore

Returns:

DataStore details as a RESTDataStore

getDatastore

public RESTDataStore getDatastore(RESTFeatureType featureType)

Get detailed info about a FeatureType's Datastore.

Parameters:

featureType - the RESTFeatureType

Returns:

DataStore details as a RESTDataStore

getFeatureType

public RESTFeatureType getFeatureType(RESTLayer layer)

Get detailed info about a FeatureType given the Layer where it's published with.

Parameters:

layer - A layer publishing the FeatureType

Returns:

FeatureType details as a RESTCoverage

getCoverageStores

public RESTCoverageStoreList getCoverageStores(String workspace)

Get summary info about all CoverageStores in a WorkSpace.

Parameters:

workspace - The name of the workspace

Returns:

summary info about CoverageStores as a RESTDataStoreList

getCoverageStore

public RESTCoverageStore getCoverageStore(String workspace,
                                          String csName)

Get detailed info about a given CoverageStore in a given Workspace.

Parameters:

workspace - The name of the workspace

csName - The name of the CoverageStore

Returns:

CoverageStore details as a RESTCoverageStore

getCoverageStore

public RESTCoverageStore getCoverageStore(RESTCoverage coverage)

Get detailed info about a Coverage's Datastore.

Parameters:

coverage - the RESTFeatureType

Returns:

CoverageStore details as a RESTCoverageStore

getCoverages

public RESTCoverageList getCoverages(String workspace,
                                     String csName)

Get list of coverages (usually only one).

Parameters:

workspace - The name of the workspace

csName - The name of the CoverageStore

Returns:

Coverages list as a RESTCoverageList

getCoverage

public RESTCoverage getCoverage(String workspace,
                                String store,
                                String name)

Get detailed info about a given Coverage.

Parameters:

workspace - The name of the workspace

store - The name of the CoverageStore

name - The name of the Coverage

Returns:

Coverage details as a RESTCoverage

getCoverage

public RESTCoverage getCoverage(RESTLayer layer)

Get detailed info about a Coverage given the Layer where it's published with.

Parameters:

layer - A layer publishing the CoverageStore

Returns:

Coverage details as a RESTCoverage

getResource

public RESTResource getResource(RESTLayer layer)

Get detailed info about a Resource given the Layer where it's published with. The Resource can then be converted to RESTCoverage or RESTFeatureType

Returns:

Resource details as a RESTResource

getLayerGroups

public RESTLayerGroupList getLayerGroups(String workspace)

Get summary info about all LayerGroups in the given workspace.

Parameters:

workspace - name of the workspace

Returns:

summary info about LayerGroups as a RESTLayerGroupList

getLayerGroup

public RESTLayerGroup getLayerGroup(String workspace,
                                    String name)

Get detailed info about a given LayerGroup.

Parameters:

workspace - name of the workspace

name - the name of the LayerGroup

Returns:

LayerGroup details as a RESTLayerGroup

getLayerGroups

public RESTLayerGroupList getLayerGroups()

Get summary info about all LayerGroups.

Returns:

summary info about LayerGroups as a RESTLayerGroupList

getLayerGroup

public RESTLayerGroup getLayerGroup(String name)

Get detailed info about a given LayerGroup.

Parameters:

name - The name of the LayerGroup

Returns:

LayerGroup details as a RESTLayerGroup

getLayers

public RESTLayerList getLayers()

Get summary info about all Layers.

Returns:

summary info about Layers as a RESTLayerList

getFeatureTypes

public RESTFeatureTypeList getFeatureTypes(String workspace)

Get summary info about all FeatureTypes of a workspace.

Returns:

summary info about Layers as a RESTLayerList

getLayer

public RESTLayer getLayer(String name)

Deprecated. use getLayer(String, String)

Get detailed info about a given Layer.

Parameters:

name - The name of the Layer

Returns:

Layer details as a RESTLayer

getLayer

public RESTLayer getLayer(String workspace,
                          String name)

Get detailed info about a given Layer.

Parameters:

workspace - the workspace name

name - the layer name

Returns:

a RESTLayer with layer information or null

getNamespace

public RESTNamespace getNamespace(String prefix)

Get a namespace.

Parameters:

prefix - namespace prefix.

Returns:

a RESTNamespace, or null if couldn't be created.

getNamespaces

public RESTNamespaceList getNamespaces()

Get summary info about all Namespaces.

Returns:

summary info about Namespaces as a RESTNamespaceList

getNamespaceNames

public List<String> getNamespaceNames()

Get the names of all the Namespaces.
This is a shortcut call: These info could be retrieved using getNamespaces

Returns:

the list of the names of all Namespaces.

getWorkspaces

public RESTWorkspaceList getWorkspaces()

Get summary info about all Workspaces.

Returns:

summary info about Workspaces as a RESTWorkspaceList

getWorkspaceNames

public List<String> getWorkspaceNames()

Get the names of all the Workspaces.
This is a shortcut call: These info could be retrieved using getWorkspaces

Returns:

the list of the names of all Workspaces or an empty list.

getGranuleById

public RESTStructuredCoverageGranulesList getGranuleById(String workspace,
                                                         String coverageStore,
                                                         String coverage,
                                                         String id)
                                                  throws MalformedURLException,
                                                         UnsupportedEncodingException

Get information about a granule for a structured coverage.

Parameters:

workspace - the GeoServer workspace

coverageStore - the GeoServer coverageStore

format - the format of the file to upload

the - absolute path to the file to upload

id - the ID of the granule to get information for

Returns:

null in case the call does not succeed, or an instance of RESTStructuredCoverageGranulesList.

Throws:

MalformedURLException

UnsupportedEncodingException

getGranuleIndexSchema

public RESTStructuredCoverageIndexSchema getGranuleIndexSchema(String workspace,
                                                               String coverageStore,
                                                               String coverage)
                                                        throws MalformedURLException

Get information about the schema of the index for a structured coverage.

Parameters:

workspace - the GeoServer workspace

coverageStore - the GeoServer coverageStore

format - the format of the file to upload

Returns:

null in case the call does not succeed, or an instance of RESTStructuredCoverageGranulesList.

Throws:

MalformedURLException

UnsupportedEncodingException

getGranules

public RESTStructuredCoverageGranulesList getGranules(String workspace,
                                                      String coverageStore,
                                                      String coverage,
                                                      String filter,
                                                      Integer offset,
                                                      Integer limit)
                                               throws MalformedURLException,
                                                      UnsupportedEncodingException

Get information about the granules for a coverage with optional filter and paging.

Parameters:

workspace - the GeoServer workspace

coverageStore - the GeoServer coverageStore

coverage - the name of the target coverage

filter - the format of the file to upload, can be null to include all the granules

offset - the start page, can be null or an integer

limit - the dimension of the page, can be null or a positive integer

Returns:

null in case the call does not succeed, or an instance of RESTStructuredCoverageGranulesList.

Throws:

MalformedURLException

UnsupportedEncodingException