|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.security.Permission
com.ecyrd.jspwiki.auth.permissions.WikiPermission
public final class WikiPermission
Permission to perform an global wiki operation, such as self-registering
or creating new pages. Permission actions include: createGroups
,
createPages
, editPreferences
,
editProfile
and login
.
The target is a given wiki. The syntax for the target is the wiki name. "All wikis" can be specified using a wildcard (*). Page collections may also be specified using a wildcard. For pages, the wildcard may be a prefix, suffix, or all by itself.
Certain permissions imply others. Currently,
createGroups
implies createPages
.
Field Summary | |
---|---|
static WikiPermission |
CREATE_GROUPS
|
protected static int |
CREATE_GROUPS_MASK
|
static WikiPermission |
CREATE_PAGES
|
protected static int |
CREATE_PAGES_MASK
|
static WikiPermission |
EDIT_PREFERENCES
|
protected static int |
EDIT_PREFERENCES_MASK
|
static WikiPermission |
EDIT_PROFILE
|
protected static int |
EDIT_PROFILE_MASK
|
static WikiPermission |
LOGIN
|
protected static int |
LOGIN_MASK
|
Constructor Summary | |
---|---|
WikiPermission(String wiki,
String actions)
Creates a new WikiPermission for a specified set of actions. |
Method Summary | |
---|---|
protected static int |
createMask(String actions)
Private method that creates a binary mask based on the actions specified. |
boolean |
equals(Object obj)
Two WikiPermission objects are considered equal if their wikis and actions (after normalization) are equal. |
String |
getActions()
Returns the actions for this permission: "createGroups", "createPages", "editPreferences", "editProfile", or "login". |
String |
getWiki()
Returns the name of the wiki containing the page represented by this permission; may return the wildcard string. |
int |
hashCode()
Returns the hash code for this WikiPermission. |
protected static int |
impliedMask(int mask)
Creates an "implied mask" based on the actions originally assigned: for example, createGroups implies createPages . |
boolean |
implies(Permission permission)
WikiPermission can only imply other WikiPermissions; no other permission types are implied. |
PermissionCollection |
newPermissionCollection()
Returns a new AllPermissionCollection . |
String |
toString()
Prints a human-readable representation of this permission. |
Methods inherited from class java.security.Permission |
---|
checkGuard, getName |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected static final int CREATE_GROUPS_MASK
protected static final int CREATE_PAGES_MASK
protected static final int EDIT_PREFERENCES_MASK
protected static final int EDIT_PROFILE_MASK
protected static final int LOGIN_MASK
public static final WikiPermission CREATE_GROUPS
public static final WikiPermission CREATE_PAGES
public static final WikiPermission LOGIN
public static final WikiPermission EDIT_PREFERENCES
public static final WikiPermission EDIT_PROFILE
Constructor Detail |
---|
public WikiPermission(String wiki, String actions)
actions
- the actions for this permissionMethod Detail |
---|
public final boolean equals(Object obj)
equals
in class Permission
Object.equals(java.lang.Object)
public final String getActions()
getActions
in class Permission
Permission.getActions()
public final String getWiki()
public final int hashCode()
hashCode
in class Permission
Object.hashCode()
public final boolean implies(Permission permission)
implies
in class Permission
permission
- the permission which may (or may not) be implied by
this instance
true
if the permission is implied,
false
otherwisePermission.implies(java.security.Permission)
public PermissionCollection newPermissionCollection()
AllPermissionCollection
.
newPermissionCollection
in class Permission
Permission.newPermissionCollection()
,
AllPermissionCollection.getInstance(String)
public final String toString()
toString
in class Permission
Object.toString()
protected static final int impliedMask(int mask)
createGroups
implies createPages
.
mask
- the initial mask
protected static final int createMask(String actions)
implies(Permission)
.
actions
- the permission actions, separated by commas
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |