de.ipk_gatersleben.bit.bi.edal.primary_data

Class DataManager

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.primary_data.DataManager

public class DataManager
extends Object

Central entry point for the clients to make use of the API provided storage functionality.

Author:

lange, arendd

Field Summary

Fields

Modifier and Type	Field and Description
static Map<Principal,List<GrantableMethods.Methods>>	DEFAULT_PERMISSIONS Constant map with all initial default permissions.
static String	TEST_DATA_STRING

Constructor Summary

Constructors

Constructor and Description
DataManager()

Method Summary

Methods

Modifier and Type	Method and Description
static Long	getAvailableStorageSpace() Getter for the available space in the mount path of eDAL.
static EdalConfiguration	getConfiguration() Getter for the EdalConfiguration.
static Map<Principal,List<GrantableMethods.Methods>>	getDefaultPermissions()
static ImplementationProvider	getImplProv() Getter for the current ImplementationProvider.
static ExecutorService	getJettyThreadPool() Getter for the ThreadPool for EdalJettyServer.
static ExecutorService	getListThreadPool() Getter for the ThreadPool for ListThread
static PrimaryDataDirectory	getRootDirectory(ImplementationProvider implementationProvider, Subject subject) Static function to get the root PrimaryDataDirectory of the eDAL-System.
static Subject	getSubject() In order to know, who is working with an eDAL data structure instance.
static List<Class<? extends Principal>>	getSupportedPrincipals() Getter all supported Principals of the current eDAL system.
static Long	getUsedStorageSpace() Getter for the used space in the mount path of eDAL.
static void	receiveTestData(OutputStream outputStream) Send an OutputStream containing a short String to test server connectivity
static void	resetDefaultPermissions() Reload all initial default permission in DEFAULT_PERMISSIONS.
static void	setDefaultPermissions(Map<Principal,List<GrantableMethods.Methods>> newUserPermissions) Overrides the current default permissions of the current user with the new permissions.
static void	setSubject(Subject subject) Setter for the current Subject.
static void	shutdown() Convenience function to shutdown the eDAL system.
static void	waitForShutDown()

Methods inherited from class java.lang.Object

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

Field Detail

TEST_DATA_STRING

public static final String TEST_DATA_STRING

See Also:

Constant Field Values

DEFAULT_PERMISSIONS

public static final Map<Principal,List<GrantableMethods.Methods>> DEFAULT_PERMISSIONS

Constant map with all initial default permissions.
ALLPrincipal:
Methods.listPrimaryDataEntities
Methods.listPrimaryDataEntitiesByDate
Methods.getPrimaryDataEntity
Methods.read
Methods.exist
Methods.getParentDirectory
Methods.getVersions
Methods.getCurrentVersion
Methods.searchByDublinCoreElement
Methods.searchByMetaData

Constructor Detail

DataManager

public DataManager()

Method Detail

getAvailableStorageSpace

public static 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.

getConfiguration

public static EdalConfiguration getConfiguration()

Getter for the EdalConfiguration.

Returns:

the current EdalConfiguration.

getDefaultPermissions

public static Map<Principal,List<GrantableMethods.Methods>> getDefaultPermissions()

Returns:

the current set default permissions.

getImplProv

public static ImplementationProvider getImplProv()

Getter for the current ImplementationProvider.

Returns:

ImplementationProvider with all implementing classes

getRootDirectory

public static PrimaryDataDirectory getRootDirectory(ImplementationProvider implementationProvider,
                                    Subject subject)
                                             throws PrimaryDataDirectoryException

Static function to get the root PrimaryDataDirectory of the eDAL-System.

Parameters:

implementationProvider - must provide the implementing classes the implementation, which will be used. The call pass the current logged in JAAS subject.For example:

 ImplementationProvider myImpl = new MyEDALImplementation();
 LoginContext CTX = new LoginContext(...);
        CTX();
        Subject mySubject = CTX.getSubject();
 PrimaryDataDirectory root_dir = DataManager.getRootDirectory(myImpl, mySubject);
 

subject - the authenticated subject

Returns:

the root PrimaryDataDirectory for the passed implementation

Throws:

PrimaryDataDirectoryException - if unable to create MetaData instance or if unable to initialize security system.

getSubject

public static Subject getSubject()

In order to know, who is working with an eDAL data structure instance. We bind in the getRootDirectory(ImplementationProvider, Subject) function the subject as ThreadLocal object to the current thread

Returns:

Subject the subject working in its Thread with a eDAL mount

getSupportedPrincipals

public static 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

public static 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.

resetDefaultPermissions

public static void resetDefaultPermissions()

Reload all initial default permission in DEFAULT_PERMISSIONS.

setDefaultPermissions

public static void setDefaultPermissions(Map<Principal,List<GrantableMethods.Methods>> newUserPermissions)

Overrides the current default permissions of the current user with the new permissions.

Parameters:

newUserPermissions - the user permissions to set to the default permissions.

setSubject

public static void setSubject(Subject subject)

Setter for the current Subject.

Parameters:

subject - a Subject object.

shutdown

public static void shutdown()

Convenience function to shutdown the eDAL system.

waitForShutDown

public static void waitForShutDown()

getJettyThreadPool

public static ExecutorService getJettyThreadPool()

Getter for the ThreadPool for EdalJettyServer.

Returns:

ExecutorService

getListThreadPool

public static ExecutorService getListThreadPool()

Getter for the ThreadPool for ListThread

Returns:

ExecutorService

receiveTestData

public static void receiveTestData(OutputStream outputStream)
                            throws IOException

Send an OutputStream containing a short String to test server connectivity

Parameters:

outputStream - the OutputStream to fill in the String

Throws:

IOException - if unable to send