de.ipk_gatersleben.bit.bi.edal.rmi.client

Class ClientPrimaryDataEntity

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.rmi.client.ClientContext

de.ipk_gatersleben.bit.bi.edal.rmi.client.ClientPrimaryDataEntity

All Implemented Interfaces:

Comparable<ClientPrimaryDataEntity>

Direct Known Subclasses:

ClientPrimaryDataDirectory, ClientPrimaryDataFile

public abstract class ClientPrimaryDataEntity
extends ClientContext
implements Comparable<ClientPrimaryDataEntity>

SampleClient version of PrimaryDataEntity to use eDAL system like the stand-alone implementation.

Author:

arendd

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientPrimaryDataEntityVersion	currentVersion
protected de.ipk_gatersleben.bit.bi.edal.rmi.interfaces.PrimaryDataEntityRmiInterface	myEntityRMI

Fields inherited from class de.ipk_gatersleben.bit.bi.edal.rmi.client.ClientContext

clientDataManager

Constructor Summary

Constructors

Constructor and Description
ClientPrimaryDataEntity(de.ipk_gatersleben.bit.bi.edal.rmi.interfaces.PrimaryDataEntityRmiInterface entity, ClientDataManager client) Constructor for ClientPrimaryDataEntity.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPublicReference(de.ipk_gatersleben.bit.bi.edal.primary_data.reference.PersistentIdentifier identifierType)
int	compareTo(ClientPrimaryDataEntity other)
void	delete() PrimaryDataEntity.delete()
boolean	equals(Object obj)
ClientPrimaryDataEntityVersion	getCurrentVersion() PrimaryDataEntity.getCurrentVersion()
String	getID() PrimaryDataEntity.getID()
de.ipk_gatersleben.bit.bi.edal.primary_data.metadata.MetaData	getMetaData() PrimaryDataEntity.getMetaData()
String	getName() PrimaryDataEntity.getName()
ClientPrimaryDataDirectory	getParentDirectory() PrimaryDataEntity.getParentDirectory()
String	getPath() PrimaryDataEntity.getPath()
Map<Principal,List<de.ipk_gatersleben.bit.bi.edal.aspectj.security.GrantableMethods.Methods>>	getPermissions() PrimaryDataEntity.getPermissions()
List<de.ipk_gatersleben.bit.bi.edal.primary_data.file.PublicReference>	getPublicReferences() PrimaryDataEntity.getPublicReferences()
ClientPrimaryDataEntityVersion	getVersionByDate(Calendar date) PrimaryDataEntity.getVersionByDate(Calendar)
ClientPrimaryDataEntityVersion	getVersionByRevisionNumber(long revisionNumber) PrimaryDataEntity.getVersionByRevisionNumber(long)
SortedSet<ClientPrimaryDataEntityVersion>	getVersions() PrimaryDataEntity.getVersions()
void	grantPermission(Principal principal, de.ipk_gatersleben.bit.bi.edal.aspectj.security.GrantableMethods.Methods method) PrimaryDataEntity#grantPermission(Principal, Enum)
int	hashCode()
boolean	isDirectory() PrimaryDataEntity.isDirectory()
void	move(ClientPrimaryDataDirectory destinationDirectory) PrimaryDataEntity.move(PrimaryDataDirectory)
void	rename(String name) PrimaryDataEntity.rename(String)
void	revokePermission(Principal principal, de.ipk_gatersleben.bit.bi.edal.aspectj.security.GrantableMethods.Methods method) PrimaryDataEntity#revokePermission(Principal, Enum)
void	setMetaData(de.ipk_gatersleben.bit.bi.edal.primary_data.metadata.MetaData new_metadata) PrimaryDataEntity.setMetaData(MetaData)
void	switchCurrentVersion(ClientPrimaryDataEntityVersion version) PrimaryDataEntity.switchCurrentVersion(PrimaryDataEntityVersion)

Methods inherited from class java.lang.Object

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

Field Detail

myEntityRMI

protected de.ipk_gatersleben.bit.bi.edal.rmi.interfaces.PrimaryDataEntityRmiInterface myEntityRMI

currentVersion

protected ClientPrimaryDataEntityVersion currentVersion

Constructor Detail

ClientPrimaryDataEntity

public ClientPrimaryDataEntity(de.ipk_gatersleben.bit.bi.edal.rmi.interfaces.PrimaryDataEntityRmiInterface entity,
                       ClientDataManager client)

Constructor for ClientPrimaryDataEntity.

Parameters:

entity - a PrimaryDataEntityRmiInterface object.

Method Detail

addPublicReference

public void addPublicReference(de.ipk_gatersleben.bit.bi.edal.primary_data.reference.PersistentIdentifier identifierType)
                        throws RemoteException,
                               de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityException

Throws:

RemoteException

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityException

delete

public void delete()
            throws RemoteException,
                   de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException,
                   de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectoryException

PrimaryDataEntity.delete()

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException - if trying to delete the root PrimaryDataDirectory

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectoryException - if trying to delete a non-current PrimaryDataEntityVersion.

See Also:

PrimaryDataEntityRmiInterface.delete(javax.security.auth.Subject)

getCurrentVersion

public ClientPrimaryDataEntityVersion getCurrentVersion()
                                                 throws RemoteException

PrimaryDataEntity.getCurrentVersion()

Returns:

the currently set PrimaryDataEntityVersion

Throws:

RemoteException - if unable to call remote function.

See Also:

PrimaryDataEntityRmiInterface.getCurrentVersion(javax.security.auth.Subject)

getID

public String getID()
             throws RemoteException

PrimaryDataEntity.getID()

Returns:

the ID of this PrimaryDataEntity.

Throws:

RemoteException - if unable to call remote function.

See Also:

PrimaryDataEntityRmiInterface.getID(javax.security.auth.Subject)

getMetaData

public de.ipk_gatersleben.bit.bi.edal.primary_data.metadata.MetaData getMetaData()
                                                                          throws RemoteException

PrimaryDataEntity.getMetaData()

Returns:

MetaData object of the current PrimaryDataEntityVersion of this PrimaryDataEntity.

Throws:

RemoteException - if unable to call remote function.

See Also:

PrimaryDataEntityRmiInterface.getMetaData(javax.security.auth.Subject)

getName

public String getName()
               throws RemoteException

PrimaryDataEntity.getName()

Returns:

the name of this PrimaryDataEntity.

Throws:

RemoteException - if unable to call remote function.

See Also:

PrimaryDataEntityRmiInterface.getName(javax.security.auth.Subject)

getParentDirectory

public ClientPrimaryDataDirectory getParentDirectory()
                                              throws de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectoryException,
                                                     RemoteException

PrimaryDataEntity.getParentDirectory()

Returns:

the parent PrimaryDataDirectory of this PrimaryDataEntity.

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectoryException - if trying to access the parent PrimaryDataDirectory of the root PrimaryDataDirectory.

See Also:

PrimaryDataEntityRmiInterface.getParentDirectory(javax.security.auth.Subject)

getPath

public String getPath()
               throws RemoteException

PrimaryDataEntity.getPath()

Returns:

the complete path as String to the PrimaryDataEntity object

Throws:

RemoteException - if unable to call remote function.

See Also:

PrimaryDataEntityRmiInterface.getPath(javax.security.auth.Subject)

getPermissions

public Map<Principal,List<de.ipk_gatersleben.bit.bi.edal.aspectj.security.GrantableMethods.Methods>> getPermissions()
                                                                                                             throws RemoteException,
                                                                                                                    de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityException

PrimaryDataEntity.getPermissions()

Returns:

the map with all permissions

Throws:

RemoteException

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityException

See Also:

PrimaryDataEntityRmiInterface.getPermissions(Subject)

getPublicReferences

public List<de.ipk_gatersleben.bit.bi.edal.primary_data.file.PublicReference> getPublicReferences()
                                                                                           throws RemoteException

PrimaryDataEntity.getPublicReferences()

Returns:

a List with all PublicReferences.

Throws:

RemoteException - if unable to call remote function.

See Also:

PrimaryDataEntityRmiInterface.getPublicReferences(Subject)

getVersions

public SortedSet<ClientPrimaryDataEntityVersion> getVersions()
                                                      throws RemoteException

PrimaryDataEntity.getVersions()

Returns:

an unmodifiable SortedSet containing all PrimaryDataEntity

Throws:

RemoteException - if unable to call remote function.

See Also:

PrimaryDataEntityRmiInterface.getVersions(javax.security.auth.Subject)

getVersionByDate

public ClientPrimaryDataEntityVersion getVersionByDate(Calendar date)
                                                throws RemoteException,
                                                       de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException

PrimaryDataEntity.getVersionByDate(Calendar)

Parameters:

date - the date of the PrimaryDataEntityVersion

Returns:

the specified PrimaryDataEntityVersion

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException - if there are only older PrimaryDataEntityVersion stored for this PrimaryDataEntity

See Also:

PrimaryDataEntity.getVersionByDate(Calendar)

getVersionByRevisionNumber

public ClientPrimaryDataEntityVersion getVersionByRevisionNumber(long revisionNumber)
                                                          throws RemoteException,
                                                                 de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException

PrimaryDataEntity.getVersionByRevisionNumber(long)

Parameters:

revisionNumber - the number of the PrimaryDataEntityVersion

Returns:

the specified PrimaryDataEntityVersion

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException - if there is no PrimaryDataEntityVersion with this version stored.

See Also:

PrimaryDataEntity.getVersionByRevisionNumber(long)

grantPermission

public void grantPermission(Principal principal,
                   de.ipk_gatersleben.bit.bi.edal.aspectj.security.GrantableMethods.Methods method)
                     throws RemoteException,
                            de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityException

PrimaryDataEntity#grantPermission(Principal, Enum)

Parameters:

principal - to grant this method

method - Enum for a the method

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityException - if can not found method to grant.

isDirectory

public boolean isDirectory()
                    throws RemoteException

PrimaryDataEntity.isDirectory()

Returns:

true when it is a PrimaryDataDirectory;
false otherwise.

Throws:

RemoteException - if unable to call remote function.

See Also:

PrimaryDataEntityRmiInterface.isDirectory(javax.security.auth.Subject)

move

public void move(ClientPrimaryDataDirectory destinationDirectory)
          throws RemoteException,
                 de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectoryException

PrimaryDataEntity.move(PrimaryDataDirectory)

Parameters:

destinationDirectory - the new parent PrimaryDataDirectory for this PrimaryDataEntity.

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectoryException - if trying to move the root PrimaryDataDirectory.

See Also:

PrimaryDataEntityRmiInterface.move(PrimaryDataDirectoryRmiInterface, javax.security.auth.Subject)

rename

public void rename(String name)
            throws RemoteException,
                   de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException,
                   de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectoryException

PrimaryDataEntity.rename(String)

Parameters:

name - the new name for this PrimaryDataEntity

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException - if unable to set the new PrimaryDataEntityVersion.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectoryException - if an PrimaryDataEntity with this name already exists.

See Also:

PrimaryDataEntityRmiInterface.rename(java.lang.String, javax.security.auth.Subject)

revokePermission

public void revokePermission(Principal principal,
                    de.ipk_gatersleben.bit.bi.edal.aspectj.security.GrantableMethods.Methods method)
                      throws RemoteException,
                             de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityException

PrimaryDataEntity#revokePermission(Principal, Enum)

Parameters:

principal - to revoke this method.

method - Enum for a the method.

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityException - if trying to revoke the EdalPermission for PrimaryDataEntity#grantPermission(Principal, Enum) of your own PrimaryDataEntity.

setMetaData

public void setMetaData(de.ipk_gatersleben.bit.bi.edal.primary_data.metadata.MetaData new_metadata)
                 throws RemoteException,
                        de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException,
                        de.ipk_gatersleben.bit.bi.edal.primary_data.metadata.MetaDataException

PrimaryDataEntity.setMetaData(MetaData)

Parameters:

new_metadata - the new MetaData object to set.

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException - if unable to store PrimaryDataEntityVersion.

de.ipk_gatersleben.bit.bi.edal.primary_data.metadata.MetaDataException - if there are non valid value for element in the MetaData object.

AccessControlException - if the user with the current Subject is not allowed to execute this method. The AccessControlException is thrown by AspectJ.

See Also:

PrimaryDataEntityRmiInterface.setMetaData(MetaData, Subject)

switchCurrentVersion

public void switchCurrentVersion(ClientPrimaryDataEntityVersion version)
                          throws RemoteException,
                                 de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException

PrimaryDataEntity.switchCurrentVersion(PrimaryDataEntityVersion)

Parameters:

version - the new PrimaryDataEntityVersion to set as current PrimaryDataEntityVersion.

Throws:

RemoteException - if unable to call remote function.

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntityVersionException - if requested PrimaryDataEntityVersion is not available or marked as deleted.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ClientPrimaryDataEntity other)

Specified by:

compareTo in interface Comparable<ClientPrimaryDataEntity>