org.proteios.core
Class ProjectKey

java.lang.Object
  org.proteios.core.BasicItem<D>
      org.proteios.core.Key<ProjectKeyData>
          org.proteios.core.ProjectKey

All Implemented Interfaces:

AccessControlled, Identifiable

public class ProjectKey
extends Key<ProjectKeyData>

This class is used to get information about which projects a Shareable item has been shared to.

A project key is immutable and the project/permission combinations cannot be changed once the key has been created. This allows the core to resuse project keys for all items with the same combination of project/permission values without fear that someone else may change the permissions.

Project keys can be used with Shareable items to share them with projects. If the logged in user has set an active project (see SessionControl.setActiveProject(Project)) new items will automatically be shared to that project.

To create a new project key use the ProjectPermissions object and pass the information to the getNewOrExisting(DbControl, ProjectPermissions) method.

Another option is to use the MultiPermissions object which allows you to modifiy the sharing information of a whole bunch of shareable items in one go. The MultiPermissions class takes care of all the cumbersome work of creating new keys and assigning those to the items for you.

Version:

2.0

Author:

Nicklas

See Also:

Shareable, SessionControl.setActiveProject(Project)

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Field Summary

static Item

TYPE The type of item represented by this class.

Method Summary

static void	deleteUnusedKeys() Delete all keys that are currently not used by any item.
static ProjectKey	getById(DbControl dc, int id) Get a ProjectKey item when you know the ID.
static ProjectKey	getNewOrExisting(DbControl dc, ProjectPermissions projectPermissions) Create a new or load an existing ProjectKey when you have a combination of project/permission values.
Set<Permission>	getPermissions(Project project) Get the permissions for a project.
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Checks if: A Shareable item is using this key.

Methods inherited from class org.proteios.core.BasicItem

checkPermission, equals, getDbControl, getId, getPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final Item TYPE

The type of item represented by this class.

See Also:

Item.PROJECTKEY, getType()

Method Detail

getNewOrExisting

public static ProjectKey getNewOrExisting(DbControl dc,
                                          ProjectPermissions projectPermissions)
                                   throws BaseException

Create a new or load an existing ProjectKey when you have a combination of project/permission values. If the database contains a project key with the same combination that project key is loaded and returned, otherwise a new project key is created. If no existing key is found, the new key will immediately be saved and committed to the database using another transaction. This ensures that no two keys contains identical permissions.

Parameters:

dc - The DbControl which will be used for permission checking and database access

projectPermissions - A ProjectPermissions object holding the permissions

Returns:

The ProjectKey item

Throws:

BaseException - If there is an error

getById

public static ProjectKey getById(DbControl dc,
                                 int id)
                          throws ItemNotFoundException,
                                 PermissionDeniedException,
                                 BaseException

Get a ProjectKey item when you know the ID.

Parameters:

dc - The DbControl which will be used for permission checking and database access.

id - The ID of the item to load

Returns:

The ProjectKey item

Throws:

ItemNotFoundException - If an item with the specified ID is not found

PermissionDeniedException - If the logged in user doesn't have Permission.READ permission to the item

BaseException - If there is another error

deleteUnusedKeys

public static void deleteUnusedKeys()
                             throws BaseException

Delete all keys that are currently not used by any item. This method is intended to be executed at regular intervals by a cleanup application.

Throws:

BaseException

getType

public Item getType()

Description copied from interface: Identifiable

Get the type of item represented by the object. The returned value is one of the values defined in the Item enumeration.

Returns:

A value indicating the type of item

isUsed

public boolean isUsed()
               throws BaseException

Checks if:

• A Shareable item is using this key.

Specified by:

isUsed in class BasicItem<ProjectKeyData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getPermissions

public Set<Permission> getPermissions(Project project)
                               throws InvalidDataException

Get the permissions for a project.

Parameters:

project - The Project for which we want to get the permission

Returns:

A Set containing the granted permissions, or an empty set if no permissions have been granted

Throws:

InvalidDataException - If the project is null

See Also:

Permission