Package de.ipk_gatersleben.bit.bi.edal.rmi.server.wrapper

Class PrimaryDataDirectoryWrapper

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

de.ipk_gatersleben.bit.bi.edal.rmi.server.wrapper.PrimaryDataEntityWrapper

de.ipk_gatersleben.bit.bi.edal.rmi.server.wrapper.PrimaryDataDirectoryWrapper

All Implemented Interfaces:

PrimaryDataDirectoryRmiInterface, PrimaryDataEntityRmiInterface, java.io.Serializable, java.rmi.Remote

public class PrimaryDataDirectoryWrapper
extends PrimaryDataEntityWrapper
implements PrimaryDataDirectoryRmiInterface

Wrapper class to wrap PrimaryDataDirectory functions on server side.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.ipk_gatersleben.bit.bi.edal.rmi.server.wrapper.PrimaryDataEntityWrapper

myDataPort, myEntity

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor	Description
PrimaryDataDirectoryWrapper(int dataPort, PrimaryDataDirectory directory)	Constructor for PrimaryDataDirectoryWrapper.

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<PublicReference>	getPublicReferences(javax.security.auth.Subject subject)	PrimaryDataEntity.getPublicReferences() .
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 class de.ipk_gatersleben.bit.bi.edal.rmi.server.wrapper.PrimaryDataEntityWrapper

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

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Constructor Detail

PrimaryDataDirectoryWrapper

public PrimaryDataDirectoryWrapper(int dataPort,
                                   PrimaryDataDirectory directory)
                            throws java.rmi.RemoteException

Constructor for PrimaryDataDirectoryWrapper.

Parameters:

dataPort - the data port for the remote objects.

directory - a PrimaryDataDirectory object.

Throws:

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

Method Detail

createPrimaryDataDirectory

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

PrimaryDataDirectory.createPrimaryDataDirectory(String)

Specified by:

createPrimaryDataDirectory in interface PrimaryDataDirectoryRmiInterface

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:

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.createPrimaryDataDirectory(String)

createPrimaryDataFile

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

Specified by:

createPrimaryDataFile in interface PrimaryDataDirectoryRmiInterface

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

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

PrimaryDataDirectory.exist(String)

Specified by:

exist in interface PrimaryDataDirectoryRmiInterface

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)

listPrimaryDataEntities

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

PrimaryDataDirectory.listPrimaryDataEntities()

Specified by:

listPrimaryDataEntities in interface PrimaryDataDirectoryRmiInterface

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()

setMetaData

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

PrimaryDataEntity.setMetaData(MetaData)

Specified by:

setMetaData in interface PrimaryDataDirectoryRmiInterface

Specified by:

setMetaData in interface PrimaryDataEntityRmiInterface

Overrides:

setMetaData in class PrimaryDataEntityWrapper

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)

searchByDublinCoreElement

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

Specified by:

searchByDublinCoreElement in interface PrimaryDataDirectoryRmiInterface

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

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

Specified by:

searchByMetaData in interface PrimaryDataDirectoryRmiInterface

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)

getPrimaryDataEntity

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

PrimaryDataDirectory.getPrimaryDataEntity(String)

Specified by:

getPrimaryDataEntity in interface PrimaryDataDirectoryRmiInterface

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)

getPublicReferences

public java.util.List<PublicReference> getPublicReferences(javax.security.auth.Subject subject)
                                                    throws java.rmi.RemoteException

PrimaryDataEntity.getPublicReferences() .

Specified by:

getPublicReferences in interface PrimaryDataEntityRmiInterface

Parameters:

subject - the authenticated subject for check permission.

Returns:

a List with all stored PublicReferences of the current PrimaryDataEntityVersion of this PrimaryDataEntity .

Throws:

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

searchByPublicationStatus

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

PrimaryDataDirectory.searchByPublicationStatus(PublicationStatus)

Specified by:

searchByPublicationStatus in interface PrimaryDataDirectoryRmiInterface

Parameters:

publicationStatus - the PublicationStatus of the searched PrimaryDataEntity .

subject - the authenticated subject for check permission.

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)

getAllPublishedEntities

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

PrimaryDataDirectory.getAllPublishedEntities()

Specified by:

getAllPublishedEntities in interface PrimaryDataDirectoryRmiInterface

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.

searchByKeyword

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

Specified by:

searchByKeyword in interface PrimaryDataDirectoryRmiInterface

Parameters:

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

subject - the authenticated subject for check permission.

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)