public interface IdentityStore
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ANYURI_TYPE |
static java.lang.String |
BOOLEAN_TYPE |
static java.lang.String |
DATE_TYPE |
static java.lang.String |
DATETIME_TYPE |
static java.lang.String |
DECIMAL_TYPE |
static java.lang.String |
HEXBINARY_TYPE |
static int |
SEARCH_BY_GUID
search type to specify that identities should be searched by GUID of the Identity.
|
static int |
SEARCH_BY_NAME
search type to specify that identities should be searched by name.
|
static int |
SEARCH_BY_UNIQUE_NAME
search type to specify that identities should be searched by unique name.
|
static java.lang.String |
STRING_TYPE
Defining all the possible Data Types as Constants
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this IdentityStore instance and free any resources associated with it.
|
boolean |
exists(Role role)
Determines whether the given role exists in the identity repository.
|
boolean |
exists(User user)
Determines whether the given user exists in the identity repository.
|
ComplexSearchFilter |
getComplexSearchFilter(SearchFilter[] sfarr, int oper_type)
Returns ComplexSearchFilter instance.
|
java.util.List |
getMandatoryUserPropertyNames()
Gets the list of mandatory user property names as supported by the underlying repository.
|
RoleManager |
getRoleManager()
Get the role manager for managing roles.
|
java.util.List |
getSearchableAttributes()
Determines all the attributes in identity respsitory that are searchable.
|
SimpleSearchFilter |
getSimpleSearchFilter(java.lang.String attrname, int type, java.lang.Object value)
Returns SimpleSearchFilter instance.
|
StoreConfiguration |
getStoreConfiguration()
Retrieves the StoreConfiguration instance associated with this IdentityStore instance.
|
SubjectParser |
getSubjectParser()
Returns SubjectParser instance.
|
UserManager |
getUserManager()
Get the user manager for managing users.
|
java.util.List |
getUserPropertyNames()
Gets the list of user property names as supported by the underlying repository.
|
java.util.List<PropertySchema> |
getUserPropertySchema() |
void |
registerAttributeRetriever(AttributeRetriever retriever) |
SearchResponse |
search(SearchParameters params)
Search for users/roles.
|
SearchResponse |
searchProfiles(SearchParameters params)
Search for user/role profiles.
|
Role |
searchRole(int searchType, java.lang.String value)
Search for role with specified value
|
SearchResponse |
searchRoles(int scope, SearchParameters params)
Search for roles within specified role scope.
|
User |
searchUser(int searchType, java.lang.String value)
Search for user with specified value
|
User |
searchUser(java.security.Principal principal)
Search the user corresponding to given user principal object
|
User |
searchUser(java.lang.String name)
Search for user with specified name
|
SearchResponse |
searchUsers(SearchParameters params)
Search for users.
|
SearchResponse |
searchUsers(SearchParameters params, java.util.Set<java.lang.String> propertySet) |
static final int SEARCH_BY_NAME
searchUser(int, String)
, searchRole(int, String)
static final int SEARCH_BY_UNIQUE_NAME
searchUser(int, String)
, searchRole(int, String)
static final int SEARCH_BY_GUID
searchUser(int, String)
, searchRole(int, String)
static final java.lang.String STRING_TYPE
static final java.lang.String DECIMAL_TYPE
static final java.lang.String HEXBINARY_TYPE
static final java.lang.String DATETIME_TYPE
static final java.lang.String DATE_TYPE
static final java.lang.String BOOLEAN_TYPE
static final java.lang.String ANYURI_TYPE
RoleManager getRoleManager() throws IMException
OperationNotSupportedException
- Thrown by the service provider if it doesn't support role managerIMException
- Thrown by the service provider in case of any other problem.UserManager getUserManager() throws IMException
OperationNotSupportedException
- Thrown by the service provider if it doesn't support user managerIMException
- Thrown by the service provider in case of any other problem.SearchResponse searchUsers(SearchParameters params) throws IMException
params
- search parametersObjectNotFoundException
- Thrown by the service provider if no users matched the search criterion.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SearchParameters
SearchResponse searchUsers(SearchParameters params, java.util.Set<java.lang.String> propertySet) throws IMException
IMException
User searchUser(java.lang.String name) throws IMException
name
- name of the userObjectNotFoundException
- Thrown by the service provider if the user does not exist.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.User searchUser(int searchType, java.lang.String value) throws IMException
searchType
- search by criteria. Currently you can SEARCH_BY_NAME
or SEARCH_BY_UNIQUE_NAME
value
- search value depending upon the searchType selected above.ObjectNotFoundException
- Thrown by the service provider if the user does not exist.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.User searchUser(java.security.Principal principal) throws IMException
principal
- principal object of userObjectNotFoundException
- Thrown by the service provider if the user does not exist.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SearchResponse search(SearchParameters params) throws IMException
params
- search parametersObjectNotFoundException
- Thrown by the service provider if no users/roles matched the search criterion.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SearchParameters
SearchResponse searchProfiles(SearchParameters params) throws IMException
params
- search parametersObjectNotFoundException
- Thrown by the service provider if no users/roles matched the search criterion.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SearchParameters
SearchResponse searchRoles(int scope, SearchParameters params) throws IMException
scope
- role scope. See all the possbile scopes in Role
params
- search parametersObjectNotFoundException
- Thrown by the service provider if no roles matched the search criterion.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SearchParameters
, Role
Role searchRole(int searchType, java.lang.String value) throws IMException
searchType
- search by criteria. Currently you can SEARCH_BY_NAME
or SEARCH_BY_UNIQUE_NAME
value
- search value depending upon the searchType selected above.ObjectNotFoundException
- Thrown by the service provider if the role does not exist.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.ComplexSearchFilter getComplexSearchFilter(SearchFilter[] sfarr, int oper_type)
sfarr
- Array of searchfilters which will constitue the complexfilteroper_type
- Logical operator type ComplexSearchFilter.TYPE_AND
, ComplexSearchFilter.TYPE_OR
.IMException
- Thrown by the service provider in case of any problem.ComplexSearchFilter
SimpleSearchFilter getSimpleSearchFilter(java.lang.String attrname, int type, java.lang.Object value)
attrname
- name of the attribute to be filteredtype
- evaluation operator. Defined in SimpleSearchFilter
value
- value of the attributeIMException
- Thrown by the service provider in case of any problem.SimpleSearchFilter
boolean exists(User user) throws IMException
user
- user whose existance is to be verifiedOperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.boolean exists(Role role) throws IMException
role
- role whose existance is to be verifiedOperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.java.util.List getSearchableAttributes() throws IMException
OperationNotSupportedException
- Thrown by the service providerOperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SubjectParser getSubjectParser()
OperationNotSupportedException
- Thrown by the service providerOperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.StoreConfiguration getStoreConfiguration() throws IMException
OperationNotSupportedException
- Thrown by the service providerIMException
- Thrown by the service provider in case of any problem.StoreConfiguration
java.util.List getUserPropertyNames() throws IMException
IMException
- Thrown by the service provider in case of any problem.java.util.List getMandatoryUserPropertyNames() throws IMException
IMException
- Thrown by the service provider in case of any problem.void close() throws IMException
IMException
- Thrown by the service provider in case of any problem.void registerAttributeRetriever(AttributeRetriever retriever)
java.util.List<PropertySchema> getUserPropertySchema() throws IMException
IMException