|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.base.database.DbPermissionsManager
public class DbPermissionsManager
Database implementation of the PermissionsManager interface. This implementation differs from the interface in that calls to the actual interface methods will throw UnsupportedOperationException. Instead, all calls to this class should use the corresponding methods with "int objectType, long objectID" prepended to the method's parameter list.
Nested Class Summary | |
---|---|
static class |
DbPermissionsManager.PermissionsBundle
Stores the full set of permissions for a permissions context (an objectType and an objectID). |
Field Summary | |
---|---|
static Cache |
userPermsCache
|
Method Summary | |
---|---|
void |
addAnonymousUserPermission(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
void |
addAnonymousUserPermission(PermissionType permissionType,
long permission)
Add a permission of the specified PermissionType for anonymous users. |
void |
addGroupPermission(Group group,
PermissionType permissionType,
long permission)
Grants a group a particular permission. |
void |
addGroupPermission(int objectType,
long objectID,
Group group,
PermissionType permissionType,
long permission)
|
void |
addRegisteredUserPermission(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
void |
addRegisteredUserPermission(PermissionType permissionType,
long permission)
Add a permission of the specified PermissionType for registered users. |
void |
addUserPermission(int objectType,
long objectID,
User user,
PermissionType permissionType,
long permission)
|
void |
addUserPermission(User user,
PermissionType permissionType,
long permission)
Add a permission of the specified PermissionType for the specified user. |
boolean |
anonymousUserHasPermission(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
boolean |
anonymousUserHasPermission(PermissionType permissionType,
long permission)
Returns true if the anonymous users have a particular permission. |
void |
destroy()
Notifies the manager to release any resources that may be holding on too. |
Permissions |
getFinalUserPerms(int objectType,
long objectID,
long userID,
PermissionType permissionType)
Returns the Permissions object that corresponds to the combined permissions that a user has for a particular object: Anonymous and "registered users" permissions. |
static DbPermissionsManager |
getInstance()
|
java.util.Iterator |
groupsWithPermission(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
java.util.Iterator |
groupsWithPermission(PermissionType permissionType,
long permission)
Returns an Iterator of groups with a particular permission. |
int |
groupsWithPermissionCount(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
int |
groupsWithPermissionCount(PermissionType permissionType,
long permission)
Returns a count of the groups that have a particular permission. |
boolean |
hasPermissionsSet(int objectType,
long objectID)
|
void |
initialize()
Initialize the manager. |
void |
permissionModificationDetected()
Is called when a permission is modified. |
void |
permissionModificationDetected(int objectType,
long objectID)
Sends event to the dispatcher. |
boolean |
registeredUserHasPermission(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
boolean |
registeredUserHasPermission(PermissionType permissionType,
long permission)
Returns true if registered users have a particular permission. |
void |
removeAllGroupPermissions(int objectType,
long objectID,
PermissionType permissionType)
|
void |
removeAllGroupPermissions(PermissionType permissionType)
Revokes all group permissions. |
void |
removeAllPermissions(java.sql.Connection con,
int objectType,
long objectID)
|
void |
removeAllPermissions(int objectType,
long objectID)
|
void |
removeAllUserPermissions(int objectType,
long objectID,
PermissionType permissionType)
|
void |
removeAllUserPermissions(PermissionType permissionType)
Removes all user permissions. |
void |
removeAnonymousUserPermission(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
void |
removeAnonymousUserPermission(PermissionType permissionType,
long permission)
Removes a permission of the specified PermissionType for anonymous users. |
void |
removeGroupPermission(Group group,
PermissionType permissionType,
long permission)
Removes a permission of the specified PermissionType for a group. |
void |
removeGroupPermission(int objectType,
long objectID,
Group group,
PermissionType permissionType,
long permission)
|
void |
removeRegisteredUserPermission(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
void |
removeRegisteredUserPermission(PermissionType permissionType,
long permission)
Removes a permission of the specified PermissionType for registered users. |
void |
removeUserPermission(int objectType,
long objectID,
User user,
PermissionType permissionType,
long permission)
|
void |
removeUserPermission(User user,
PermissionType permissionType,
long permission)
Removes a permission of the specified PermissionType for the specified user. |
static int |
toDbFormat(long permission)
Converts a normal permissions value into the db format. |
java.util.Iterator |
usersWithPermission(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
java.util.Iterator |
usersWithPermission(PermissionType permissionType,
long permission)
Returns all the userID's of users with a particular permission. |
int |
usersWithPermissionCount(int objectType,
long objectID,
PermissionType permissionType,
long permission)
|
int |
usersWithPermissionCount(PermissionType permissionType,
long permission)
Returns a count of the users that have a particular permission. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static Cache userPermsCache
Method Detail |
---|
public static DbPermissionsManager getInstance()
public void initialize()
JiveManager
This method is used internally by Jive during application startup and should not be called during normal usage of the class.
initialize
in interface JiveManager
public void destroy()
JiveManager
destroy
in interface JiveManager
public void addUserPermission(User user, PermissionType permissionType, long permission)
PermissionsManager
addUserPermission
in interface PermissionsManager
user
- the User to add a permission to.permissionType
- the type of permission to add.permission
- the permission to add.public void addAnonymousUserPermission(PermissionType permissionType, long permission)
PermissionsManager
addAnonymousUserPermission
in interface PermissionsManager
permissionType
- the type of permission to add.permission
- the permission to add.public void addRegisteredUserPermission(PermissionType permissionType, long permission)
PermissionsManager
addRegisteredUserPermission
in interface PermissionsManager
permissionType
- the type of permission to add.permission
- the permission to add.public void removeUserPermission(User user, PermissionType permissionType, long permission)
PermissionsManager
removeUserPermission
in interface PermissionsManager
user
- the User to remove a permission from.permissionType
- the type of permission to remove.public void removeAnonymousUserPermission(PermissionType permissionType, long permission)
PermissionsManager
removeAnonymousUserPermission
in interface PermissionsManager
permissionType
- the type of permission to remove.public void removeRegisteredUserPermission(PermissionType permissionType, long permission)
PermissionsManager
removeRegisteredUserPermission
in interface PermissionsManager
permissionType
- the type of permission to remove.public void removeAllUserPermissions(PermissionType permissionType)
PermissionsManager
removeAllUserPermissions
in interface PermissionsManager
permissionType
- the type of permissions to remove.public boolean anonymousUserHasPermission(PermissionType permissionType, long permission)
PermissionsManager
anonymousUserHasPermission
in interface PermissionsManager
permissionType
- the type of permission to check.permission
- the permission to check.
public boolean registeredUserHasPermission(PermissionType permissionType, long permission)
PermissionsManager
registeredUserHasPermission
in interface PermissionsManager
permissionType
- the type of permission to check.permission
- the permission to check.
public java.util.Iterator usersWithPermission(PermissionType permissionType, long permission)
PermissionsManager
usersWithPermission
in interface PermissionsManager
permissionType
- the type of permission to check.permission
- the permission to check.
public int usersWithPermissionCount(PermissionType permissionType, long permission)
PermissionsManager
usersWithPermissionCount
in interface PermissionsManager
permissionType
- the type of permission to check.permission
- the permission to check.
public void addGroupPermission(Group group, PermissionType permissionType, long permission)
PermissionsManager
addGroupPermission
in interface PermissionsManager
group
- the group to grant a permission to.permissionType
- the type of permission to add.permission
- the permission to grant the group.public void removeGroupPermission(Group group, PermissionType permissionType, long permission)
PermissionsManager
removeGroupPermission
in interface PermissionsManager
group
- the group to remove the permission from.permissionType
- the type of permission to remove.permission
- the permission to remove.public void removeAllGroupPermissions(PermissionType permissionType)
PermissionsManager
removeAllGroupPermissions
in interface PermissionsManager
permissionType
- the type of permissions to remove.public java.util.Iterator groupsWithPermission(PermissionType permissionType, long permission)
PermissionsManager
groupsWithPermission
in interface PermissionsManager
permissionType
- the type of permission to check.permission
- the permission to check.
public int groupsWithPermissionCount(PermissionType permissionType, long permission)
PermissionsManager
groupsWithPermissionCount
in interface PermissionsManager
permissionType
- the type of permission to check.permission
- the permission to check.
public void permissionModificationDetected()
PermissionsManager
permissionModificationDetected
in interface PermissionsManager
public void addUserPermission(int objectType, long objectID, User user, PermissionType permissionType, long permission)
public void addAnonymousUserPermission(int objectType, long objectID, PermissionType permissionType, long permission)
public void addRegisteredUserPermission(int objectType, long objectID, PermissionType permissionType, long permission)
public void removeUserPermission(int objectType, long objectID, User user, PermissionType permissionType, long permission)
public void removeAnonymousUserPermission(int objectType, long objectID, PermissionType permissionType, long permission)
public void removeRegisteredUserPermission(int objectType, long objectID, PermissionType permissionType, long permission)
public void removeAllUserPermissions(int objectType, long objectID, PermissionType permissionType)
public void removeAllPermissions(int objectType, long objectID)
public void removeAllPermissions(java.sql.Connection con, int objectType, long objectID) throws java.sql.SQLException
java.sql.SQLException
public boolean anonymousUserHasPermission(int objectType, long objectID, PermissionType permissionType, long permission)
public boolean registeredUserHasPermission(int objectType, long objectID, PermissionType permissionType, long permission)
public java.util.Iterator usersWithPermission(int objectType, long objectID, PermissionType permissionType, long permission)
public int usersWithPermissionCount(int objectType, long objectID, PermissionType permissionType, long permission)
public void addGroupPermission(int objectType, long objectID, Group group, PermissionType permissionType, long permission)
public void removeGroupPermission(int objectType, long objectID, Group group, PermissionType permissionType, long permission)
public void removeAllGroupPermissions(int objectType, long objectID, PermissionType permissionType)
public java.util.Iterator groupsWithPermission(int objectType, long objectID, PermissionType permissionType, long permission)
public int groupsWithPermissionCount(int objectType, long objectID, PermissionType permissionType, long permission)
public boolean hasPermissionsSet(int objectType, long objectID)
public Permissions getFinalUserPerms(int objectType, long objectID, long userID, PermissionType permissionType)
public static int toDbFormat(long permission)
permission
- the normal permissions value.
public void permissionModificationDetected(int objectType, long objectID)
objectType
- objectID
-
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |