Package 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:

java.lang.Comparable<ClientPrimaryDataEntity>

Direct Known Subclasses:

ClientPrimaryDataDirectory, ClientPrimaryDataFile

public abstract class ClientPrimaryDataEntity
extends ClientContext
implements java.lang.Comparable<ClientPrimaryDataEntity>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientPrimaryDataEntityVersion	currentVersion
protected PrimaryDataEntityRmiInterface	myEntityRMI

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

clientDataManager

Constructor Summary

Constructors

Constructor	Description
ClientPrimaryDataEntity(PrimaryDataEntityRmiInterface entity, ClientDataManager client)	Constructor for ClientPrimaryDataEntity.

Method Summary

Modifier and Type	Method	Description
void	addPublicReference(PersistentIdentifier identifierType)
int	compareTo(ClientPrimaryDataEntity other)
void	delete()	PrimaryDataEntity.delete()
boolean	equals(java.lang.Object obj)
ClientPrimaryDataEntityVersion	getCurrentVersion()	PrimaryDataEntity.getCurrentVersion()
java.lang.String	getID()	PrimaryDataEntity.getID()
MetaData	getMetaData()	PrimaryDataEntity.getMetaData()
java.lang.String	getName()	PrimaryDataEntity.getName()
ClientPrimaryDataDirectory	getParentDirectory()	PrimaryDataEntity.getParentDirectory()
java.lang.String	getPath()	PrimaryDataEntity.getPath()
java.util.Map<java.security.Principal,java.util.List<GrantableMethods.Methods>>	getPermissions()	PrimaryDataEntity.getPermissions()
java.util.List<PublicReference>	getPublicReferences()	PrimaryDataEntity.getPublicReferences()
ClientPrimaryDataEntityVersion	getVersionByDate(java.util.Calendar date)	PrimaryDataEntity.getVersionByDate(Calendar)
ClientPrimaryDataEntityVersion	getVersionByRevisionNumber(long revisionNumber)	PrimaryDataEntity.getVersionByRevisionNumber(long)
java.util.SortedSet<ClientPrimaryDataEntityVersion>	getVersions()	PrimaryDataEntity.getVersions()
void	grantPermission(java.security.Principal principal, GrantableMethods.Methods method)	PrimaryDataEntity#grantPermission(Principal, Methods)}
int	hashCode()
boolean	isDirectory()	PrimaryDataEntity.isDirectory()
void	move(ClientPrimaryDataDirectory destinationDirectory)	PrimaryDataEntity.move(PrimaryDataDirectory)
void	rename(java.lang.String name)	PrimaryDataEntity.rename(String)
void	revokePermission(java.security.Principal principal, GrantableMethods.Methods method)	PrimaryDataEntity#revokePermission(Principal, Enum)
void	setMetaData(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 PrimaryDataEntityRmiInterface myEntityRMI

currentVersion

protected ClientPrimaryDataEntityVersion currentVersion

Constructor Detail

ClientPrimaryDataEntity

public ClientPrimaryDataEntity(PrimaryDataEntityRmiInterface entity,
                               ClientDataManager client)

Constructor for ClientPrimaryDataEntity.

Parameters:

entity - a PrimaryDataEntityRmiInterface object.

client - the ClientDataManager

Method Detail

addPublicReference

public void addPublicReference(PersistentIdentifier identifierType)
                        throws java.rmi.RemoteException,
                               PrimaryDataEntityException

Throws:

java.rmi.RemoteException

PrimaryDataEntityException

delete

public void delete()
            throws java.rmi.RemoteException,
                   PrimaryDataEntityVersionException,
                   PrimaryDataDirectoryException

PrimaryDataEntity.delete()

Throws:

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

PrimaryDataEntityVersionException - if trying to delete the root PrimaryDataDirectory

PrimaryDataDirectoryException - if trying to delete a non-current PrimaryDataEntityVersion.

See Also:

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

getCurrentVersion

public ClientPrimaryDataEntityVersion getCurrentVersion()
                                                 throws java.rmi.RemoteException

PrimaryDataEntity.getCurrentVersion()

Returns:

the currently set PrimaryDataEntityVersion

Throws:

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

See Also:

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

getID

public java.lang.String getID()
                       throws java.rmi.RemoteException

PrimaryDataEntity.getID()

Returns:

the ID of this PrimaryDataEntity.

Throws:

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

See Also:

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

getMetaData

public MetaData getMetaData()
                     throws java.rmi.RemoteException

PrimaryDataEntity.getMetaData()

Returns:

MetaData object of the current PrimaryDataEntityVersion of this PrimaryDataEntity.

Throws:

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

See Also:

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

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException

PrimaryDataEntity.getName()

Returns:

the name of this PrimaryDataEntity.

Throws:

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

See Also:

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

getParentDirectory

public ClientPrimaryDataDirectory getParentDirectory()
                                              throws PrimaryDataDirectoryException,
                                                     java.rmi.RemoteException

PrimaryDataEntity.getParentDirectory()

Returns:

the parent PrimaryDataDirectory of this PrimaryDataEntity.

Throws:

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

PrimaryDataDirectoryException - if trying to access the parent PrimaryDataDirectory of the root PrimaryDataDirectory.

See Also:

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

getPath

public java.lang.String getPath()
                         throws java.rmi.RemoteException

PrimaryDataEntity.getPath()

Returns:

the complete path as String to the PrimaryDataEntity object

Throws:

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

See Also:

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

getPermissions

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

PrimaryDataEntity.getPermissions()

Returns:

the map with all permissions

Throws:

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

PrimaryDataEntityException - if unable to load permissions

See Also:

PrimaryDataEntityRmiInterface.getPermissions(Subject)

getPublicReferences

public java.util.List<PublicReference> getPublicReferences()
                                                    throws java.rmi.RemoteException

PrimaryDataEntity.getPublicReferences()

Returns:

a List with all PublicReferences.

Throws:

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

See Also:

PrimaryDataEntityRmiInterface.getPublicReferences(Subject)

getVersions

public java.util.SortedSet<ClientPrimaryDataEntityVersion> getVersions()
                                                                throws java.rmi.RemoteException

PrimaryDataEntity.getVersions()

Returns:

an unmodifiable SortedSet containing all PrimaryDataEntity

Throws:

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

See Also:

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

getVersionByDate

public ClientPrimaryDataEntityVersion getVersionByDate(java.util.Calendar date)
                                                throws java.rmi.RemoteException,
                                                       PrimaryDataEntityVersionException

PrimaryDataEntity.getVersionByDate(Calendar)

Parameters:

date - the date of the PrimaryDataEntityVersion

Returns:

the specified PrimaryDataEntityVersion

Throws:

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

PrimaryDataEntityVersionException - if there are only older PrimaryDataEntityVersion stored for this PrimaryDataEntity

See Also:

PrimaryDataEntity.getVersionByDate(Calendar)

getVersionByRevisionNumber

public ClientPrimaryDataEntityVersion getVersionByRevisionNumber(long revisionNumber)
                                                          throws java.rmi.RemoteException,
                                                                 PrimaryDataEntityVersionException

PrimaryDataEntity.getVersionByRevisionNumber(long)

Parameters:

revisionNumber - the number of the PrimaryDataEntityVersion

Returns:

the specified PrimaryDataEntityVersion

Throws:

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

PrimaryDataEntityVersionException - if there is no PrimaryDataEntityVersion with this version stored.

See Also:

PrimaryDataEntity.getVersionByRevisionNumber(long)

grantPermission

public void grantPermission(java.security.Principal principal,
                            GrantableMethods.Methods method)
                     throws java.rmi.RemoteException,
                            PrimaryDataEntityException

PrimaryDataEntity#grantPermission(Principal, Methods)}

Parameters:

principal - to grant this method

method - Enum for a the method

Throws:

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

PrimaryDataEntityException - if can not found method to grant.

isDirectory

public boolean isDirectory()
                    throws java.rmi.RemoteException

PrimaryDataEntity.isDirectory()

Returns:

true when it is a PrimaryDataDirectory;
false otherwise.

Throws:

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

See Also:

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

move

public void move(ClientPrimaryDataDirectory destinationDirectory)
          throws java.rmi.RemoteException,
                 PrimaryDataDirectoryException

PrimaryDataEntity.move(PrimaryDataDirectory)

Parameters:

destinationDirectory - the new parent PrimaryDataDirectory for this PrimaryDataEntity.

Throws:

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

PrimaryDataDirectoryException - if trying to move the root PrimaryDataDirectory.

See Also:

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

rename

public void rename(java.lang.String name)
            throws java.rmi.RemoteException,
                   PrimaryDataEntityVersionException,
                   PrimaryDataDirectoryException

PrimaryDataEntity.rename(String)

Parameters:

name - the new name for this PrimaryDataEntity

Throws:

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

PrimaryDataEntityVersionException - if unable to set the new PrimaryDataEntityVersion.

PrimaryDataDirectoryException - if an PrimaryDataEntity with this name already exists.

See Also:

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

revokePermission

public void revokePermission(java.security.Principal principal,
                             GrantableMethods.Methods method)
                      throws java.rmi.RemoteException,
                             PrimaryDataEntityException

PrimaryDataEntity#revokePermission(Principal, Enum)

Parameters:

principal - to revoke this method.

method - Enum for a the method.

Throws:

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

PrimaryDataEntityException - if trying to revoke the EdalPermission for PrimaryDataEntity#grantPermission(Principal, Enum) of your own PrimaryDataEntity.

setMetaData

public void setMetaData(MetaData new_metadata)
                 throws java.rmi.RemoteException,
                        PrimaryDataEntityVersionException,
                        MetaDataException

PrimaryDataEntity.setMetaData(MetaData)

Parameters:

new_metadata - the new MetaData object to set.

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.

java.security.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 java.rmi.RemoteException,
                                 PrimaryDataEntityVersionException

PrimaryDataEntity.switchCurrentVersion(PrimaryDataEntityVersion)

Parameters:

version - the new PrimaryDataEntityVersion to set as current PrimaryDataEntityVersion.

Throws:

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

PrimaryDataEntityVersionException - if requested PrimaryDataEntityVersion is not available or marked as deleted.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(ClientPrimaryDataEntity other)

Specified by:

compareTo in interface java.lang.Comparable<ClientPrimaryDataEntity>