Package com.sun.identity.idm
Interface IdServices
-
- All Known Subinterfaces:
IdCachedServices
- All Known Implementing Classes:
IdCachedServicesDecorator,IdCachedServicesImpl,IdRemoteCachedServicesImpl,IdRemoteServicesImpl,IdServicesDecorator,IdServicesImpl,LowerCaseIdCachedServicesDecorator,LowerCaseIdServicesDecorator
public interface IdServices
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidassignService(SSOToken token, IdType type, String name, String serviceName, SchemaType stype, Map attrMap, String amOrgName, String amsdkDN)booleanauthenticate(String orgName, Callback[] credentials)Returnstrueif the data store has successfully authenticated the identity with the specific type and provided credentials.booleanauthenticate(String orgName, Callback[] credentials, IdType idType)Returnstrueif the data store has successfully authenticated the identity with the specific type and provided credentials.voidchangePassword(SSOToken token, IdType type, String name, String oldPassword, String newPassword, String amOrgName, String amsdkDN)voidclearIdRepoPlugins()voidclearIdRepoPlugins(String orgName, String serviceComponent, int type)AMIdentitycreate(SSOToken token, IdType type, String name, Map attrMap, String amOrgName)voiddelete(SSOToken token, IdType type, String name, String orgName, String amsdkDN)SetgetAssignedServices(SSOToken token, IdType type, String name, Map mapOfServiceNamesAndOCs, String amOrgName, String amsdkDN)MapgetAttributes(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN)MapgetAttributes(SSOToken token, IdType type, String name, Set attrNames, String amOrgName, String amsdkDN, boolean isString)MapgetBinaryServiceAttributes(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN)SetgetFullyQualifiedNames(SSOToken token, IdType type, String name, String orgName)SetgetMembers(SSOToken token, IdType type, String name, String amOrgName, IdType membersType, String amsdkDN)SetgetMemberships(SSOToken token, IdType type, String name, IdType membershipType, String amOrgName, String amsdkDN)MapgetServiceAttributes(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN)MapgetServiceAttributesAscending(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN)Non-javadoc, non-public methods Get the service attributes of the name identity.IdSearchResultsgetSpecialIdentities(SSOToken token, IdType type, String orgName)SetgetSupportedOperations(SSOToken token, IdType type, String amOrgName)SetgetSupportedTypes(SSOToken token, String amOrgName)booleanisActive(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN)booleanisExists(SSOToken token, IdType type, String name, String amOrgName)voidmodifyMemberShip(SSOToken token, IdType type, String name, Set members, IdType membersType, int operation, String amOrgName)voidmodifyService(SSOToken token, IdType type, String name, String serviceName, SchemaType stype, Map attrMap, String amOrgName, String amsdkDN)voidreinitialize()voidreloadIdRepoServiceSchema()voidremoveAttributes(SSOToken token, IdType type, String name, Set attrNames, String amOrgName, String amsdkDN)IdSearchResultssearch(SSOToken token, IdType type, IdSearchControl ctrl, String amOrgName, CrestQuery crestQuery)By passing in a CrestQuery object, we now support searching by id (via _queryId) or by filter (_queryFilter).voidsetActiveStatus(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN, boolean active)voidsetAttributes(SSOToken token, IdType type, String name, Map attributes, boolean isAdd, String amOrgName, String amsdkDN, boolean isString)voidunassignService(SSOToken token, IdType type, String name, String serviceName, Map attrMap, String amOrgName, String amsdkDN)
-
-
-
Method Detail
-
authenticate
boolean authenticate(String orgName, Callback[] credentials) throws IdRepoException, AuthLoginException
Returnstrueif the data store has successfully authenticated the identity with the specific type and provided credentials. In case the data store requires additional credentials, the list would be returned via theIdRepoExceptionexception.- Parameters:
orgName- realm name to which the identity would be authenticatedcredentials- Array of callback objects containing information such as username and password.- Returns:
trueif data store authenticates the identity; elsefalse- Throws:
IdRepoExceptionAuthLoginException
-
authenticate
boolean authenticate(String orgName, Callback[] credentials, IdType idType) throws IdRepoException, AuthLoginException
Returnstrueif the data store has successfully authenticated the identity with the specific type and provided credentials. In case the data store requires additional credentials, the list would be returned via theIdRepoExceptionexception.- Parameters:
orgName- realm name to which the identity would be authenticatedcredentials- Array of callback objects containing information such as username and password.idType- The type of identity, or null for any.- Returns:
trueif data store authenticates the identity; elsefalse- Throws:
IdRepoExceptionAuthLoginException
-
create
AMIdentity create(SSOToken token, IdType type, String name, Map attrMap, String amOrgName) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
delete
void delete(SSOToken token, IdType type, String name, String orgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getAttributes
Map getAttributes(SSOToken token, IdType type, String name, Set attrNames, String amOrgName, String amsdkDN, boolean isString) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getAttributes
Map getAttributes(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getMembers
Set getMembers(SSOToken token, IdType type, String name, String amOrgName, IdType membersType, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getMemberships
Set getMemberships(SSOToken token, IdType type, String name, IdType membershipType, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
isExists
boolean isExists(SSOToken token, IdType type, String name, String amOrgName) throws SSOException, IdRepoException
- Throws:
SSOExceptionIdRepoException
-
isActive
boolean isActive(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN) throws SSOException, IdRepoException
- Throws:
SSOExceptionIdRepoException
-
setActiveStatus
void setActiveStatus(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN, boolean active) throws SSOException, IdRepoException
- Throws:
SSOExceptionIdRepoException
-
modifyMemberShip
void modifyMemberShip(SSOToken token, IdType type, String name, Set members, IdType membersType, int operation, String amOrgName) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
removeAttributes
void removeAttributes(SSOToken token, IdType type, String name, Set attrNames, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
search
IdSearchResults search(SSOToken token, IdType type, IdSearchControl ctrl, String amOrgName, CrestQuery crestQuery) throws IdRepoException, SSOException
By passing in a CrestQuery object, we now support searching by id (via _queryId) or by filter (_queryFilter).- Parameters:
token- is the sso token of the person performing this operation.type- is the identity type of the name parameter.ctrl- the search controlamOrgName- is the orgname.crestQuery- encapsulates _queryId or _queryFilter from the CREST endpoint.- Throws:
IdRepoException- if there are repository related error conditions.SSOException- if user's single sign on token is invalid.
-
setAttributes
void setAttributes(SSOToken token, IdType type, String name, Map attributes, boolean isAdd, String amOrgName, String amsdkDN, boolean isString) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
changePassword
void changePassword(SSOToken token, IdType type, String name, String oldPassword, String newPassword, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getAssignedServices
Set getAssignedServices(SSOToken token, IdType type, String name, Map mapOfServiceNamesAndOCs, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
assignService
void assignService(SSOToken token, IdType type, String name, String serviceName, SchemaType stype, Map attrMap, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
unassignService
void unassignService(SSOToken token, IdType type, String name, String serviceName, Map attrMap, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getServiceAttributes
Map getServiceAttributes(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getBinaryServiceAttributes
Map getBinaryServiceAttributes(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getServiceAttributesAscending
Map getServiceAttributesAscending(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
Non-javadoc, non-public methods Get the service attributes of the name identity. Traverse to the global configuration if necessary until all attributes are found or reached the global area whichever occurs first.- Parameters:
token- is the sso token of the person performing this operation.type- is the identity type of the name parameter.name- is the identity we are interested in.serviceName- is the service we are interested inattrNames- are the name of the attributes wer are interested in.amOrgName- is the orgname.amsdkDN- is the amsdkDN.- Throws:
IdRepoException- if there are repository related error conditions.SSOException- if user's single sign on token is invalid.
-
modifyService
void modifyService(SSOToken token, IdType type, String name, String serviceName, SchemaType stype, Map attrMap, String amOrgName, String amsdkDN) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getSupportedTypes
Set getSupportedTypes(SSOToken token, String amOrgName) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getSupportedOperations
Set getSupportedOperations(SSOToken token, IdType type, String amOrgName) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
clearIdRepoPlugins
void clearIdRepoPlugins()
-
reloadIdRepoServiceSchema
void reloadIdRepoServiceSchema()
-
reinitialize
void reinitialize()
-
getFullyQualifiedNames
Set getFullyQualifiedNames(SSOToken token, IdType type, String name, String orgName) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
getSpecialIdentities
IdSearchResults getSpecialIdentities(SSOToken token, IdType type, String orgName) throws IdRepoException, SSOException
- Throws:
IdRepoExceptionSSOException
-
-