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

Interface PrimaryDataDirectoryRmiInterface

All Superinterfaces:

PrimaryDataEntityRmiInterface, java.rmi.Remote

All Known Implementing Classes:

PrimaryDataDirectoryWrapper

public interface PrimaryDataDirectoryRmiInterface
extends PrimaryDataEntityRmiInterface

RMI Interface for PrimaryDataDirectory objects.

Method Summary

Modifier and Type	Method	Description
PrimaryDataDirectoryRmiInterface	createPrimaryDataDirectory(java.lang.String path, javax.security.auth.Subject subject, java.util.Map<java.security.Principal,java.util.List<GrantableMethods.Methods>> defaultPermissions)	PrimaryDataDirectory.createPrimaryDataDirectory(String)
PrimaryDataFileRmiInterface	createPrimaryDataFile(java.lang.String name, javax.security.auth.Subject subject, java.util.Map<java.security.Principal,java.util.List<GrantableMethods.Methods>> defaultPermissions)	PrimaryDataDirectory.createPrimaryDataFile(String)
boolean	exist(java.lang.String path, javax.security.auth.Subject subject)	PrimaryDataDirectory.exist(String)
java.util.List<PrimaryDataEntityRmiInterface>	getAllPublishedEntities(javax.security.auth.Subject subject)	PrimaryDataDirectory.getAllPublishedEntities()
PrimaryDataEntityRmiInterface	getPrimaryDataEntity(java.lang.String name, javax.security.auth.Subject subject)	PrimaryDataDirectory.getPrimaryDataEntity(String)
java.util.List<PrimaryDataEntityRmiInterface>	listPrimaryDataEntities(javax.security.auth.Subject subject)	PrimaryDataDirectory.listPrimaryDataEntities()
java.util.List<PrimaryDataEntityRmiInterface>	searchByDublinCoreElement(EnumDublinCoreElements element, UntypedData data, boolean fuzzy, boolean recursiveIntoSubdirectories, javax.security.auth.Subject subject)	PrimaryDataDirectory.searchByDublinCoreElement(EnumDublinCoreElements, UntypedData, boolean, boolean)
java.util.List<PrimaryDataEntityRmiInterface>	searchByKeyword(java.lang.String keyword, boolean fuzzy, boolean recursiveIntoSubdirectories, javax.security.auth.Subject subject)	PrimaryDataDirectory.searchByKeyword(String, boolean, boolean)
java.util.List<PrimaryDataEntityRmiInterface>	searchByMetaData(MetaData query, boolean fuzzy, boolean recursiveIntoSubdirectories, javax.security.auth.Subject subject)	PrimaryDataDirectory.searchByMetaData(MetaData, boolean, boolean)
java.util.List<PrimaryDataEntityRmiInterface>	searchByPublicationStatus(PublicationStatus publicationStatus, javax.security.auth.Subject subject)	PrimaryDataDirectory.searchByPublicationStatus(PublicationStatus)
void	setMetaData(MetaData metadata, javax.security.auth.Subject subject)	PrimaryDataEntity.setMetaData(MetaData)

Methods inherited from interface de.ipk_gatersleben.bit.bi.edal.rmi.interfaces.PrimaryDataEntityRmiInterface

addPublicReference, delete, getCurrentVersion, getID, getMetaData, getName, getParentDirectory, getPath, getPermissions, getPublicReferences, getVersionByDate, getVersionByRevisionNumber, getVersions, grantPermission, isDirectory, move, rename, revokePermission

Method Detail

createPrimaryDataDirectory

PrimaryDataDirectoryRmiInterface createPrimaryDataDirectory(java.lang.String path,
                                                            javax.security.auth.Subject subject,
                                                            java.util.Map<java.security.Principal,java.util.List<GrantableMethods.Methods>> defaultPermissions)
                                                     throws java.rmi.RemoteException,
                                                            PrimaryDataDirectoryException

PrimaryDataDirectory.createPrimaryDataDirectory(String)

Parameters:

path - the name of the new PrimaryDataDirectory .

subject - the authenticated subject for check permission.

defaultPermissions - current default permissions.

Returns:

the new PrimaryDataDirectory object.
null if failed

Throws:

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

PrimaryDataDirectoryException - if the current PrimaryDataEntityVersion of this PrimaryDataDirectory is marked as deleted or if there is already a PrimaryDataEntity with the same name.

See Also:

PrimaryDataDirectory.createPrimaryDataDirectory(String)

createPrimaryDataFile

PrimaryDataFileRmiInterface createPrimaryDataFile(java.lang.String name,
                                                  javax.security.auth.Subject subject,
                                                  java.util.Map<java.security.Principal,java.util.List<GrantableMethods.Methods>> defaultPermissions)
                                           throws PrimaryDataDirectoryException,
                                                  java.rmi.RemoteException

PrimaryDataDirectory.createPrimaryDataFile(String)

Parameters:

name - of the new PrimaryDataFile object.

subject - the authenticated subject for check permission.

defaultPermissions - current default permissions

Returns:

the new PrimaryDataFile .
null if failed

Throws:

PrimaryDataDirectoryException - if the current PrimaryDataEntityVersion of this PrimaryDataDirectory is marked as deleted or if there is already a PrimaryDataEntity with the same name.

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

See Also:

PrimaryDataDirectory.createPrimaryDataFile(String)

exist

boolean exist(java.lang.String path,
              javax.security.auth.Subject subject)
       throws java.rmi.RemoteException,
              PrimaryDataDirectoryException

PrimaryDataDirectory.exist(String)

Parameters:

path - the name of the PrimaryDataEntity to check.

subject - the authenticated subject for check permission.

Returns:

true if there is already a PrimartyDataEntity with the same path;
false otherwise

Throws:

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

PrimaryDataDirectoryException - if unable to load all PrimaryDataEntity objects in this PrimaryDataDirectory to check if the name already exists.

See Also:

PrimaryDataDirectory.exist(String)

getAllPublishedEntities

java.util.List<PrimaryDataEntityRmiInterface> getAllPublishedEntities(javax.security.auth.Subject subject)
                                                               throws PrimaryDataDirectoryException,
                                                                      java.rmi.RemoteException

PrimaryDataDirectory.getAllPublishedEntities()

Parameters:

subject - the authenticated subject for check permission.

Returns:

a List of all PrimaryDataEntity with a PublicReference .

Throws:

PrimaryDataDirectoryException - if unable to load objcts.

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

getPrimaryDataEntity

PrimaryDataEntityRmiInterface getPrimaryDataEntity(java.lang.String name,
                                                   javax.security.auth.Subject subject)
                                            throws PrimaryDataDirectoryException,
                                                   java.rmi.RemoteException

PrimaryDataDirectory.getPrimaryDataEntity(String)

Parameters:

name - name of the PrimaryDataEntity in this PrimaryDataDirectory .

subject - the authenticated subject for check permission.

Returns:

the found PrimaryDataEntity object.

Throws:

PrimaryDataDirectoryException - if no such PrimaryDataEntity exists.

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

See Also:

PrimaryDataDirectory.getPrimaryDataEntity(String)

listPrimaryDataEntities

java.util.List<PrimaryDataEntityRmiInterface> listPrimaryDataEntities(javax.security.auth.Subject subject)
                                                               throws PrimaryDataDirectoryException,
                                                                      java.rmi.RemoteException

PrimaryDataDirectory.listPrimaryDataEntities()

Parameters:

subject - the authenticated subject for check permission.

Returns:

an unmodifiable List containing all PrimaryDataEntity

Throws:

PrimaryDataDirectoryException - if unable to load all PrimaryDataEntity objects in this PrimaryDataDirectory .

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

See Also:

PrimaryDataDirectory.listPrimaryDataEntities()

searchByDublinCoreElement

java.util.List<PrimaryDataEntityRmiInterface> searchByDublinCoreElement(EnumDublinCoreElements element,
                                                                        UntypedData data,
                                                                        boolean fuzzy,
                                                                        boolean recursiveIntoSubdirectories,
                                                                        javax.security.auth.Subject subject)
                                                                 throws java.rmi.RemoteException,
                                                                        PrimaryDataDirectoryException

PrimaryDataDirectory.searchByDublinCoreElement(EnumDublinCoreElements, UntypedData, boolean, boolean)

Parameters:

element - the EnumDublinCoreElements for query.

data - UntypedData parameter for search.

fuzzy - true: exact search;
false: fuzzy search.

recursiveIntoSubdirectories - true: include also all sub directories recursively;
false: search only in the current PrimaryDataDirectory object.

subject - the authenticated subject for check permission.

Returns:

an unmodifiable List of PrimaryDataEntity that match the parameter.

Throws:

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

PrimaryDataDirectoryException - if unable to find PrimaryDataEntity object or if there are too much results.

See Also:

PrimaryDataDirectory.searchByDublinCoreElement(EnumDublinCoreElements, UntypedData, boolean, boolean)

searchByMetaData

java.util.List<PrimaryDataEntityRmiInterface> searchByMetaData(MetaData query,
                                                               boolean fuzzy,
                                                               boolean recursiveIntoSubdirectories,
                                                               javax.security.auth.Subject subject)
                                                        throws java.rmi.RemoteException,
                                                               PrimaryDataDirectoryException,
                                                               MetaDataException

PrimaryDataDirectory.searchByMetaData(MetaData, boolean, boolean)

Parameters:

query - a MetaData object for query.

fuzzy - true: fuzzy search;
false: exact search

recursiveIntoSubdirectories - true: include also all sub PrimaryDataDirectory recursively;
false search only in the current PrimaryDataDirectory object

subject - the authenticated subject for check permission.

Returns:

a unmodifiable List of PrimaryDataEntity that match the MetaData parameter

Throws:

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

PrimaryDataDirectoryException - if unable to find PrimaryDataEntity object or if there are too much results.

MetaDataException - if there are non valid values for some MetaData elements.

See Also:

PrimaryDataDirectory.searchByMetaData(MetaData, boolean, boolean)

searchByPublicationStatus

java.util.List<PrimaryDataEntityRmiInterface> searchByPublicationStatus(PublicationStatus publicationStatus,
                                                                        javax.security.auth.Subject subject)
                                                                 throws PrimaryDataDirectoryException,
                                                                        java.rmi.RemoteException

PrimaryDataDirectory.searchByPublicationStatus(PublicationStatus)

Parameters:

subject - the authenticated subject for check permission.

publicationStatus - the PublicationStatus of the searched PrimaryDataEntity .

Returns:

a List of all PrimaryDataEntity with a PublicReference .

Throws:

PrimaryDataDirectoryException - if unable to search for PublicationStatus

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

See Also:

PrimaryDataDirectory.searchByPublicationStatus(PublicationStatus)

searchByKeyword

java.util.List<PrimaryDataEntityRmiInterface> searchByKeyword(java.lang.String keyword,
                                                              boolean fuzzy,
                                                              boolean recursiveIntoSubdirectories,
                                                              javax.security.auth.Subject subject)
                                                       throws PrimaryDataDirectoryException,
                                                              java.rmi.RemoteException

PrimaryDataDirectory.searchByKeyword(String, boolean, boolean)

Parameters:

subject - the authenticated subject for check permission.

keyword - the term to search over all elements.

fuzzy - true: fuzzy search; false: exact search

recursiveIntoSubdirectories - true: include also all sub PrimaryDataDirectory recursively; false search only in the current PrimaryDataDirectory object

Returns:

a unmodifiable List of PrimaryDataEntity that match the keyword.

Throws:

PrimaryDataDirectoryException - if unable to search for the keyword.

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

See Also:

PrimaryDataDirectory.searchByKeyword(String, boolean, boolean)

setMetaData

void setMetaData(MetaData metadata,
                 javax.security.auth.Subject subject)
          throws java.rmi.RemoteException,
                 PrimaryDataEntityVersionException,
                 MetaDataException

PrimaryDataEntity.setMetaData(MetaData)

Specified by:

setMetaData in interface PrimaryDataEntityRmiInterface

Parameters:

metadata - the new MetaData object to set.

subject - the authenticated subject for check permission.

Throws:

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

PrimaryDataEntityVersionException - if unable to store PrimaryDataEntityVersion .

MetaDataException - if there are non valid value for element in the MetaData object.

See Also:

PrimaryDataEntity.setMetaData(MetaData)