Index (XWiki Platform - Security

A B C D E F G H I K L M N O P R S T U V W

A

AccessDeniedException - Exception in org.xwiki.security.authorization: Exception raised by the AuthorizationManager when denying access.
AccessDeniedException(DocumentReference, EntityReference) - Constructor for exception org.xwiki.security.authorization.AccessDeniedException
AccessDeniedException(Right, DocumentReference, EntityReference) - Constructor for exception org.xwiki.security.authorization.AccessDeniedException
AccessDeniedException(DocumentReference, EntityReference, Throwable) - Constructor for exception org.xwiki.security.authorization.AccessDeniedException
AccessDeniedException(Right, DocumentReference, EntityReference, Throwable) - Constructor for exception org.xwiki.security.authorization.AccessDeniedException
add(Right) - Method in class org.xwiki.security.authorization.RightSet
addAll(Collection<? extends Right>) - Method in class org.xwiki.security.authorization.RightSet
ADMIN - Static variable in class org.xwiki.security.authorization.Right: The Admin access right.
after(AutoCloseable) - Method in interface org.xwiki.security.authorization.AuthorExecutor: Restore the context to it's previous state as defined by the provided AutoCloseable.
AuthorExecutor - Interface in org.xwiki.security.authorization: Allow executing some code with the right of a provided user.
AuthorizationException - Exception in org.xwiki.security.authorization: This is the base exception raised for various reasons by the authorization module.
AuthorizationException(String) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationException(String, Throwable) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationException(DocumentReference, EntityReference) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationException(DocumentReference, EntityReference, String) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationException(Right, DocumentReference, EntityReference, String) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationException(DocumentReference, EntityReference, String, Throwable) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationException(Right, DocumentReference, EntityReference, String, Throwable) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationException(EntityReference, String, Throwable) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationException(DocumentReference, EntityReference, Throwable) - Constructor for exception org.xwiki.security.authorization.AuthorizationException
AuthorizationManager - Interface in org.xwiki.security.authorization: This API is for checking the access rights of any users on any XWiki entities.
AuthorizationManagerConfiguration - Interface in org.xwiki.security.authorization: Configuration of the AuthorizationManager.
AuthorizationSettler - Interface in org.xwiki.security.authorization: An AuthorizationSettler compute the resulting access for a given user, a list of groups, and a hierarchy of rights objects defining rights on a given entity.

B

before(DocumentReference) - Method in interface org.xwiki.security.authorization.AuthorExecutor: Deprecated.
since 10.11RC1, use AuthorExecutor.before(DocumentReference, DocumentReference) instead
before(DocumentReference, DocumentReference) - Method in interface org.xwiki.security.authorization.AuthorExecutor: Setup the context so that following code is executed with provided user rights.

C

call(Callable<V>, DocumentReference) - Method in interface org.xwiki.security.authorization.AuthorExecutor: Deprecated.
since 10.11RC1, use AuthorExecutor.call(Callable, DocumentReference, DocumentReference) instead
call(Callable<V>, DocumentReference, DocumentReference) - Method in interface org.xwiki.security.authorization.AuthorExecutor: Execute the passed Callable with the rights of the passed user.
checkAccess(Right, DocumentReference, EntityReference) - Method in interface org.xwiki.security.authorization.AuthorizationManager: Check if the user identified by userReference has the access identified by right on the entity identified by entityReference.
checkAccess(Right) - Method in interface org.xwiki.security.authorization.ContextualAuthorizationManager: Check if access identified by right on the current entity is allowed in the current context.
checkAccess(Right, EntityReference) - Method in interface org.xwiki.security.authorization.ContextualAuthorizationManager: Check if access identified by right on the given entity is allowed in the current context.
checkAccess(Right, DocumentReference, EntityReference) - Method in class org.xwiki.security.authorization.DefaultAuthorizationManager
clear() - Method in class org.xwiki.security.authorization.RightMap
clear() - Method in class org.xwiki.security.authorization.RightSet
clone() - Method in class org.xwiki.security.authorization.RightMap
clone() - Method in class org.xwiki.security.authorization.RightSet
COMMENT - Static variable in class org.xwiki.security.authorization.Right: The comment access right.
compareTo(Right) - Method in class org.xwiki.security.authorization.Right
ConflictingInsertionException - Exception in org.xwiki.security.authorization.cache: This exception is thrown if two or more parallel threads have attempted to load the cache with the same entry at the same time as a right was updated, so the resulting entries are different.
ConflictingInsertionException() - Constructor for exception org.xwiki.security.authorization.cache.ConflictingInsertionException: Constructs a new exception with null as its detail message.
ConflictingInsertionException(String) - Constructor for exception org.xwiki.security.authorization.cache.ConflictingInsertionException: Constructs a new exception with the specified detail message.
contains(Object) - Method in class org.xwiki.security.authorization.RightSet
containsAll(Collection<?>) - Method in class org.xwiki.security.authorization.RightSet
containsKey(Object) - Method in class org.xwiki.security.authorization.RightMap
containsValue(Object) - Method in class org.xwiki.security.authorization.RightMap
ContextualAuthorizationManager - Interface in org.xwiki.security.authorization: This API is for checking the access rights of current user in the current context.
CREATE_WIKI - Static variable in class org.xwiki.security.authorization.Right: The creation of a Wiki right.
CREATOR - Static variable in class org.xwiki.security.authorization.Right: Imply rights provided to creator of a document.

D

DefaultAuthorizationManager - Class in org.xwiki.security.authorization: Default implementation of the AuthorizationManager.
DefaultAuthorizationManager() - Constructor for class org.xwiki.security.authorization.DefaultAuthorizationManager
DefaultSecurityReferenceFactory - Class in org.xwiki.security: SecurityReference factory.
DefaultSecurityReferenceFactory() - Constructor for class org.xwiki.security.DefaultSecurityReferenceFactory
DELETE - Static variable in class org.xwiki.security.authorization.Right: The delete access right.

E

EDIT - Static variable in class org.xwiki.security.authorization.Right: The edit access right.
EntityTypeNotSupportedException - Exception in org.xwiki.security.authorization: Thrown when attempting to load a right for an unsupported entity type.
EntityTypeNotSupportedException(EntityType, SecurityEntryReader) - Constructor for exception org.xwiki.security.authorization.EntityTypeNotSupportedException
EntityTypeNotSupportedException(EntityType, SecurityEntryReaderExtra) - Constructor for exception org.xwiki.security.authorization.EntityTypeNotSupportedException
entrySet() - Method in class org.xwiki.security.authorization.RightMap
equals(Object) - Method in class org.xwiki.security.authorization.RightMap
equals(Object) - Method in class org.xwiki.security.authorization.RightSet

F

FARM - Static variable in class org.xwiki.security.SecurityReference: EntityType for the main wiki.
FARM_ONLY - Static variable in class org.xwiki.security.authorization.Right: Targeted entity type list to target only the main wiki.

G

get(UserSecurityReference, SecurityReference) - Method in interface org.xwiki.security.authorization.cache.SecurityCache: Get a cached entry.
get(SecurityReference) - Method in interface org.xwiki.security.authorization.cache.SecurityCache: Get a cached entry.
get(int) - Static method in class org.xwiki.security.authorization.Right: Retrieve a right based on its ordinal.
get(Object) - Method in class org.xwiki.security.authorization.RightMap
get(Right) - Method in interface org.xwiki.security.authorization.SecurityAccess: Return the rule state of a given Right.
getAccess() - Method in interface org.xwiki.security.authorization.SecurityAccessEntry
getAllRightsAsString() - Static method in class org.xwiki.security.authorization.Right
getAuthorizationSettler() - Method in interface org.xwiki.security.authorization.AuthorizationManagerConfiguration
getDefaultState() - Method in class org.xwiki.security.authorization.Right
getDefaultState() - Method in interface org.xwiki.security.authorization.RightDescription
getEnabledRights(EntityType) - Static method in class org.xwiki.security.authorization.Right: Returns the list of rights available for a given entity type.
getImpliedRights() - Method in class org.xwiki.security.authorization.Right
getImpliedRights() - Method in interface org.xwiki.security.authorization.RightDescription
getInheritanceOverridePolicy() - Method in class org.xwiki.security.authorization.Right
getInheritanceOverridePolicy() - Method in interface org.xwiki.security.authorization.RightDescription
getName() - Method in class org.xwiki.security.authorization.Right
getName() - Method in interface org.xwiki.security.authorization.RightDescription
getOriginalDocumentReference() - Method in class org.xwiki.security.SecurityReference
getOriginalReference() - Method in class org.xwiki.security.SecurityReference
getOriginalReference() - Method in class org.xwiki.security.UserSecurityReference
getOriginalSpaceReference() - Method in class org.xwiki.security.SecurityReference
getOriginalWikiReference() - Method in class org.xwiki.security.SecurityReference
getParentSecurityReference() - Method in class org.xwiki.security.SecurityReference
getReference() - Method in interface org.xwiki.security.authorization.SecurityEntry
getReversedSecurityReferenceChain() - Method in class org.xwiki.security.SecurityReference
getRules() - Method in interface org.xwiki.security.authorization.SecurityRuleEntry
getSecurityType() - Method in class org.xwiki.security.SecurityReference
getStandardRights() - Static method in class org.xwiki.security.authorization.Right
getState() - Method in interface org.xwiki.security.authorization.SecurityRule
getTargetedEntityType() - Method in class org.xwiki.security.authorization.Right
getTargetedEntityType() - Method in interface org.xwiki.security.authorization.RightDescription
getTieResolutionPolicy() - Method in class org.xwiki.security.authorization.Right
getTieResolutionPolicy() - Method in interface org.xwiki.security.authorization.RightDescription
getUserReference() - Method in interface org.xwiki.security.authorization.SecurityAccessEntry
getValue() - Method in enum org.xwiki.security.authorization.RuleState
getWikiReference() - Method in interface org.xwiki.security.authorization.cache.SecurityShadowEntry
getWikiReference() - Method in class org.xwiki.security.SecurityReference
GroupSecurityReference - Class in org.xwiki.security: GroupSecurityReference is a SecurityReference that is used to represent a security group, which is a set of users, such that rights can be assigned to the whole group at once.

H

hasAccess(Right, DocumentReference, EntityReference) - Method in interface org.xwiki.security.authorization.AuthorizationManager: Verifies if the user identified by userReference has the access identified by right on the entity identified by entityReference.
hasAccess(Right) - Method in interface org.xwiki.security.authorization.ContextualAuthorizationManager: Verifies if access identified by right on the current entity would be allowed in the current context.
hasAccess(Right, EntityReference) - Method in interface org.xwiki.security.authorization.ContextualAuthorizationManager: Verifies if access identified by right on the given entity would be allowed in the current context.
hasAccess(Right, DocumentReference, EntityReference) - Method in class org.xwiki.security.authorization.DefaultAuthorizationManager
hashCode() - Method in class org.xwiki.security.authorization.RightMap
hashCode() - Method in class org.xwiki.security.authorization.RightSet

I

ILLEGAL - Static variable in class org.xwiki.security.authorization.Right: Illegal value.
ILLEGAL_RIGHT_NAME - Static variable in class org.xwiki.security.authorization.Right: Illegal right name.
isEmpty() - Method in class org.xwiki.security.authorization.RightMap
isEmpty() - Method in class org.xwiki.security.authorization.RightSet
isEmpty() - Method in interface org.xwiki.security.authorization.SecurityRuleEntry
isGlobal() - Method in class org.xwiki.security.UserSecurityReference
isReadOnly() - Method in class org.xwiki.security.authorization.Right
isReadOnly() - Method in interface org.xwiki.security.authorization.RightDescription: Used to check if this right should be allowed when the wiki is in read-only mode.
iterator() - Method in class org.xwiki.security.authorization.RightSet

K

keySet() - Method in class org.xwiki.security.authorization.RightMap

L

load(UserSecurityReference, SecurityReference) - Method in interface org.xwiki.security.authorization.cache.SecurityCacheLoader: Load the cache with the required entries to look up the access for a given user on a given entity.
logDeny(DocumentReference, EntityReference, Right, String) - Method in class org.xwiki.security.authorization.DefaultAuthorizationManager: Log denied access conclusion.
LOGIN - Static variable in class org.xwiki.security.authorization.Right: The login access right.

M

mainWikiReference - Variable in class org.xwiki.security.SecurityReference: Main wiki reference.
match(Right) - Method in interface org.xwiki.security.authorization.SecurityRule: Check if this rule match the given right.
match(GroupSecurityReference) - Method in interface org.xwiki.security.authorization.SecurityRule: Check if this rule match the given group.
match(UserSecurityReference) - Method in interface org.xwiki.security.authorization.SecurityRule: Check if this rule match the given user.
matches(Object) - Method in class org.xwiki.security.authorization.event.RightUpdatedEvent

N

newEntityReference(EntityReference) - Method in class org.xwiki.security.DefaultSecurityReferenceFactory
newEntityReference(EntityReference) - Method in interface org.xwiki.security.SecurityReferenceFactory: Returns a SecurityReference for the provided entity.
newGroupReference(DocumentReference) - Method in class org.xwiki.security.DefaultSecurityReferenceFactory
newGroupReference(DocumentReference) - Method in interface org.xwiki.security.SecurityReferenceFactory: Returns a GroupSecurityReference for the provided group document reference.
newUserReference(DocumentReference) - Method in class org.xwiki.security.DefaultSecurityReferenceFactory
newUserReference(DocumentReference) - Method in interface org.xwiki.security.SecurityReferenceFactory: Returns a UserSecurityReference for the provided user document reference.

O

ordinal() - Method in class org.xwiki.security.authorization.Right
org.xwiki.security - package org.xwiki.security
org.xwiki.security.authorization - package org.xwiki.security.authorization
org.xwiki.security.authorization.cache - package org.xwiki.security.authorization.cache
org.xwiki.security.authorization.event - package org.xwiki.security.authorization.event

P

ParentEntryEvictedException - Exception in org.xwiki.security.authorization.cache: All cache entries except wiki cache entries must have their parent cached, so the SecurityCacheLoader must insert the entries, if missing in turn.
ParentEntryEvictedException() - Constructor for exception org.xwiki.security.authorization.cache.ParentEntryEvictedException: Constructs a new exception with null as its detail message.
ParentEntryEvictedException(String) - Constructor for exception org.xwiki.security.authorization.cache.ParentEntryEvictedException: Constructs a new exception with the specified detail message.
PROGRAM - Static variable in class org.xwiki.security.authorization.Right: The program access right.
put(Right, V) - Method in class org.xwiki.security.authorization.RightMap
putAll(Map<? extends Right, ? extends V>) - Method in class org.xwiki.security.authorization.RightMap

R

read(SecurityReference) - Method in interface org.xwiki.security.authorization.SecurityEntryReader: Read a collection of rules attached to a given entity.
read(SecurityReference) - Method in interface org.xwiki.security.authorization.SecurityEntryReaderExtra: Read a collection of rules attached to a given entity.
register(RightDescription) - Method in interface org.xwiki.security.authorization.AuthorizationManager: Register a new custom Right.
register(RightDescription, Set<Right>) - Method in interface org.xwiki.security.authorization.AuthorizationManager: Register a new custom Right and add it as an implied right to the given set of rights.
register(RightDescription) - Method in class org.xwiki.security.authorization.DefaultAuthorizationManager
register(RightDescription, Set<Right>) - Method in class org.xwiki.security.authorization.DefaultAuthorizationManager
REGISTER - Static variable in class org.xwiki.security.authorization.Right: The register access right.
remove(UserSecurityReference, SecurityReference) - Method in interface org.xwiki.security.authorization.cache.SecurityCache: Remove an entry from this cache.
remove(SecurityReference) - Method in interface org.xwiki.security.authorization.cache.SecurityCache: Remove an entry from this cache.
remove(Object) - Method in class org.xwiki.security.authorization.RightMap
remove(Object) - Method in class org.xwiki.security.authorization.RightSet
removeAll(Collection<?>) - Method in class org.xwiki.security.authorization.RightSet
resume() - Method in interface org.xwiki.security.authorization.cache.SecurityCacheRulesInvalidator: Resume delivery of invalidation events.
retainAll(Collection<?>) - Method in class org.xwiki.security.authorization.RightSet
Right - Class in org.xwiki.security.authorization: Enumeration of the possible rights.
RightDescription - Interface in org.xwiki.security.authorization: Describe a Right, allow adding new Rights, also implemented by the Right class.
RightMap<V> - Class in org.xwiki.security.authorization: Optimized map implementation with a key of type Right.
RightMap() - Constructor for class org.xwiki.security.authorization.RightMap: Default constructor.
RightSet - Class in org.xwiki.security.authorization: Optimized set of Right.
RightSet() - Constructor for class org.xwiki.security.authorization.RightSet: Default constructor.
RightSet(Collection<? extends Right>) - Constructor for class org.xwiki.security.authorization.RightSet: Create a new initialized set.
RightSet(Right...) - Constructor for class org.xwiki.security.authorization.RightSet: Create a new initialized set.
RightUpdatedEvent - Class in org.xwiki.security.authorization.event: An event triggered when a change might have impacted rights (modified, right, group, etc.).
RightUpdatedEvent() - Constructor for class org.xwiki.security.authorization.event.RightUpdatedEvent
RuleState - Enum in org.xwiki.security.authorization: The state of a particular right as determined by a security rule.

S

SCRIPT - Static variable in class org.xwiki.security.authorization.Right: The script access right.
SecurityAccess - Interface in org.xwiki.security.authorization: Provide the allow/deny/undetermined state of a full set of rights.
SecurityAccessEntry - Interface in org.xwiki.security.authorization: A security access entry is the association of a user, an entity and a security access that represent an authorization settler decision.
SecurityCache - Interface in org.xwiki.security.authorization.cache: A cache for fast access right rules checking.
SecurityCacheLoader - Interface in org.xwiki.security.authorization.cache: Loads access and rule entries into the security cache.
SecurityCacheRulesInvalidator - Interface in org.xwiki.security.authorization.cache: The instance of this class monitors updates and invalidates right cache entries whenever necessary.
SecurityEntry - Interface in org.xwiki.security.authorization: A security entry is the association of an entity and a set of security rules that constitute a elementary declarative information for the security settler to compute the security access of users.
SecurityEntryReader - Interface in org.xwiki.security.authorization: A security rules reader reads rules attached to a given entity.
SecurityEntryReaderExtra - Interface in org.xwiki.security.authorization: A component called by the SecurityEntryReader to gather rules for a passed entity.
SecurityReference - Class in org.xwiki.security: SecurityReference is a variant of EntityReference used internally in the security-authorization module, for the purpose of conveniently maintaining a hierarchy where all entities are rooted by the main wiki.
SecurityReferenceFactory - Interface in org.xwiki.security: Factory to create new SecurityReference, UserSecurityReference and GroupSecurityReference.
SecurityRule - Interface in org.xwiki.security.authorization: A security rule, representing a declarative access right for some users, groups, and rights.
SecurityRuleEntry - Interface in org.xwiki.security.authorization: A security entry is the association of an entity and a set of security rules that constitute a elementary declarative information for the security settler to compute the security access of users.
SecurityShadowEntry - Interface in org.xwiki.security.authorization.cache: A security cache entry to shadow external (global) users in sub-containers (sub-wikis).
settle(UserSecurityReference, Collection<GroupSecurityReference>, Deque<SecurityRuleEntry>) - Method in interface org.xwiki.security.authorization.AuthorizationSettler: Compute the current access for the user that is a member of the given groups and on an entity which is protected by the given hierarchy of rights objects.
size() - Static method in class org.xwiki.security.authorization.Right
size() - Method in class org.xwiki.security.authorization.RightMap
size() - Method in class org.xwiki.security.authorization.RightSet
SUPERADMIN_USER - Static variable in interface org.xwiki.security.authorization.AuthorizationManager: The Superadmin username.
suspend() - Method in interface org.xwiki.security.authorization.cache.SecurityCacheRulesInvalidator: Suspend delivery of invalidation events.

T

toArray() - Method in class org.xwiki.security.authorization.RightSet
toArray(T[]) - Method in class org.xwiki.security.authorization.RightSet
toRight(String) - Static method in class org.xwiki.security.authorization.Right: Convert a string to a right.
toString() - Method in class org.xwiki.security.authorization.Right
toString() - Method in class org.xwiki.security.authorization.RightMap
toString() - Method in class org.xwiki.security.authorization.RightSet

U

UnableToRegisterRightException - Exception in org.xwiki.security.authorization: Raised when the authorization manager fails to register a new right for any reason.
UnableToRegisterRightException(RightDescription, Throwable) - Constructor for exception org.xwiki.security.authorization.UnableToRegisterRightException
unregister(Right) - Method in interface org.xwiki.security.authorization.AuthorizationManager: Unregister the given custom Right.
unregister(Right) - Method in class org.xwiki.security.authorization.DefaultAuthorizationManager
UserSecurityReference - Class in org.xwiki.security: A user is represented internally in the authorization module by a UserSecurityReference corresponding to the DocumentReference of the user's profile document.

V

valueOf(String) - Static method in enum org.xwiki.security.authorization.RuleState: Returns the enum constant of this type with the specified name.
values() - Static method in class org.xwiki.security.authorization.Right
values() - Method in class org.xwiki.security.authorization.RightMap
values() - Static method in enum org.xwiki.security.authorization.RuleState: Returns an array containing the constants of this enum type, in the order they are declared.
VIEW - Static variable in class org.xwiki.security.authorization.Right: The view access right.

W

WIKI_ONLY - Static variable in class org.xwiki.security.authorization.Right: Targeted entity type list to target only wikis (including main wiki).
WIKI_SPACE - Static variable in class org.xwiki.security.authorization.Right: Targeted entity type list to target wikis and spaces.
WIKI_SPACE_DOCUMENT - Static variable in class org.xwiki.security.authorization.Right: Targeted entity type list to target wikis, spaces and documents.

A B C D E F G H I K L M N O P R S T U V W