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
Long	getAvailableStorageSpace() Getter for the available space in the mount path of eDAL.
EdalConfiguration	getConfiguration() Getter for the configuration class with all parameter to start the eDAL system.
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.
javax.mail.internet.InternetAddress	getPreviousRootUser() Load the email address of the existing root user.
Class<? extends PrimaryDataDirectory>	getPrimaryDataDirectoryProvider() Getter for the PrimaryDataDirectory implementation class.
PrimaryDataEntity	getPrimaryDataEntityByID(String uuid, long versionNumber) Getter to load a PrimaryDataEntity object specified by UUID and number of the PrimaryDataEntityVersion.
PrimaryDataEntity	getPrimaryDataEntityForPersistenIdentifier(String uuid, long versionNumber, PersistentIdentifier persistentIdentifier)
PrimaryDataEntity	getPrimaryDataEntityForReviewer(String uuid, long versionNumber, String internalId, int reviewerCode) Getter for a PrimaryDataEntity for a reviewer to create a temporary landing page.
Class<? extends PrimaryDataFile>	getPrimaryDataFileProvider() Getter for the PrimaryDataFile implementation class.
javax.mail.internet.InternetAddress	getRootUser()
List<Class<? extends Principal>>	getSupportedPrincipals() Getter all supported Principals of the current eDAL system.
Long	getUsedStorageSpace() Getter for the used space in the mount path of eDAL.
boolean	isRootValidated(javax.mail.internet.InternetAddress address)
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)
void	shutdown() Cleanup all resources used by the particular implementation provider
void	storeRootUser(Subject subject, javax.mail.internet.InternetAddress address, UUID uuid)
boolean	validateRootUser(javax.mail.internet.InternetAddress address, UUID uuid)

Method Detail

createMetaDataInstance

MetaData createMetaDataInstance()

Create an new instance of the MetaData implementation class.

Returns:

a instance of the implementing class of MetaData.

getAvailableStorageSpace

Long getAvailableStorageSpace()
                              throws EdalException

Getter for the available space in the mount path of eDAL.

Returns:

available space

Throws:

EdalException - if no path is specified.

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.

getPrimaryDataEntityByID

PrimaryDataEntity getPrimaryDataEntityByID(String uuid,
                                         long versionNumber)
                                           throws EdalException

Getter to load a PrimaryDataEntity object specified by UUID and number of the PrimaryDataEntityVersion.

Parameters:

uuid - the UUID of the PrimaryDataEntity.

versionNumber - the version number of the PrimaryDataEntityVersion.

Returns:

the specified PrimaryDataEntity

Throws:

EdalException - if there is no PrimaryDataEntity with the specified values.

getPrimaryDataFileProvider

Class<? extends PrimaryDataFile> getPrimaryDataFileProvider()

Getter for the PrimaryDataFile implementation class.

Returns:

the implementing class of PrimaryDataFile.

getSupportedPrincipals

List<Class<? extends Principal>> getSupportedPrincipals()
                                                        throws EdalException

Getter all supported Principals of the current eDAL system.

Returns:

the list of supported Principals

Throws:

EdalException - if unable to load Principals.

getUsedStorageSpace

Long getUsedStorageSpace()
                         throws EdalException

Getter for the used space in the mount path of eDAL.

Returns:

used space

Throws:

EdalException - if no path is specified.

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.

shutdown

void shutdown()

Cleanup all resources used by the particular implementation provider

getApprovalServiceProvider

Class<? extends ApprovalServiceProvider> getApprovalServiceProvider()

Getter for the ApprovalServiceProvider implementation class

Returns:

the implementing class of ApprovalServiceProvider

getConfiguration

EdalConfiguration getConfiguration()

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

Returns:

an EdalConfiguration class.

getPrimaryDataEntityForReviewer

PrimaryDataEntity getPrimaryDataEntityForReviewer(String uuid,
                                                long versionNumber,
                                                String internalId,
                                                int reviewerCode)
                                                  throws EdalException

Getter for a PrimaryDataEntity for a reviewer to create a temporary landing page.

Parameters:

uuid - the id of the PrimaryDataEntity

versionNumber - the number of the PrimaryDataEntityVersion

internalId - the internal ID of the corresponding PublicReference

reviewerCode - the id to identify a reviewer

Returns:

the searched PrimaryDataEntity

Throws:

EdalException - if unable to load the PrimaryDataEntity

getPreviousRootUser

javax.mail.internet.InternetAddress getPreviousRootUser()
                                                        throws EdalException

Load the email address of the existing root user.

Returns:

the email address.

Throws:

EdalException - If unable to load existing root user.

getRootUser

javax.mail.internet.InternetAddress getRootUser()

storeRootUser

void storeRootUser(Subject subject,
                 javax.mail.internet.InternetAddress address,
                 UUID uuid)
                   throws EdalException

Throws:

EdalException

isRootValidated

boolean isRootValidated(javax.mail.internet.InternetAddress address)

validateRootUser

boolean validateRootUser(javax.mail.internet.InternetAddress address,
                       UUID uuid)

getPrimaryDataEntityForPersistenIdentifier

PrimaryDataEntity getPrimaryDataEntityForPersistenIdentifier(String uuid,
                                                           long versionNumber,
                                                           PersistentIdentifier persistentIdentifier)
                                                             throws EdalException

Throws:

EdalException

reloadPrimaryDataEntityByID

PrimaryDataEntity reloadPrimaryDataEntityByID(String uuid,
                                            long versionNumber)
                                              throws EdalException

Throws:

EdalException