Package com.sun.identity.idm.server

Class IdServicesImpl

java.lang.Object

com.sun.identity.idm.server.IdServicesImpl

All Implemented Interfaces:

IdServices

Direct Known Subclasses:

IdCachedServicesImpl

public class IdServicesImpl
extends Object
implements IdServices

Field Summary

Fields

Modifier and Type	Field	Description
protected static Debug	DEBUG
protected IdSearchResults	emptyUserIdentities
protected static boolean	shutdownCalled
protected IdSearchResults	specialIdentities
protected Set	specialIdentityNames

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IdServicesImpl()

Method Summary

Modifier and Type	Method	Description
void	assignService(SSOToken token, IdType type, String name, String serviceName, SchemaType stype, Map attrMap, String amOrgName, String amsdkDN)
boolean	authenticate(String orgName, Callback[] credentials)	Returns true if the data store has successfully authenticated the identity with the specific type and provided credentials.
boolean	authenticate(String orgName, Callback[] credentials, IdType idType)	Returns true if the data store has successfully authenticated the identity with the specific type and provided credentials.
void	changePassword(SSOToken token, IdType type, String name, String oldPassword, String newPassword, String amOrgName, String amsdkDN)
void	clearIdRepoPlugins()
void	clearIdRepoPlugins(String orgName, String serviceComponent, int type)
protected void	clearSpecialIdentityCache()
AMIdentity	create(SSOToken token, IdType type, String name, Map attrMap, String amOrgName)
void	delete(SSOToken token, IdType type, String name, String orgName, String amsdkDN)
Set<String>	getAssignedServices(SSOToken token, IdType type, String name, Map mapOfServiceNamesAndOCs, String amOrgName, String amsdkDN)
Map	getAttributes(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN)
Map	getAttributes(SSOToken token, IdType type, String name, Set attrNames, String amOrgName, String amsdkDN, boolean isString)
Map	getBinaryServiceAttributes(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN)
Set	getFullyQualifiedNames(SSOToken token, IdType type, String name, String orgName)	Returns the set of fully qualified names for the identity.
protected static IdServices	getInstance()
Set	getMembers(SSOToken token, IdType type, String name, String amOrgName, IdType membersType, String amsdkDN)
Set	getMemberships(SSOToken token, IdType type, String name, IdType membershipType, String amOrgName, String amsdkDN)
Map	getServiceAttributes(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN)
Map	getServiceAttributes(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN, boolean isString)
Map	getServiceAttributesAscending(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.
IdSearchResults	getSpecialIdentities(SSOToken token, IdType type, String orgName)
Set	getSupportedOperations(SSOToken token, IdType type, String amOrgName)
Set	getSupportedTypes(SSOToken token, String amOrgName)
boolean	isActive(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN)
boolean	isExists(SSOToken token, IdType type, String name, String amOrgName)
static boolean	isShutdownCalled()
protected boolean	isSpecialIdentity(SSOToken token, String name, IdType type, String orgName)
void	modifyMemberShip(SSOToken token, IdType type, String name, Set members, IdType membersType, int operation, String amOrgName)
void	modifyService(SSOToken token, IdType type, String name, String serviceName, SchemaType stype, Map attrMap, String amOrgName, String amsdkDN)
void	reinitialize()
void	reloadIdRepoServiceSchema()
void	removeAttributes(SSOToken token, IdType type, String name, Set attrNames, String amOrgName, String amsdkDN)
IdSearchResults	search(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).
void	setActiveStatus(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN, boolean active)
void	setAttributes(SSOToken token, IdType type, String name, Map attributes, boolean isAdd, String amOrgName, String amsdkDN, boolean isString)
void	unassignService(SSOToken token, IdType type, String name, String serviceName, Map attrMap, String amOrgName, String amsdkDN)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

protected static final Debug DEBUG

specialIdentityNames

protected Set specialIdentityNames

specialIdentities

protected IdSearchResults specialIdentities

emptyUserIdentities

protected IdSearchResults emptyUserIdentities

shutdownCalled

protected static volatile boolean shutdownCalled

Constructor Detail

IdServicesImpl

protected IdServicesImpl()

Method Detail

getInstance

protected static IdServices getInstance()

reinitialize

public void reinitialize()

Specified by:

reinitialize in interface IdServices

isShutdownCalled

public static boolean isShutdownCalled()

getFullyQualifiedNames

public Set getFullyQualifiedNames(SSOToken token,
                                  IdType type,
                                  String name,
                                  String orgName)
                           throws IdRepoException,
                                  SSOException

Returns the set of fully qualified names for the identity. The fully qualified names would be unique for a given datastore.

Specified by:

getFullyQualifiedNames in interface IdServices

Parameters:

token - SSOToken that can be used by the datastore to determine the fully qualified name

type - type of the identity

name - name of the identity

Returns:

fully qualified names for the identity

Throws:

IdRepoException - If there are repository related error conditions

SSOException - If identity's single sign on token is invalid

authenticate

public boolean authenticate(String orgName,
                            Callback[] credentials)
                     throws IdRepoException,
                            AuthLoginException

Description copied from interface: IdServices

Returns true if 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 the IdRepoException exception.

Specified by:

authenticate in interface IdServices

Parameters:

orgName - realm name to which the identity would be authenticated

credentials - Array of callback objects containing information such as username and password.

Returns:

true if data store authenticates the identity; else false

Throws:

IdRepoException

AuthLoginException

authenticate

public boolean authenticate(String orgName,
                            Callback[] credentials,
                            IdType idType)
                     throws IdRepoException,
                            AuthLoginException

Description copied from interface: IdServices

Returns true if 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 the IdRepoException exception.

Specified by:

authenticate in interface IdServices

Parameters:

orgName - realm name to which the identity would be authenticated

credentials - Array of callback objects containing information such as username and password.

idType - The type of identity, or null for any.

Returns:

true if data store authenticates the identity; else false

Throws:

IdRepoException

AuthLoginException

create

public AMIdentity create(SSOToken token,
                         IdType type,
                         String name,
                         Map attrMap,
                         String amOrgName)
                  throws IdRepoException,
                         SSOException

Specified by:

create in interface IdServices

Throws:

IdRepoException

SSOException

delete

public void delete(SSOToken token,
                   IdType type,
                   String name,
                   String orgName,
                   String amsdkDN)
            throws IdRepoException,
                   SSOException

Specified by:

delete in interface IdServices

Throws:

IdRepoException

SSOException

getAttributes

public Map getAttributes(SSOToken token,
                         IdType type,
                         String name,
                         Set attrNames,
                         String amOrgName,
                         String amsdkDN,
                         boolean isString)
                  throws IdRepoException,
                         SSOException

Specified by:

getAttributes in interface IdServices

Throws:

IdRepoException

SSOException

getAttributes

public Map getAttributes(SSOToken token,
                         IdType type,
                         String name,
                         String amOrgName,
                         String amsdkDN)
                  throws IdRepoException,
                         SSOException

Specified by:

getAttributes in interface IdServices

Throws:

IdRepoException

SSOException

getMembers

public Set getMembers(SSOToken token,
                      IdType type,
                      String name,
                      String amOrgName,
                      IdType membersType,
                      String amsdkDN)
               throws IdRepoException,
                      SSOException

Specified by:

getMembers in interface IdServices

Throws:

IdRepoException

SSOException

getMemberships

public Set getMemberships(SSOToken token,
                          IdType type,
                          String name,
                          IdType membershipType,
                          String amOrgName,
                          String amsdkDN)
                   throws IdRepoException,
                          SSOException

Specified by:

getMemberships in interface IdServices

Throws:

IdRepoException

SSOException

isExists

public boolean isExists(SSOToken token,
                        IdType type,
                        String name,
                        String amOrgName)
                 throws SSOException,
                        IdRepoException

Specified by:

isExists in interface IdServices

Throws:

SSOException

IdRepoException

isActive

public boolean isActive(SSOToken token,
                        IdType type,
                        String name,
                        String amOrgName,
                        String amsdkDN)
                 throws SSOException,
                        IdRepoException

Specified by:

isActive in interface IdServices

Throws:

SSOException

IdRepoException

setActiveStatus

public void setActiveStatus(SSOToken token,
                            IdType type,
                            String name,
                            String amOrgName,
                            String amsdkDN,
                            boolean active)
                     throws SSOException,
                            IdRepoException

Specified by:

setActiveStatus in interface IdServices

Throws:

SSOException

IdRepoException

modifyMemberShip

public void modifyMemberShip(SSOToken token,
                             IdType type,
                             String name,
                             Set members,
                             IdType membersType,
                             int operation,
                             String amOrgName)
                      throws IdRepoException,
                             SSOException

Specified by:

modifyMemberShip in interface IdServices

Throws:

IdRepoException

SSOException

removeAttributes

public void removeAttributes(SSOToken token,
                             IdType type,
                             String name,
                             Set attrNames,
                             String amOrgName,
                             String amsdkDN)
                      throws IdRepoException,
                             SSOException

Specified by:

removeAttributes in interface IdServices

Throws:

IdRepoException

SSOException

search

public IdSearchResults search(SSOToken token,
                              IdType type,
                              IdSearchControl ctrl,
                              String amOrgName,
                              CrestQuery crestQuery)
                       throws IdRepoException,
                              SSOException

Description copied from interface: IdServices

By passing in a CrestQuery object, we now support searching by id (via _queryId) or by filter (_queryFilter).

Specified by:

search in interface IdServices

Parameters:

token - is the sso token of the person performing this operation.

type - is the identity type of the name parameter.

ctrl - the search control

amOrgName - 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.

getSpecialIdentities

public IdSearchResults getSpecialIdentities(SSOToken token,
                                            IdType type,
                                            String orgName)
                                     throws IdRepoException,
                                            SSOException

Specified by:

getSpecialIdentities in interface IdServices

Throws:

IdRepoException

SSOException

isSpecialIdentity

protected boolean isSpecialIdentity(SSOToken token,
                                    String name,
                                    IdType type,
                                    String orgName)
                             throws IdRepoException,
                                    SSOException

Throws:

IdRepoException

SSOException

setAttributes

public void setAttributes(SSOToken token,
                          IdType type,
                          String name,
                          Map attributes,
                          boolean isAdd,
                          String amOrgName,
                          String amsdkDN,
                          boolean isString)
                   throws IdRepoException,
                          SSOException

Specified by:

setAttributes in interface IdServices

Throws:

IdRepoException

SSOException

changePassword

public void changePassword(SSOToken token,
                           IdType type,
                           String name,
                           String oldPassword,
                           String newPassword,
                           String amOrgName,
                           String amsdkDN)
                    throws IdRepoException,
                           SSOException

Specified by:

changePassword in interface IdServices

Throws:

IdRepoException

SSOException

getAssignedServices

public Set<String> getAssignedServices(SSOToken token,
                                       IdType type,
                                       String name,
                                       Map mapOfServiceNamesAndOCs,
                                       String amOrgName,
                                       String amsdkDN)
                                throws IdRepoException,
                                       SSOException

Specified by:

getAssignedServices in interface IdServices

Throws:

IdRepoException

SSOException

assignService

public void assignService(SSOToken token,
                          IdType type,
                          String name,
                          String serviceName,
                          SchemaType stype,
                          Map attrMap,
                          String amOrgName,
                          String amsdkDN)
                   throws IdRepoException,
                          SSOException

Specified by:

assignService in interface IdServices

Throws:

IdRepoException

SSOException

unassignService

public void unassignService(SSOToken token,
                            IdType type,
                            String name,
                            String serviceName,
                            Map attrMap,
                            String amOrgName,
                            String amsdkDN)
                     throws IdRepoException,
                            SSOException

Specified by:

unassignService in interface IdServices

Throws:

IdRepoException

SSOException

getServiceAttributesAscending

public 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.

Specified by:

getServiceAttributesAscending in interface IdServices

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 in

attrNames - 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.

getServiceAttributes

public Map getServiceAttributes(SSOToken token,
                                IdType type,
                                String name,
                                String serviceName,
                                Set attrNames,
                                String amOrgName,
                                String amsdkDN)
                         throws IdRepoException,
                                SSOException

Specified by:

getServiceAttributes in interface IdServices

Throws:

IdRepoException

SSOException

getBinaryServiceAttributes

public Map getBinaryServiceAttributes(SSOToken token,
                                      IdType type,
                                      String name,
                                      String serviceName,
                                      Set attrNames,
                                      String amOrgName,
                                      String amsdkDN)
                               throws IdRepoException,
                                      SSOException

Specified by:

getBinaryServiceAttributes in interface IdServices

Throws:

IdRepoException

SSOException

getServiceAttributes

public Map getServiceAttributes(SSOToken token,
                                IdType type,
                                String name,
                                String serviceName,
                                Set attrNames,
                                String amOrgName,
                                String amsdkDN,
                                boolean isString)
                         throws IdRepoException,
                                SSOException

Throws:

IdRepoException

SSOException

modifyService

public void modifyService(SSOToken token,
                          IdType type,
                          String name,
                          String serviceName,
                          SchemaType stype,
                          Map attrMap,
                          String amOrgName,
                          String amsdkDN)
                   throws IdRepoException,
                          SSOException

Specified by:

modifyService in interface IdServices

Throws:

IdRepoException

SSOException

getSupportedTypes

public Set getSupportedTypes(SSOToken token,
                             String amOrgName)
                      throws IdRepoException,
                             SSOException

Specified by:

getSupportedTypes in interface IdServices

Throws:

IdRepoException

SSOException

getSupportedOperations

public Set getSupportedOperations(SSOToken token,
                                  IdType type,
                                  String amOrgName)
                           throws IdRepoException,
                                  SSOException

Specified by:

getSupportedOperations in interface IdServices

Throws:

IdRepoException

SSOException

clearSpecialIdentityCache

protected void clearSpecialIdentityCache()

clearIdRepoPlugins

public void clearIdRepoPlugins()

Specified by:

clearIdRepoPlugins in interface IdServices

clearIdRepoPlugins

public void clearIdRepoPlugins(String orgName,
                               String serviceComponent,
                               int type)

Specified by:

clearIdRepoPlugins in interface IdServices

reloadIdRepoServiceSchema

public void reloadIdRepoServiceSchema()

Specified by:

reloadIdRepoServiceSchema in interface IdServices