org.gcube.spatial.data.clients.geoserver

Interface GSRESTClient

All Superinterfaces:

org.gcube.spatial.data.clients.GenericLoginClient, org.gcube.spatial.data.clients.SDIRESTClient

All Known Implementing Classes:

GSRESTClientImpl

public interface GSRESTClient
extends org.gcube.spatial.data.clients.GenericLoginClient

Based on https://docs.geoserver.org/latest/en/user/rest/index.html

Author:

FabioISTI

Method Summary

Modifier and Type	Method and Description
void	createLayerAsFeatureType(String ws, String dataStoreName, FeatureTypeInfo ft) /workspaces/{workspaceName}/coveragestores/{coveragestoreName}/coverages, /workspaces/{workspaceName}/datastores/{datastoreName}/featuretypes, /workspaces/{workspaceName}/wmsstores/{wmsstoreName}/wmslayers, or /workspaces/{workspaceName}/wmtsstores/{wmststoreName}/wmtslayers
void	createStyle(String name, String content)
void	createWorkspace(String ws)
void	deleteDataStore(String ds, boolean recurse)
void	deleteLayer(String layer, boolean recurse)
void	deleteStyle(String style, boolean purgeSLDFile, boolean updateReferences)
void	deleteWorkspace(String ws, boolean recurse)
org.json.simple.JSONObject	getDataStore(String workspace, String dsName)
org.json.simple.JSONObject	getDataStoresInWorkspace(String ws)
List<String>	getDataStoresNamesInWorkspace(String ws)
FeatureTypeInfo	getFeatureType(String workspace, String featureName)
List<String>	getFeatureTypesInDataStore(String workspace, String datastore)
List<String>	getFeatureTypesInWorkspace(String workspace)
org.json.simple.JSONObject	getLayer(String layerName)
org.json.simple.JSONObject	getLayerInWorkspace(String ws, String layerName)
List<String>	getLayers()
List<String>	getLayers(String workspace)
String	getSLD(String styleName)
org.json.simple.JSONObject	getStyles()
org.json.simple.JSONObject	getStylesByLayer(String layer)
org.json.simple.JSONObject	getStylesInWorkspace(String ws)
List<String>	getStylesNames()
List<String>	getStylesNamesByLayer(String layer)
List<String>	getStylesNamesinWorkspace(String ws)
org.json.simple.JSONObject	getWorkspace(String workspace)
List<String>	getWorkspaceNames()
org.json.simple.JSONObject	getWorkspaces()
void	publishDataStore(String ws, org.json.simple.JSONObject parameters) Publish a DS described in @param parameters.

Methods inherited from interface org.gcube.spatial.data.clients.GenericLoginClient

authenticate, authenticate

Methods inherited from interface org.gcube.spatial.data.clients.SDIRESTClient

exist, getInstance

Method Detail

getWorkspaces

org.json.simple.JSONObject getWorkspaces()
                                  throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                         Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getWorkspaceNames

List<String> getWorkspaceNames()
                        throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                               Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getWorkspace

org.json.simple.JSONObject getWorkspace(String workspace)
                                 throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                        Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getDataStoresInWorkspace

org.json.simple.JSONObject getDataStoresInWorkspace(String ws)
                                             throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                                    Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getDataStoresNamesInWorkspace

List<String> getDataStoresNamesInWorkspace(String ws)
                                    throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                           Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getDataStore

org.json.simple.JSONObject getDataStore(String workspace,
                                        String dsName)
                                 throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                        Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getStyles

org.json.simple.JSONObject getStyles()
                              throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                     Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getStylesNames

List<String> getStylesNames()
                     throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                            Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getStylesInWorkspace

org.json.simple.JSONObject getStylesInWorkspace(String ws)
                                         throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                                Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getStylesNamesinWorkspace

List<String> getStylesNamesinWorkspace(String ws)
                                throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                       Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getStylesByLayer

org.json.simple.JSONObject getStylesByLayer(String layer)
                                     throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                            Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getStylesNamesByLayer

List<String> getStylesNamesByLayer(String layer)
                            throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                   Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getSLD

String getSLD(String styleName)
       throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
              Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getFeatureTypesInWorkspace

List<String> getFeatureTypesInWorkspace(String workspace)
                                 throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                        Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getFeatureTypesInDataStore

List<String> getFeatureTypesInDataStore(String workspace,
                                        String datastore)
                                 throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                        Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getFeatureType

FeatureTypeInfo getFeatureType(String workspace,
                               String featureName)
                        throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                               Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getLayers

List<String> getLayers()
                throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                       Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getLayers

List<String> getLayers(String workspace)
                throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                       Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getLayer

org.json.simple.JSONObject getLayer(String layerName)
                             throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                    Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

getLayerInWorkspace

org.json.simple.JSONObject getLayerInWorkspace(String ws,
                                               String layerName)
                                        throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                                               Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

createWorkspace

void createWorkspace(String ws)
              throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                     Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

createStyle

void createStyle(String name,
                 String content)
          throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                 Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

publishDataStore

void publishDataStore(String ws,
                      org.json.simple.JSONObject parameters)
               throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                      Exception

Publish a DS described in @param parameters. Parameters vary depending on DS type. See https://docs.geoserver.org/latest/en/api/#1.0.0/datastores.yaml for more details.

Parameters:

ws -

parameters -

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

createLayerAsFeatureType

void createLayerAsFeatureType(String ws,
                              String dataStoreName,
                              FeatureTypeInfo ft)
                       throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                              Exception

/workspaces/{workspaceName}/coveragestores/{coveragestoreName}/coverages, /workspaces/{workspaceName}/datastores/{datastoreName}/featuretypes, /workspaces/{workspaceName}/wmsstores/{wmsstoreName}/wmslayers, or /workspaces/{workspaceName}/wmtsstores/{wmststoreName}/wmtslayers

Parameters:

ws -

recurse -

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

deleteWorkspace

void deleteWorkspace(String ws,
                     boolean recurse)
              throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                     Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

deleteStyle

void deleteStyle(String style,
                 boolean purgeSLDFile,
                 boolean updateReferences)
          throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                 Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

deleteDataStore

void deleteDataStore(String ds,
                     boolean recurse)
              throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                     Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception

deleteLayer

void deleteLayer(String layer,
                 boolean recurse)
          throws org.gcube.spatial.data.sdi.model.faults.RemoteException,
                 Exception

Throws:

org.gcube.spatial.data.sdi.model.faults.RemoteException

Exception