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

Class DefaultConfiguration

java.lang.Object

org.gcube.spatial.data.geonetwork.configuration.DefaultConfiguration

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

LocalResourceConfiguration

public class DefaultConfiguration
extends Object
implements Configuration

Field Summary

Fields

Modifier and Type	Field	Description
protected static Properties	props	Properties loaded at startup.

Constructor Summary

Constructors

Constructor	Description
DefaultConfiguration()	Constructs a new DefaultConfiguration instance.

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
protected List<org.gcube.common.resources.gcore.ServiceEndpoint>	doTheQuery(String geonetworkCategory, String geonetworkPlatformName)	Executes a query to find service endpoints.
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.
protected org.gcube.common.resources.gcore.ServiceEndpoint.AccessPoint	getIsAccessPoint()	Gets the access point from Information System.
protected org.gcube.common.resources.gcore.ServiceEndpoint	getISServiceEndpoint()	Gets the service endpoint from Information System.
Set<ScopeConfiguration>	getParentScopesConfiguration()	Gets configurations from parent scopes.
ScopeConfiguration	getScopeConfiguration()	Gets the current scope configuration.
protected static final org.gcube.common.resources.gcore.ServiceEndpoint.AccessPoint	getTheRightAccessPoint(org.gcube.common.resources.gcore.ServiceEndpoint... resources)	Looks for the access point compliant with configured endpointName and max priority (1).
protected static final org.gcube.common.resources.gcore.ServiceEndpoint	getTheRightServiceEndpoint(org.gcube.common.resources.gcore.ServiceEndpoint... resources)	Looks for the service endpoint compliant with configured endpointName and max priority (1).
protected void	loadFromIs()	Loads configuration from Information System (IS).
protected void	storeAndReload(ScopeConfiguration toStore)	UPDATE existing values and store new ones
protected org.gcube.common.resources.gcore.ServiceEndpoint	update(org.gcube.common.resources.gcore.ServiceEndpoint toStore)	Updates a service endpoint in the registry.

Methods inherited from class java.lang.Object

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

Field Details

props

protected static Properties props

Properties loaded at startup.

Constructor Details

DefaultConfiguration

public DefaultConfiguration()
                     throws EncryptionException,
MissingConfigurationException

Constructs a new DefaultConfiguration instance.

Throws:

EncryptionException - if an encryption error occurs

MissingConfigurationException - if the configuration is missing

Method Details

getGeoNetworkVersion

public ServerAccess.Version getGeoNetworkVersion()
                                          throws MissingServiceEndpointException

Description copied from interface: Configuration

Gets the GeoNetwork version.

Specified by:

getGeoNetworkVersion in interface Configuration

Returns:

the GeoNetwork version

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getAdminAccount

public Account getAdminAccount()
                        throws MissingServiceEndpointException

Description copied from interface: Configuration

Gets the admin account.

Specified by:

getAdminAccount in interface Configuration

Returns:

the admin account

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getGeoNetworkEndpoint

public String getGeoNetworkEndpoint()
                             throws MissingServiceEndpointException

Description copied from interface: Configuration

Gets the GeoNetwork endpoint URL.

Specified by:

getGeoNetworkEndpoint in interface Configuration

Returns:

the GeoNetwork endpoint URL

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getScopeConfiguration

public ScopeConfiguration getScopeConfiguration()
                                         throws MissingConfigurationException,
MissingServiceEndpointException

Description copied from interface: Configuration

Gets the current scope configuration.

Specified by:

getScopeConfiguration in interface Configuration

Returns:

current scope configuration

Throws:

MissingConfigurationException - if the configuration is missing

MissingServiceEndpointException - if the service endpoint cannot be found

createScopeConfiguration

public void createScopeConfiguration(ScopeConfiguration toCreate)
                              throws MissingServiceEndpointException

Description copied from interface: Configuration

Store the passed configuration

Specified by:

createScopeConfiguration in interface Configuration

Parameters:

toCreate - the configuration to create and store

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

acquireConfiguration

public ScopeConfiguration acquireConfiguration()
                                        throws MissingServiceEndpointException,
MissingConfigurationException

Description copied from interface: Configuration

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

Specified by:

acquireConfiguration in interface Configuration

Returns:

the acquired scope configuration

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

MissingConfigurationException - if no available configuration is found

getExistingConfigurations

public Set<ScopeConfiguration> getExistingConfigurations()
                                                  throws MissingServiceEndpointException

Description copied from interface: Configuration

Gets all existing configurations.

Specified by:

getExistingConfigurations in interface Configuration

Returns:

set of existing scope configurations

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getParentScopesConfiguration

public Set<ScopeConfiguration> getParentScopesConfiguration()
                                                     throws MissingServiceEndpointException

Description copied from interface: Configuration

Gets configurations from parent scopes.

Specified by:

getParentScopesConfiguration in interface Configuration

Returns:

set of parent scope configurations

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

loadFromIs

protected void loadFromIs()
                   throws MissingServiceEndpointException

Loads configuration from Information System (IS).

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getIsAccessPoint

protected org.gcube.common.resources.gcore.ServiceEndpoint.AccessPoint getIsAccessPoint()
                                                                                 throws MissingServiceEndpointException

Gets the access point from Information System.

Returns:

the access point

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getISServiceEndpoint

protected org.gcube.common.resources.gcore.ServiceEndpoint getISServiceEndpoint()
                                                                         throws MissingServiceEndpointException

Gets the service endpoint from Information System.

Returns:

the service endpoint

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

getTheRightAccessPoint

protected static final org.gcube.common.resources.gcore.ServiceEndpoint.AccessPoint getTheRightAccessPoint(org.gcube.common.resources.gcore.ServiceEndpoint... resources)

Looks for the access point compliant with configured endpointName and max priority (1).

Parameters:

resources - service endpoints to search

Returns:

the access point with highest priority, or null if not present

getTheRightServiceEndpoint

protected static final org.gcube.common.resources.gcore.ServiceEndpoint getTheRightServiceEndpoint(org.gcube.common.resources.gcore.ServiceEndpoint... resources)

Looks for the service endpoint compliant with configured endpointName and max priority (1).

Parameters:

resources - service endpoints to search

Returns:

the service endpoint with highest priority, or null if not present

doTheQuery

protected List<org.gcube.common.resources.gcore.ServiceEndpoint> doTheQuery(String geonetworkCategory,
 String geonetworkPlatformName)

Executes a query to find service endpoints.

Parameters:

geonetworkCategory - the GeoNetwork category to search for

geonetworkPlatformName - the GeoNetwork platform name to search for

Returns:

list of matching service endpoints

storeAndReload

protected void storeAndReload(ScopeConfiguration toStore)
                       throws MissingServiceEndpointException

UPDATE existing values and store new ones

Parameters:

toStore - the scope configuration to store and reload

Throws:

MissingServiceEndpointException - if the service endpoint cannot be found

update

protected org.gcube.common.resources.gcore.ServiceEndpoint update(org.gcube.common.resources.gcore.ServiceEndpoint toStore)

Updates a service endpoint in the registry.

Parameters:

toStore - the service endpoint to update

Returns:

the updated service endpoint