Package de.ipk_gatersleben.bit.bi.edal.rmi.interfaces

Interface DataManagerRmiInterface

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

DataManagerWrapper

public interface DataManagerRmiInterface
extends java.rmi.Remote

RMI Interface for DataManager objects.

Method Summary

Modifier and Type	Method	Description
javax.security.auth.Subject	authenticate(Authentication authentication)	authenticate a user and return on success a Subject
MetaData	createMetaDataInstance()	ImplementationProvider.shutdown()
java.lang.Long	getAvailableStorageSpace()	DataManager.getAvailableStorageSpace()
java.util.Map<java.security.Principal,java.util.List<GrantableMethods.Methods>>	getDefaultPermissions()	DataManager.getDefaultPermissions()
PrimaryDataDirectoryRmiInterface	getRootDirectory(javax.security.auth.Subject subject)	DataManager.getRootDirectory(de.ipk_gatersleben.bit.bi.edal.primary_data.file.ImplementationProvider, Subject)
java.util.List<java.lang.Class<? extends java.security.Principal>>	getSupportedPrincipals()	Get all supported Principals of the current eDAL system.
java.lang.Long	getUsedStorageSpace()	DataManager.getUsedStorageSpace()
void	receiveTestData(com.healthmarketscience.rmiio.RemoteOutputStream outputStream)
void	sendEmail(Authentication authentication, java.lang.String emailMessage, java.lang.String emailSubject)	Request the server to send a e-mail to an authenticated subject
void	sendEmail(Authentication authentication, java.lang.String emailMessage, java.lang.String emailSubject, java.net.URL attachment)	Request the server to send a e-mail with attachment to an authenticated subject
com.healthmarketscience.rmiio.RemoteInputStream	sendFileToClient(java.lang.String fileName)
com.healthmarketscience.rmiio.RemoteOutputStream	sendOutputStreamToFillFromClient(java.lang.String fileName)
void	shutdown()	ImplementationProvider.shutdown()

Method Detail

authenticate

javax.security.auth.Subject authenticate(Authentication authentication)
                                  throws java.rmi.RemoteException,
                                         EdalAuthenticateException

authenticate a user and return on success a Subject

Parameters:

authentication - Authentication

Returns:

the authenticated Subject

Throws:

java.rmi.RemoteException - if unable to call remote function.

EdalAuthenticateException - if unable to authenticate user

createMetaDataInstance

MetaData createMetaDataInstance()
                         throws java.rmi.RemoteException

ImplementationProvider.shutdown()

Returns:

a new MetaData object.

Throws:

java.rmi.RemoteException - if unable to call remote function.

See Also:

ImplementationProvider.createMetaDataInstance()

getAvailableStorageSpace

java.lang.Long getAvailableStorageSpace()
                                 throws java.rmi.RemoteException,
                                        EdalException

DataManager.getAvailableStorageSpace()

Returns:

available space

Throws:

java.rmi.RemoteException - if unable to call remote function.

EdalException - if no mount path is set.

See Also:

DataManager.getAvailableStorageSpace()

getDefaultPermissions

java.util.Map<java.security.Principal,java.util.List<GrantableMethods.Methods>> getDefaultPermissions()
                                                                                                     throws java.rmi.RemoteException

DataManager.getDefaultPermissions()

Returns:

map with all default permissions.

Throws:

java.rmi.RemoteException - if unable to call remote function.

See Also:

DataManager.getDefaultPermissions()

getRootDirectory

PrimaryDataDirectoryRmiInterface getRootDirectory(javax.security.auth.Subject subject)
                                           throws java.rmi.RemoteException,
                                                  PrimaryDataDirectoryException

DataManager.getRootDirectory(de.ipk_gatersleben.bit.bi.edal.primary_data.file.ImplementationProvider, Subject)

Parameters:

subject - the authenticated subject

Returns:

the root PrimaryDataDirectory for the passed implementation

Throws:

java.rmi.RemoteException - if unable to call remote function.

PrimaryDataDirectoryException - if any.

See Also:

DataManager.getRootDirectory(de.ipk_gatersleben.bit.bi.edal.primary_data.file.ImplementationProvider, Subject)

getSupportedPrincipals

java.util.List<java.lang.Class<? extends java.security.Principal>> getSupportedPrincipals()
                                                                                   throws java.rmi.RemoteException,
                                                                                          EdalException

Get all supported Principals of the current eDAL system.

Returns:

the list of supported Principals

Throws:

java.rmi.RemoteException - if unable to call remote function.

EdalException - if unable to load Principals.

getUsedStorageSpace

java.lang.Long getUsedStorageSpace()
                            throws java.rmi.RemoteException,
                                   EdalException

DataManager.getUsedStorageSpace()

Returns:

used space

Throws:

java.rmi.RemoteException - if unable to call remote function.

EdalException - if no mount path is set.

See Also:

DataManager.getAvailableStorageSpace()

receiveTestData

void receiveTestData(com.healthmarketscience.rmiio.RemoteOutputStream outputStream)
              throws java.rmi.RemoteException,
                     java.io.IOException

Throws:

java.rmi.RemoteException

java.io.IOException

sendEmail

void sendEmail(Authentication authentication,
               java.lang.String emailMessage,
               java.lang.String emailSubject)
        throws java.rmi.RemoteException

Request the server to send a e-mail to an authenticated subject

Parameters:

authentication - the user authentication

emailMessage - the content of the e-mail

emailSubject - the subject of the e-mail

Throws:

java.rmi.RemoteException - if unable to send eMail

sendEmail

void sendEmail(Authentication authentication,
               java.lang.String emailMessage,
               java.lang.String emailSubject,
               java.net.URL attachment)
        throws java.rmi.RemoteException

Request the server to send a e-mail with attachment to an authenticated subject

Parameters:

authentication - the user authentication

emailMessage - the content of the e-mail

emailSubject - the subject of the e-mail

attachment - the attached URL

Throws:

java.rmi.RemoteException - if unable to send eMail

sendFileToClient

com.healthmarketscience.rmiio.RemoteInputStream sendFileToClient(java.lang.String fileName)
                                                          throws java.rmi.RemoteException,
                                                                 java.io.FileNotFoundException,
                                                                 java.io.IOException

Throws:

java.rmi.RemoteException

java.io.FileNotFoundException

java.io.IOException

sendOutputStreamToFillFromClient

com.healthmarketscience.rmiio.RemoteOutputStream sendOutputStreamToFillFromClient(java.lang.String fileName)
                                                                           throws java.rmi.RemoteException,
                                                                                  java.io.FileNotFoundException

Throws:

java.rmi.RemoteException

java.io.FileNotFoundException

shutdown

void shutdown()
       throws java.rmi.RemoteException

ImplementationProvider.shutdown()

Throws:

java.rmi.RemoteException - if unable to call remote function.

See Also:

ImplementationProvider.shutdown()