com.atlassian.jira.security
Class DefaultGlobalPermissionManager

java.lang.Object
  extended by com.atlassian.jira.security.DefaultGlobalPermissionManager
All Implemented Interfaces:
Startable, GlobalPermissionManager

public class DefaultGlobalPermissionManager
extends java.lang.Object
implements GlobalPermissionManager, Startable


Constructor Summary
DefaultGlobalPermissionManager(com.atlassian.event.api.EventPublisher eventPublisher)
           
 
Method Summary
 boolean addPermission(int permissionId, java.lang.String group)
          Adds a global permission
 java.util.Collection<java.lang.String> getGroupNames(int permissionId)
          Retrieve all the group names with this permission.
 java.util.Collection<com.opensymphony.user.Group> getGroups(int permissionId)
          Retrieve all the groups with this permission
 java.util.Collection<JiraPermission> getPermissions(int permissionType)
          Retrieve all the global permissions of a particular type
 boolean hasPermission(int permissionId)
          Check if a global anonymous permission exists
 boolean hasPermission(int permissionId, com.opensymphony.user.User u)
          Check if a global permission for one of the users groups exists
protected  boolean hasPermission(JiraPermission jiraPermission)
           
 void onClearCache(ClearCacheEvent event)
           
 boolean removePermission(int permissionId, java.lang.String group)
          Removes a global permission
 boolean removePermissions(java.lang.String group)
          Remove a global permissions that the group passed in
 void start()
          This method wil be called after the plugin system is fully initialised and all components added to the dependency injection framework.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultGlobalPermissionManager

public DefaultGlobalPermissionManager(com.atlassian.event.api.EventPublisher eventPublisher)
Method Detail

start

public void start()
           throws java.lang.Exception
Description copied from interface: Startable
This method wil be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Specified by:
start in interface Startable
Throws:
java.lang.Exception - Allows implementations to throw an Exception.

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

addPermission

public boolean addPermission(int permissionId,
                             java.lang.String group)
                      throws CreateException
Adds a global permission

Specified by:
addPermission in interface GlobalPermissionManager
Parameters:
permissionId - must be a global permission type
group - can be null if it is anyone permission
Returns:
True if the permission was added
Throws:
CreateException

getPermissions

public java.util.Collection<JiraPermission> getPermissions(int permissionType)
Description copied from interface: GlobalPermissionManager
Retrieve all the global permissions of a particular type

Specified by:
getPermissions in interface GlobalPermissionManager
Parameters:
permissionType - must be a global permission
Returns:
Collection of JiraPermission, must never return null

removePermission

public boolean removePermission(int permissionId,
                                java.lang.String group)
                         throws RemoveException
Removes a global permission

Specified by:
removePermission in interface GlobalPermissionManager
Parameters:
permissionId - must be a global permission type
group - can be null if it is anyone permission
Returns:
True if the permission was removed, false if not (usually it didn't exist)
Throws:
RemoveException

removePermissions

public boolean removePermissions(java.lang.String group)
                          throws RemoveException
Remove a global permissions that the group passed in

Specified by:
removePermissions in interface GlobalPermissionManager
Parameters:
group - must NOT be null and the group must exist
Returns:
True all the permissions are removed
Throws:
RemoveException - if the permission removal fails

hasPermission

public boolean hasPermission(int permissionId)
Check if a global anonymous permission exists

Specified by:
hasPermission in interface GlobalPermissionManager
Parameters:
permissionId - must be global permission
Returns:
true the anonymous user has the permission of given type, false otherwise
See Also:
GlobalPermissionManager.hasPermission(int, com.opensymphony.user.User)

hasPermission

public boolean hasPermission(int permissionId,
                             com.opensymphony.user.User u)
Check if a global permission for one of the users groups exists

Specified by:
hasPermission in interface GlobalPermissionManager
Parameters:
permissionId - must be a global permission
u - must not be null
Returns:
true if the given user has the permission of given type, otherwise false
See Also:
GlobalPermissionManager.hasPermission(int), PermissionManager.hasPermission(int, com.opensymphony.user.User)

getGroups

public java.util.Collection<com.opensymphony.user.Group> getGroups(int permissionId)
Retrieve all the groups with this permission

Specified by:
getGroups in interface GlobalPermissionManager
Parameters:
permissionId - must be a global permission
Returns:
a collection of Group objects, never null

getGroupNames

public java.util.Collection<java.lang.String> getGroupNames(int permissionId)
Description copied from interface: GlobalPermissionManager
Retrieve all the group names with this permission. Only group names directly associated with the permission will be returned.

Specified by:
getGroupNames in interface GlobalPermissionManager
Parameters:
permissionId - must be a global permission
Returns:
a Collection of String, group names, will never be null.

hasPermission

protected boolean hasPermission(JiraPermission jiraPermission)


Copyright © 2002-2010 Atlassian. All Rights Reserved.