Package org.gcube.spatial.data.geonetwork.configuration

Interface Configuration

All Known Implementing Classes:

DefaultConfiguration, LocalResourceConfiguration

public interface Configuration

Interface for managing GeoNetwork configurations.

Method Summary

Modifier and Type	Method	Description
ScopeConfiguration	acquireConfiguration()	Assigns an available configuration to the current scope and returns it.
void	createScopeConfiguration(ScopeConfiguration toCreate)	Store the passed configuration
Account	getAdminAccount()	Gets the admin account.
Set<ScopeConfiguration>	getExistingConfigurations()	Gets all existing configurations.
String	getGeoNetworkEndpoint()	Gets the GeoNetwork endpoint URL.
ServerAccess.Version	getGeoNetworkVersion()	Gets the GeoNetwork version.
Set<ScopeConfiguration>	getParentScopesConfiguration()	Gets configurations from parent scopes.
ScopeConfiguration	getScopeConfiguration()	Gets the current scope configuration.

Method Details

getGeoNetworkEndpoint

String getGeoNetworkEndpoint()
                      throws MissingServiceEndpointException

Gets the GeoNetwork endpoint URL.

Returns:

the GeoNetwork endpoint URL

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getGeoNetworkVersion

ServerAccess.Version getGeoNetworkVersion()
                                   throws MissingServiceEndpointException

Gets the GeoNetwork version.

Returns:

the GeoNetwork version

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getScopeConfiguration

ScopeConfiguration getScopeConfiguration()
                                  throws MissingServiceEndpointException,
MissingConfigurationException

Gets the current scope configuration.

Returns:

current scope configuration

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

MissingConfigurationException - if the configuration is missing

acquireConfiguration

ScopeConfiguration acquireConfiguration()
                                 throws MissingServiceEndpointException,
MissingConfigurationException

Assigns an available configuration to the current scope and returns it.

Returns:

the acquired scope configuration

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

MissingConfigurationException - if no available configuration is found

getAdminAccount

Account getAdminAccount()
                 throws MissingServiceEndpointException

Gets the admin account.

Returns:

the admin account

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getExistingConfigurations

Set<ScopeConfiguration> getExistingConfigurations()
                                           throws MissingServiceEndpointException

Gets all existing configurations.

Returns:

set of existing scope configurations

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getParentScopesConfiguration

Set<ScopeConfiguration> getParentScopesConfiguration()
                                              throws MissingServiceEndpointException

Gets configurations from parent scopes.

Returns:

set of parent scope configurations

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

createScopeConfiguration

void createScopeConfiguration(ScopeConfiguration toCreate)
                       throws MissingServiceEndpointException

Store the passed configuration

Parameters:

toCreate - the configuration to create and store

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found