de.ipk_gatersleben.bit.bi.edal.primary_data.file

Interface ImplementationProvider

public interface ImplementationProvider

Interface that provide all necessary classes of a eDAL implementations.

Author:

lange, arendd

Method Summary

Methods

Modifier and Type	Method and Description
MetaData	createMetaDataInstance() Create an new instance of the MetaData implementation class.
Class<? extends ApprovalServiceProvider>	getApprovalServiceProvider() Getter for the ApprovalServiceProvider implementation class
EdalConfiguration	getConfiguration() Getter for the configuration class with all parameter to start the eDAL system.
Class<? extends HttpServiceProvider>	getHttpServiceProvider() Getter for the HttpServiceProvider implementation class.
org.apache.log4j.Logger	getLogger() Getter for the current logger for system output
Class<? extends de.ipk_gatersleben.bit.bi.edal.primary_data.security.PermissionProvider>	getPermissionProvider() Getter for the PermissionProvider implementation class.
Class<? extends PrimaryDataDirectory>	getPrimaryDataDirectoryProvider() Getter for the PrimaryDataDirectory implementation class.
Class<? extends PrimaryDataFile>	getPrimaryDataFileProvider() Getter for the PrimaryDataFile implementation class.
Class<? extends ServiceProvider>	getServiceProvider() Getter for the ServiceProvider implementation class.
PrimaryDataDirectory	mount(List<Class<? extends Principal>> supportedPrincipals) Check if a root PrimaryDataDirectory exists and return it or create an new root PrimaryDataDirectory
PrimaryDataEntity	reloadPrimaryDataEntityByID(String uuid, long versionNumber) Internal Function to reload a PrimaryDataEntity with his UUID.
void	shutdown() Cleanup all resources used by the particular implementation provider

Method Detail

createMetaDataInstance

MetaData createMetaDataInstance()

Create an new instance of the MetaData implementation class.

Returns:

a instance of the implementing class of MetaData.

getApprovalServiceProvider

Class<? extends ApprovalServiceProvider> getApprovalServiceProvider()

Getter for the ApprovalServiceProvider implementation class

Returns:

the implementing class of ApprovalServiceProvider

getServiceProvider

Class<? extends ServiceProvider> getServiceProvider()

Getter for the ServiceProvider implementation class.

Returns:

the implementing class of ServiceProvider.

getConfiguration

EdalConfiguration getConfiguration()

Getter for the configuration class with all parameter to start the eDAL system.

Returns:

an EdalConfiguration class.

getLogger

org.apache.log4j.Logger getLogger()

Getter for the current logger for system output

Returns:

Logger

getPermissionProvider

Class<? extends de.ipk_gatersleben.bit.bi.edal.primary_data.security.PermissionProvider> getPermissionProvider()

Getter for the PermissionProvider implementation class.

Returns:

the instance of PermissionProvider to be use.

getPrimaryDataDirectoryProvider

Class<? extends PrimaryDataDirectory> getPrimaryDataDirectoryProvider()

Getter for the PrimaryDataDirectory implementation class.

Returns:

the implementing class of PrimaryDataDirectory.

getHttpServiceProvider

Class<? extends HttpServiceProvider> getHttpServiceProvider()

Getter for the HttpServiceProvider implementation class.

Returns:

the implementing class of HttpServiceProvider.

getPrimaryDataFileProvider

Class<? extends PrimaryDataFile> getPrimaryDataFileProvider()

Getter for the PrimaryDataFile implementation class.

Returns:

the implementing class of PrimaryDataFile.

mount

PrimaryDataDirectory mount(List<Class<? extends Principal>> supportedPrincipals)
                           throws PrimaryDataDirectoryException

Check if a root PrimaryDataDirectory exists and return it or create an new root PrimaryDataDirectory

Returns:

the root PrimaryDataDirectory.

Throws:

PrimaryDataDirectoryException - if unable to mount with the eDAL system.

reloadPrimaryDataEntityByID

PrimaryDataEntity reloadPrimaryDataEntityByID(String uuid,
                                            long versionNumber)
                                              throws EdalException

Internal Function to reload a PrimaryDataEntity with his UUID.

Parameters:

uuid - the UUID of the PrimaryDataEntity

versionNumber - the number of the PrimaryDataEntityVersion

Returns:

the PrimaryDataEntity

Throws:

EdalException - if unable to find a PrimaryDataEntity

shutdown

void shutdown()

Cleanup all resources used by the particular implementation provider