Package com.sap.security.api

Provides basic User Management functionality.

See:
Description

Interface Summary

GroupListener	This class allows to register for user mangagement events of principals of type IGroup.
IAuthentication	This interface retrieves the user information of currently logged-in user.
IConfigurable	This interface is implemented by components of the user management which need explicit configuration, e.g. user factories and authenticators.
IGroup	This interface provides read and write access to principals of type group.
IGroupFactory	This interface for a groupfactory provides functionality to get group objects by providing required information.
IGroupSearchFilter	This interface acts as a container for values to be used as a search filter when calling IGroupFactory.getGroupSearchFilter().
IMessage
IPrincipal	This interface provides read-access to attributes and the state of an IPrincipal object.
IPrincipalFactory	The principal factory provides means to instantiate principal objects, create new principal (possibly by copying the data of an existing one), delete principals, search for principals based on different criteria and get meta-data for custom principal objects.
IPrincipalMaint	This interface extends IPrincipal and provides write access to a principal.
IPrincipalMetaData	This interface provides methods to access meta data of principal objects.
IPrincipalSearchFilter	This interface provides the possibility for values to be used as a search filter when calling IPrincipalFactory.getPrincipalSearchFilter(boolean,String).
IPrincipalSet	This interface provides read and write access to attributes and the state of an IPrincipalSet object.
IRole	This interface provides read and write access to attributes and properties of instances of type IRole.
IRoleFactory	This interface provides methods to access, create, search and delete IRole objects.
IRoleSearchFilter	This interface acts as a container for text values to be used as a search filter when calling IRoleFactory.searchRoles(IRoleSearchFilter).
ISearchAttribute	This interface provides functionality to access a search element.
ISearchResult	A read-only iterator that can return the size of the iteration
ISecurityPolicy	This interface handles UME Security Policy settings.
IUser	This interface provides read-access to the user's attributes, and offers basic support for authorization checking.
IUserAccount	Interface to get and set user account data.
IUserAccountFactory	User account factory will handle authentication and retrieval of user account information from persistence storage.
IUserAccountSearchFilter	This interface acts as a container for text values to be used as a search filter when calling IUserAccountFactory.search(IUserAccountSearchFilter).
IUserFactory	The user factory provides means to instantiate user objects, create new users (possibly by copying the data of an existing one), delete users, search for users based on different criteria and perform mass commit/rollback operations on a set of users.
IUserMaint	This interface extends IUser and provides write access to a user.
IUserSearchFilter	This class acts as a container for text values to be used as a search filter when calling IUserFactory.searchUsers(IUserSearchFilter).
PrincipalAttributeListener
PrincipalListener	This class allows to register for user mangagement events.
RoleListener	This class allows to register for user mangagement events.
UserAccountListener	This class allows to register for user mangagement events.
UserListener	This class allows to register for user mangagement events.

Class Summary

AttributeList	Class AttributeList is used to define specific attributes which can be used to populate an IPrincipal object.
PrincipalIterator	Class PrincipalIterator is used to change the return type of iterators returned by this API (e.g.
UMFactory	Main factory providing access to all UME functionality.

Exception Summary

AttributeValueAlreadyExistsException	This exception indicates that an attribute value which should be set for a attribute already exists.
AuthenticationFailedException	This exception indicates an exception which can happen during an authentication process
CertificateAlreadyInUseException
DuplicateKeyException	This exception indicates an attempt to read an object by a key that is ambiguous.
FeatureNotAvailableException	This exception indicates a feature that is not available in the respective implementation of a user management interface.
GroupAlreadyExistsException	This exception indicates an attempt to create a group which already exists in the data store.
InvalidIDException	This exception indicates an attempt to create a persistent object (using a factory) with a unique ID which is not supported by the respective store.
InvalidLogonIdException	This exception indicates an invalid logon id.
InvalidPasswordException	This exception indicates an attempt to logon with an invalid password.
NoAccessPermissionException	This exception is used, if the access to a already populated principal fails because missing permission.
NoSuchGroupException	This exception indicates an attempt to access a non-existing group object in the object store.
NoSuchObjectException	This exception indicates an attempt to access a non-existing object in the object store.
NoSuchPCDRoleException	This exception indicates an attempt to access a non-existing PCD role object in the object store.
NoSuchPrincipalException	This exception indicates an attempt to access a non-existing principal in the principal store.
NoSuchRoleException	This exception indicates an attempt to access a non-existing role object in the object store.
NoSuchUserAccountException	This exception indicates an attempt to access a non-existing user in the user store.
NoSuchUserException	This exception indicates an attempt to access a non-existing user in the user store.
ObjectAlreadyExistsException	This exception indicates an attempt to create a object who already exists in the object store.
PrincipalAlreadyExistsException	This exception indicates an attempt to access a non-existing principal in the data store.
PrincipalNotAccessibleException	This exception is used, if the access to a already populated principal fails.
RoleAlreadyExistsException	This exception indicates an attempt to access a non-existing role in the role store.
SearchResultSizeLimitExceededException	Title: SearchResultSizeLimitExceededException Description: Exception class used to indicate that a search result has exceeded the size limit This exception may be thrown from search methods, if the result of the search would be too large or if a server side size limit was exceeded.
UMException	This is the superclass of all checked exceptions employed in the user management; it indicates error conditions that reasonable applications might want to catch.
UMRuntimeException	This is the superclass of all runtime exceptions employed in the user management; it indicates error conditions that can occur during the normal operation of the JVM.
UserAccountAlreadyExistsException	This exception indicates an attempt to create a user account that already exists in the user account store.
UserAlreadyExistsException	This exception indicates an attempt to create a user that already exists in the user store.
UserLockedException	This exception indicates that a user account is locked in the user account store.

Package com.sap.security.api Description

Provides basic User Management functionality. Here you have control over the pricipal data like users, groups and roles.

See class UMFactory as entry point regarding usage of UME functionality.