org.javamoney.moneta.internal.loader

Class DefaultLoaderService

java.lang.Object

org.javamoney.moneta.internal.loader.DefaultLoaderService

All Implemented Interfaces:

LoaderService

public class DefaultLoaderService
extends Object
implements LoaderService

This class provides a mechanism to register resources, that may be updated regularly. The implementation, based on the UpdatePolicy loads/updates the resources from arbitrary locations and stores it to the format file cache. Default loading tasks can be configured within the javamoney.properties file, @see org.javamoney.moneta.loader.format.LoaderConfigurator .

Author:

Anatole Tresch

Nested Class Summary

Nested classes/interfaces inherited from interface org.javamoney.moneta.spi.LoaderService

LoaderService.LoaderListener, LoaderService.UpdatePolicy

Constructor Summary

Constructors

Constructor and Description
DefaultLoaderService() Constructor, initializing from config.

Method Summary

Modifier and Type	Method and Description
void	addLoaderListener(LoaderService.LoaderListener l, String... resourceIds) Add a LoaderService.LoaderListener callback that is informed when a data resource was update from remote, or resetToFallback.
InputStream	getData(String resourceId) Access the input stream of the given data resource.
Set<String>	getResourceIds() Get a Set of all registered data resource identifiers.
Map<String,String>	getUpdateConfiguration(String resourceId) Get the update configuration for the given dataId.
LoaderService.UpdatePolicy	getUpdatePolicy(String resourceId) Get the LoaderService.UpdatePolicy in place for the given dataId.
boolean	isResourceRegistered(String resourceId) Allows to check if a data resource with the given dataId is registered.
boolean	loadData(String resourceId) Explicitly triggers the remote loading of the registered data, regardless of its current LoaderService.UpdatePolicy configured.
Future<Boolean>	loadDataAsync(String resourceId) Explicitly asynchronously triggers the remote loading of the registered data, regardless of its current LoaderService.UpdatePolicy configured.
boolean	loadDataLocal(String resourceId) Explicitly triggers the loading of the registered data, regardless of its current LoaderService.UpdatePolicy configured, from the fallback/local resource.
void	registerAndLoadData(LoadDataInformation loadDataInformation) Programmatically registers a remote resource resourceLocation, backed up by a classpath resource backupResource, reachable as dataId and (synchronously) loads the data.
void	registerAndLoadData(String resourceId, LoaderService.UpdatePolicy updatePolicy, Map<String,String> properties, LoaderService.LoaderListener loaderListener, URI backupResource, URI... resourceLocations)
void	registerData(LoadDataInformation loadDataInformation) Programmatically registers a remote resource resourceLocation, backed up by a classpath resource backupResource, reachable as dataId.
void	registerData(String resourceId, LoaderService.UpdatePolicy updatePolicy, Map<String,String> properties, LoaderService.LoaderListener loaderListener, URI backupResource, URI... resourceLocations)
void	removeLoaderListener(LoaderService.LoaderListener loadListener, String... resourceIds) Remove a registered LoaderService.LoaderListener callback.
void	resetData(String resourceId) Explicitly triggers the resetToFallback (loading of the registered data from the classpath backup resource).
String	toString()
void	unload(String resourceId) Removes a resource managed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLoaderService

public DefaultLoaderService()

Constructor, initializing from config.

Method Detail

unload

public void unload(String resourceId)

Removes a resource managed.

Parameters:

resourceId - the resource id.

registerData

public void registerData(LoadDataInformation loadDataInformation)

Description copied from interface: LoaderService

Programmatically registers a remote resource resourceLocation, backed up by a classpath resource backupResource, reachable as dataId. resourceId The unique identifier of the resource that must also be used for accessing the resource, not null. resourceLocations The remote resource locations, not null. backupResource The backup resource location in the classpath, not null. loaderListener An (optional) LoaderListener to be registered.

Specified by:

registerData in interface LoaderService

registerAndLoadData

public void registerAndLoadData(LoadDataInformation loadDataInformation)

Description copied from interface: LoaderService

Programmatically registers a remote resource resourceLocation, backed up by a classpath resource backupResource, reachable as dataId and (synchronously) loads the data. resourceId The unique identifier of the resource that must also be used for accessing the resource, not null. resourceLocations The remote resource locations, not null. backupResource The backup resource location in the classpath, not null. loaderListener An (optional) LoaderListener to be registered.

Specified by:

registerAndLoadData in interface LoaderService

registerAndLoadData

public void registerAndLoadData(String resourceId,
                                LoaderService.UpdatePolicy updatePolicy,
                                Map<String,String> properties,
                                LoaderService.LoaderListener loaderListener,
                                URI backupResource,
                                URI... resourceLocations)

Specified by:

registerAndLoadData in interface LoaderService

registerData

public void registerData(String resourceId,
                         LoaderService.UpdatePolicy updatePolicy,
                         Map<String,String> properties,
                         LoaderService.LoaderListener loaderListener,
                         URI backupResource,
                         URI... resourceLocations)

Specified by:

registerData in interface LoaderService

getUpdateConfiguration

public Map<String,String> getUpdateConfiguration(String resourceId)

Description copied from interface: LoaderService

Get the update configuration for the given dataId.

Specified by:

getUpdateConfiguration in interface LoaderService

Parameters:

resourceId - the dataId, not null

Returns:

the update configuration properties, not null

isResourceRegistered

public boolean isResourceRegistered(String resourceId)

Description copied from interface: LoaderService

Allows to check if a data resource with the given dataId is registered.

Specified by:

isResourceRegistered in interface LoaderService

Parameters:

resourceId - The unique identifier of the resource, not null.

Returns:

true, if such a data resource is registered.

getResourceIds

public Set<String> getResourceIds()

Description copied from interface: LoaderService

Get a Set of all registered data resource identifiers.

Specified by:

getResourceIds in interface LoaderService

Returns:

a Set of all registered data resource identifiers, never null.

getData

public InputStream getData(String resourceId)
                    throws IOException

Description copied from interface: LoaderService

Access the input stream of the given data resource.

This method is called by the modules that depend on the given data item. The method always returns the most current data, either from the classpath or the local cache, depending which flavors are available and recently updated.

The method must be thread safe and can be accessed in parallel. Hereby it is possible that, when an intermediate update of the data by update occurs, that different input stream content is returned.

Specified by:

getData in interface LoaderService

Parameters:

resourceId - The unique identifier of the resource, not null.

Returns:

The InputStream for reading the data.

Throws:

IOException - if a problem occurred.

loadData

public boolean loadData(String resourceId)

Description copied from interface: LoaderService

Explicitly triggers the remote loading of the registered data, regardless of its current LoaderService.UpdatePolicy configured.

Specified by:

loadData in interface LoaderService

Parameters:

resourceId - The unique identifier of the resource, not null.

Returns:

true if load was successful.

loadDataAsync

public Future<Boolean> loadDataAsync(String resourceId)

Description copied from interface: LoaderService

Explicitly asynchronously triggers the remote loading of the registered data, regardless of its current LoaderService.UpdatePolicy configured.

Specified by:

loadDataAsync in interface LoaderService

Parameters:

resourceId - The unique identifier of the resource, not null.

Returns:

the Future of the load task started, returns Boolean.TRUE if the load was successful (either from remote or from the fallback resource).

loadDataLocal

public boolean loadDataLocal(String resourceId)

Description copied from interface: LoaderService

Explicitly triggers the loading of the registered data, regardless of its current LoaderService.UpdatePolicy configured, from the fallback/local resource.

Specified by:

loadDataLocal in interface LoaderService

Parameters:

resourceId - The unique identifier of the resource, not null.

Returns:

true if load was successful.

resetData

public void resetData(String resourceId)
               throws IOException

Description copied from interface: LoaderService

Explicitly triggers the resetToFallback (loading of the registered data from the classpath backup resource).

Specified by:

resetData in interface LoaderService

Parameters:

resourceId - The unique identifier of the resource, not null.

Throws:

IOException - if a problem occurred.

addLoaderListener

public void addLoaderListener(LoaderService.LoaderListener l,
                              String... resourceIds)

Description copied from interface: LoaderService

Add a LoaderService.LoaderListener callback that is informed when a data resource was update from remote, or resetToFallback. Passing an empty String or null sa dataId allows to register a listener for all data resources registered. LoaderService.loadData(String) LoaderService.resetData(String)

Specified by:

addLoaderListener in interface LoaderService

Parameters:

l - The listener to be added

resourceIds - The unique identifiers of the resource, not null.

See Also:

LoaderService.removeLoaderListener(LoaderListener, String...)

removeLoaderListener

public void removeLoaderListener(LoaderService.LoaderListener loadListener,
                                 String... resourceIds)

Description copied from interface: LoaderService

Remove a registered LoaderService.LoaderListener callback.

Specified by:

removeLoaderListener in interface LoaderService

Parameters:

loadListener - The listener to be removed

resourceIds - The unique identifier of the resource, not null.

See Also:

LoaderService.addLoaderListener(LoaderListener, String...)

getUpdatePolicy

public LoaderService.UpdatePolicy getUpdatePolicy(String resourceId)

Description copied from interface: LoaderService

Get the LoaderService.UpdatePolicy in place for the given dataId.

Specified by:

getUpdatePolicy in interface LoaderService

Parameters:

resourceId - the resource's id, not null

Returns:

the LoaderService.UpdatePolicy, not null

toString

public String toString()

Overrides:

toString in class Object