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

Interface ImplementationProvider

All Known Implementing Classes:

FileSystemImplementationProvider

public interface ImplementationProvider

Interface that provide all necessary classes of a eDAL implementations.

Method Summary

Modifier and Type	Method	Description
MetaData	createMetaDataInstance()	Create an new instance of the MetaData implementation class.
java.lang.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.
java.lang.Class<? extends HttpServiceProvider>	getHttpServiceProvider()	Getter for the HttpServiceProvider implementation class.
org.apache.logging.log4j.Logger	getLogger()	Getter for the current logger for system output
java.lang.Class<? extends PermissionProvider>	getPermissionProvider()	Getter for the PermissionProvider implementation class.
java.lang.Class<? extends PrimaryDataDirectory>	getPrimaryDataDirectoryProvider()	Getter for the PrimaryDataDirectory implementation class.
java.lang.Class<? extends PrimaryDataFile>	getPrimaryDataFileProvider()	Getter for the PrimaryDataFile implementation class.
java.lang.Class<? extends ServiceProvider>	getServiceProvider()	Getter for the ServiceProvider implementation class.
PrimaryDataDirectory	mount(java.util.List<java.lang.Class<? extends java.security.Principal>> supportedPrincipals)	Check if a root PrimaryDataDirectory exists and return it or create an new root PrimaryDataDirectory
PrimaryDataEntity	reloadPrimaryDataEntityByID(java.lang.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

java.lang.Class<? extends ApprovalServiceProvider> getApprovalServiceProvider()

Getter for the ApprovalServiceProvider implementation class

Returns:

the implementing class of ApprovalServiceProvider

getServiceProvider

java.lang.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.logging.log4j.Logger getLogger()

Getter for the current logger for system output

Returns:

Logger

getPermissionProvider

java.lang.Class<? extends PermissionProvider> getPermissionProvider()

Getter for the PermissionProvider implementation class.

Returns:

the instance of PermissionProvider to be use.

getPrimaryDataDirectoryProvider

java.lang.Class<? extends PrimaryDataDirectory> getPrimaryDataDirectoryProvider()

Getter for the PrimaryDataDirectory implementation class.

Returns:

the implementing class of PrimaryDataDirectory.

getHttpServiceProvider

java.lang.Class<? extends HttpServiceProvider> getHttpServiceProvider()

Getter for the HttpServiceProvider implementation class.

Returns:

the implementing class of HttpServiceProvider.

getPrimaryDataFileProvider

java.lang.Class<? extends PrimaryDataFile> getPrimaryDataFileProvider()

Getter for the PrimaryDataFile implementation class.

Returns:

the implementing class of PrimaryDataFile.

mount

PrimaryDataDirectory mount(java.util.List<java.lang.Class<? extends java.security.Principal>> supportedPrincipals)
                    throws PrimaryDataDirectoryException

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

Parameters:

supportedPrincipals - the supported Principals

Returns:

the root PrimaryDataDirectory.

Throws:

PrimaryDataDirectoryException - if unable to mount with the eDAL system.

reloadPrimaryDataEntityByID

PrimaryDataEntity reloadPrimaryDataEntityByID(java.lang.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