Index (Uberfire Security Management - Users and groups management API 7.74.1.Final API)

A C D E G H I K N O R S U V
All Classes All Packages

A

AbstractEntityManager<T,S extends Settings> - Interface in org.uberfire.ext.security.management.api: Basic management API for security realm entities type of T.
AbstractEntityManager.SearchRequest - Interface in org.uberfire.ext.security.management.api: The request parameters for performing entity searching on the backend security server.
AbstractEntityManager.SearchResponse<T> - Interface in org.uberfire.ext.security.management.api: The response values for a search operation.
allowEmpty() - Method in interface org.uberfire.ext.security.management.api.GroupManagerSettings: Specify if the provider allows groups with no users assigned.
allowEmpty() - Method in class org.uberfire.ext.security.management.impl.GroupManagerSettingsImpl
assignGroups(String, Collection<String>) - Method in interface org.uberfire.ext.security.management.api.UserManager: Assign a collection of groups to a user.
assignRoles(String, Collection<String>) - Method in interface org.uberfire.ext.security.management.api.UserManager: Assign a collection of roles to a user.
assignUsers(String, Collection<String>) - Method in interface org.uberfire.ext.security.management.api.GroupManager: Assign the a group to a given collection of users.

C

CAN_ADD_GROUP - org.uberfire.ext.security.management.api.Capability
CAN_ADD_ROLE - org.uberfire.ext.security.management.api.Capability
CAN_ADD_USER - org.uberfire.ext.security.management.api.Capability
CAN_ASSIGN_GROUPS - org.uberfire.ext.security.management.api.Capability
CAN_ASSIGN_ROLES - org.uberfire.ext.security.management.api.Capability
CAN_CHANGE_PASSWORD - org.uberfire.ext.security.management.api.Capability
CAN_DELETE_GROUP - org.uberfire.ext.security.management.api.Capability
CAN_DELETE_ROLE - org.uberfire.ext.security.management.api.Capability
CAN_DELETE_USER - org.uberfire.ext.security.management.api.Capability
CAN_MANAGE_ATTRIBUTES - org.uberfire.ext.security.management.api.Capability
CAN_READ_GROUP - org.uberfire.ext.security.management.api.Capability
CAN_READ_ROLE - org.uberfire.ext.security.management.api.Capability
CAN_READ_USER - org.uberfire.ext.security.management.api.Capability
CAN_SEARCH_GROUPS - org.uberfire.ext.security.management.api.Capability
CAN_SEARCH_ROLES - org.uberfire.ext.security.management.api.Capability
CAN_SEARCH_USERS - org.uberfire.ext.security.management.api.Capability
CAN_UPDATE_GROUP - org.uberfire.ext.security.management.api.Capability
CAN_UPDATE_ROLE - org.uberfire.ext.security.management.api.Capability
CAN_UPDATE_USER - org.uberfire.ext.security.management.api.Capability
Capability - Enum in org.uberfire.ext.security.management.api: Supported features for the User System Management services.
CapabilityStatus - Enum in org.uberfire.ext.security.management.api: The status for a capability.
changePassword(String, String) - Method in interface org.uberfire.ext.security.management.api.UserManager: Changes the user's password.
ClientNotFoundException - Exception in org.uberfire.ext.security.management.api.exception
ClientNotFoundException(String) - Constructor for exception org.uberfire.ext.security.management.api.exception.ClientNotFoundException
ContextualManager - Interface in org.uberfire.ext.security.management.api: You should implement this interface if your managed will be handled within the given EE context (eg: JavaEE CDI context).
create(T) - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager: Creates a given entity in the backend security environment.

D

delete(String...) - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager: Deletes a given entity or entities (bulk delete) in the backend security environment.
destroy() - Method in interface org.uberfire.ext.security.management.api.ContextualManager: Use this method to destroy your manager within the given context (usually JavaEE CDI).

E

ENABLED - org.uberfire.ext.security.management.api.CapabilityStatus
EntityNotFoundException - Exception in org.uberfire.ext.security.management.api.exception: Exception for user system management when some entity is not found.
EntityNotFoundException(String) - Constructor for exception org.uberfire.ext.security.management.api.exception.EntityNotFoundException
EntityValidator<T> - Interface in org.uberfire.ext.security.management.api.validation: The validator contract for a given security entity of type T.
equals(Object) - Method in class org.uberfire.ext.security.management.impl.UserAttributeImpl

G

get(String) - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager: Obtain a single entity instance.
getAll() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager: The entities list of given type.
getCapabilities() - Method in interface org.uberfire.ext.security.management.api.Settings: Obtain all available provider capabilities in a single call.
getCapabilities() - Method in class org.uberfire.ext.security.management.impl.SettingsImpl
getCapability() - Method in exception org.uberfire.ext.security.management.api.exception.UnsupportedServiceCapabilityException
getCode() - Method in exception org.uberfire.ext.security.management.api.exception.OperationFailedException
getConstrainedGroups() - Method in interface org.uberfire.ext.security.management.api.GroupManagerSettings: Return constrained groups for management
getConstrainedGroups() - Method in class org.uberfire.ext.security.management.impl.GroupManagerSettingsImpl
getConstrainedIdentifiers() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchRequest: Constrained (not available to use) identifiers.
getConstrainedIdentifiers() - Method in class org.uberfire.ext.security.management.impl.SearchRequestImpl
getDefaultValue() - Method in interface org.uberfire.ext.security.management.api.UserManager.UserAttribute: The default value for an attribute.
getDefaultValue() - Method in class org.uberfire.ext.security.management.impl.UserAttributeImpl
getIdentifier() - Method in class org.uberfire.ext.security.management.api.event.UserDeletedEvent
getIdentifier() - Method in exception org.uberfire.ext.security.management.api.exception.EntityNotFoundException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.ClientNotFoundException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.EntityNotFoundException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.GroupNotFoundException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.InvalidEntityIdentifierException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.NoImplementationAvailableException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.OperationFailedException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.UnsupportedServiceCapabilityException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.UserAlreadyExistsException
getMessage() - Method in exception org.uberfire.ext.security.management.api.exception.UserNotFoundException
getMessage(String) - Method in class org.uberfire.ext.security.management.api.validation.GroupValidator
getMessage(String) - Method in class org.uberfire.ext.security.management.api.validation.UserValidator
getName() - Method in interface org.uberfire.ext.security.management.api.UserManager.UserAttribute: The attribute name.
getName() - Method in class org.uberfire.ext.security.management.impl.UserAttributeImpl
getPage() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchRequest: The page number for the search cursor.
getPage() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchResponse: The page number for the search cursor.
getPage() - Method in class org.uberfire.ext.security.management.impl.SearchRequestImpl
getPage() - Method in class org.uberfire.ext.security.management.impl.SearchResponseImpl
getPageSize() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchRequest: The number of items for each page.
getPageSize() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchResponse: The number of items for each page.
getPageSize() - Method in class org.uberfire.ext.security.management.impl.SearchRequestImpl
getPageSize() - Method in class org.uberfire.ext.security.management.impl.SearchResponseImpl
getRealmResource() - Method in exception org.uberfire.ext.security.management.api.exception.RealmManagementNotAuthorizedException
getResults() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchResponse: The entities resulting from the search operation.
getResults() - Method in class org.uberfire.ext.security.management.impl.SearchResponseImpl
getSearchPattern() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchRequest: The search pattern string.
getSearchPattern() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchResponse: The search pattern string.
getSearchPattern() - Method in class org.uberfire.ext.security.management.impl.SearchRequestImpl
getSearchPattern() - Method in class org.uberfire.ext.security.management.impl.SearchResponseImpl
getSettings() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager: The entity manager settings.
getSupportedAttributes() - Method in interface org.uberfire.ext.security.management.api.UserManagerSettings: This method is used to provide all the supported user attributes supported by the specific manager implementation.
getSupportedAttributes() - Method in class org.uberfire.ext.security.management.impl.UserManagerSettingsImpl
getSymbolsAccepted() - Method in exception org.uberfire.ext.security.management.api.exception.InvalidEntityIdentifierException
getTotal() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchResponse: The total entities count.
getTotal() - Method in class org.uberfire.ext.security.management.impl.SearchResponseImpl
getUser(String) - Method in interface org.uberfire.ext.security.management.api.service.UserManagerService
getUserId() - Method in exception org.uberfire.ext.security.management.api.exception.UserAlreadyExistsException
GroupManager - Interface in org.uberfire.ext.security.management.api: The Groups Manager.
GroupManagerService - Interface in org.uberfire.ext.security.management.api.service: Remote service API for the Groups Manager.
GroupManagerSettings - Interface in org.uberfire.ext.security.management.api: The settings for a groups entity manager.
GroupManagerSettingsImpl - Class in org.uberfire.ext.security.management.impl: Default settings for a group manager.
GroupManagerSettingsImpl(Map<Capability, CapabilityStatus>, boolean) - Constructor for class org.uberfire.ext.security.management.impl.GroupManagerSettingsImpl
GroupNotFoundException - Exception in org.uberfire.ext.security.management.api.exception: Exception for user system management when the group is not found.
GroupNotFoundException(String) - Constructor for exception org.uberfire.ext.security.management.api.exception.GroupNotFoundException
groups() - Method in interface org.uberfire.ext.security.management.api.UserManagementService: The Groups Manager service.
groupsValidator() - Method in interface org.uberfire.ext.security.management.api.UserSystemManager: The group validator.
GroupValidator - Class in org.uberfire.ext.security.management.api.validation: The base validator class for a Group entity based on JSR303 Bean Validations.
GroupValidator() - Constructor for class org.uberfire.ext.security.management.api.validation.GroupValidator

H

hasNextPage() - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchResponse: Indicates if there are more results (next pages).
hasNextPage() - Method in class org.uberfire.ext.security.management.impl.SearchResponseImpl

I

initialize(UserSystemManager) - Method in interface org.uberfire.ext.security.management.api.ContextualManager: Use this method to initialize your manager within the given context (usually JavaEE CDI).
InvalidEntityIdentifierException - Exception in org.uberfire.ext.security.management.api.exception: The entity's identifier is invalid.
InvalidEntityIdentifierException(String, String) - Constructor for exception org.uberfire.ext.security.management.api.exception.InvalidEntityIdentifierException
isActive() - Method in interface org.uberfire.ext.security.management.api.UserSystemManager: Check if the user system management service are active and successfully initialized.
isEditable() - Method in interface org.uberfire.ext.security.management.api.UserManager.UserAttribute: Specifies if the attribute can be modified.
isEditable() - Method in class org.uberfire.ext.security.management.impl.UserAttributeImpl
isMandatory() - Method in interface org.uberfire.ext.security.management.api.UserManager.UserAttribute: Specifies if the attribute is required for creating a user or if it cannot be removed.
isMandatory() - Method in class org.uberfire.ext.security.management.impl.UserAttributeImpl

K

KEY_NAME_NOT_EMPTY - Static variable in class org.uberfire.ext.security.management.api.validation.GroupValidator
KEY_NAME_NOT_EMPTY - Static variable in class org.uberfire.ext.security.management.api.validation.UserValidator

N

NoImplementationAvailableException - Exception in org.uberfire.ext.security.management.api.exception: Exception for user system management when the service provider implementation class is not available.
NoImplementationAvailableException() - Constructor for exception org.uberfire.ext.security.management.api.exception.NoImplementationAvailableException

O

OperationFailedException - Exception in org.uberfire.ext.security.management.api.exception: Exception for user system management when some remote operation has failed.
OperationFailedException(int, String) - Constructor for exception org.uberfire.ext.security.management.api.exception.OperationFailedException
org.uberfire.ext.security.management.api - package org.uberfire.ext.security.management.api
org.uberfire.ext.security.management.api.event - package org.uberfire.ext.security.management.api.event
org.uberfire.ext.security.management.api.exception - package org.uberfire.ext.security.management.api.exception
org.uberfire.ext.security.management.api.service - package org.uberfire.ext.security.management.api.service
org.uberfire.ext.security.management.api.validation - package org.uberfire.ext.security.management.api.validation
org.uberfire.ext.security.management.impl - package org.uberfire.ext.security.management.impl

R

RealmManagementNotAuthorizedException - Exception in org.uberfire.ext.security.management.api.exception
RealmManagementNotAuthorizedException(String) - Constructor for exception org.uberfire.ext.security.management.api.exception.RealmManagementNotAuthorizedException
RoleManager - Interface in org.uberfire.ext.security.management.api: The Roles Manager.
RoleManagerService - Interface in org.uberfire.ext.security.management.api.service: Remote service API for the Roles Manager.
RoleManagerSettings - Interface in org.uberfire.ext.security.management.api: The settings for a roles entity manager.
RoleManagerSettingsImpl - Class in org.uberfire.ext.security.management.impl: Default settings for a role manager.
RoleManagerSettingsImpl(Map<Capability, CapabilityStatus>) - Constructor for class org.uberfire.ext.security.management.impl.RoleManagerSettingsImpl
roles() - Method in interface org.uberfire.ext.security.management.api.UserManagementService: The Roles Manager service.
rolesValidator() - Method in interface org.uberfire.ext.security.management.api.UserSystemManager: The role validator.
RoleValidator - Class in org.uberfire.ext.security.management.api.validation: The base validator class for a Role entity based on JSR303 Bean Validations.
RoleValidator() - Constructor for class org.uberfire.ext.security.management.api.validation.RoleValidator

S

search(AbstractEntityManager.SearchRequest) - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager: Search entities.
SearchRequestImpl - Class in org.uberfire.ext.security.management.impl: A default search request implementation for the users system management.
SearchRequestImpl() - Constructor for class org.uberfire.ext.security.management.impl.SearchRequestImpl
SearchRequestImpl(String, int, int) - Constructor for class org.uberfire.ext.security.management.impl.SearchRequestImpl
SearchRequestImpl(String, int, int, Set<String>) - Constructor for class org.uberfire.ext.security.management.impl.SearchRequestImpl
SearchResponseImpl<T> - Class in org.uberfire.ext.security.management.impl: A default search response implementation for the users system management.
SearchResponseImpl() - Constructor for class org.uberfire.ext.security.management.impl.SearchResponseImpl
SearchResponseImpl(List<T>, int, int, int, boolean) - Constructor for class org.uberfire.ext.security.management.impl.SearchResponseImpl
SecurityManagementException - Exception in org.uberfire.ext.security.management.api.exception: Generic exception for user system management API.
SecurityManagementException() - Constructor for exception org.uberfire.ext.security.management.api.exception.SecurityManagementException
SecurityManagementException(String) - Constructor for exception org.uberfire.ext.security.management.api.exception.SecurityManagementException
SecurityManagementException(String, Throwable) - Constructor for exception org.uberfire.ext.security.management.api.exception.SecurityManagementException
SecurityManagementException(Throwable) - Constructor for exception org.uberfire.ext.security.management.api.exception.SecurityManagementException
setConstrainedGroups(Collection<String>) - Method in interface org.uberfire.ext.security.management.api.GroupManagerSettings: Sets constrained groups for management (usually the registered roles).
setConstrainedGroups(Collection<String>) - Method in class org.uberfire.ext.security.management.impl.GroupManagerSettingsImpl
setConstrainedIdentifiers(Set<String>) - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager.SearchRequest: Constrained (not available to use) identifiers.
setConstrainedIdentifiers(Set<String>) - Method in class org.uberfire.ext.security.management.impl.SearchRequestImpl
Settings - Interface in org.uberfire.ext.security.management.api: The settings for a given entity manager.
SettingsImpl - Class in org.uberfire.ext.security.management.impl: Base provider settings implementation.
SettingsImpl(Map<Capability, CapabilityStatus>) - Constructor for class org.uberfire.ext.security.management.impl.SettingsImpl

U

UNSUPPORTED - org.uberfire.ext.security.management.api.CapabilityStatus
UnsupportedServiceCapabilityException - Exception in org.uberfire.ext.security.management.api.exception: Exception for user system management when trying to operate with a non supported feature (capability).
UnsupportedServiceCapabilityException(Capability) - Constructor for exception org.uberfire.ext.security.management.api.exception.UnsupportedServiceCapabilityException
update(T) - Method in interface org.uberfire.ext.security.management.api.AbstractEntityManager: Creates a given entity in the backend security environment.
UserAlreadyExistsException - Exception in org.uberfire.ext.security.management.api.exception: Exception for user system management when the entity to create already exists.
UserAlreadyExistsException(String) - Constructor for exception org.uberfire.ext.security.management.api.exception.UserAlreadyExistsException
UserAttributeImpl - Class in org.uberfire.ext.security.management.impl: Default portable User attribute implementation class.
UserAttributeImpl(String, boolean, boolean, String) - Constructor for class org.uberfire.ext.security.management.impl.UserAttributeImpl
UserDeletedEvent - Class in org.uberfire.ext.security.management.api.event
UserDeletedEvent() - Constructor for class org.uberfire.ext.security.management.api.event.UserDeletedEvent
UserDeletedEvent(String) - Constructor for class org.uberfire.ext.security.management.api.event.UserDeletedEvent
UserManagementService - Interface in org.uberfire.ext.security.management.api: The services provided by a concrete user management service provider implementation.
UserManager - Interface in org.uberfire.ext.security.management.api: The Users Manager.
UserManager.UserAttribute - Interface in org.uberfire.ext.security.management.api: Description of a user attribute that is supported by the specific manager implementation.
UserManagerService - Interface in org.uberfire.ext.security.management.api.service: Remote service API for the Users Manager.
UserManagerSettings - Interface in org.uberfire.ext.security.management.api: The settings for a users entity manager.
UserManagerSettingsImpl - Class in org.uberfire.ext.security.management.impl: Default settings for a user manager.
UserManagerSettingsImpl(Map<Capability, CapabilityStatus>, Collection<UserManager.UserAttribute>) - Constructor for class org.uberfire.ext.security.management.impl.UserManagerSettingsImpl
UserNotFoundException - Exception in org.uberfire.ext.security.management.api.exception: Exception for user system management when the user is not found.
UserNotFoundException(String) - Constructor for exception org.uberfire.ext.security.management.api.exception.UserNotFoundException
users() - Method in interface org.uberfire.ext.security.management.api.UserManagementService: The Users Manager service.
usersValidator() - Method in interface org.uberfire.ext.security.management.api.UserSystemManager: The user validator.
UserSystemManager - Interface in org.uberfire.ext.security.management.api: Main users, groups and roles management API.
UserValidator - Class in org.uberfire.ext.security.management.api.validation: The base validator class for a User entity based on JSR303 Bean Validations.
UserValidator() - Constructor for class org.uberfire.ext.security.management.api.validation.UserValidator

V

validate(Group) - Method in class org.uberfire.ext.security.management.api.validation.GroupValidator
validate(User) - Method in class org.uberfire.ext.security.management.api.validation.UserValidator
validate(Role) - Method in class org.uberfire.ext.security.management.api.validation.RoleValidator
validate(T) - Method in interface org.uberfire.ext.security.management.api.validation.EntityValidator: Validates the given entity.
valueOf(String) - Static method in enum org.uberfire.ext.security.management.api.Capability: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.uberfire.ext.security.management.api.CapabilityStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.uberfire.ext.security.management.api.Capability: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.uberfire.ext.security.management.api.CapabilityStatus: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I K N O R S U V
All Classes All Packages