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

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)
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	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)
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	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)
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)

Method Detail

authenticate

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

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.

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

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

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.

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

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

Throws:

IdRepoException

SSOException

delete

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

Throws:

IdRepoException

SSOException

getAttributes

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

Throws:

IdRepoException

SSOException

getAttributes

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

Throws:

IdRepoException

SSOException

getMembers

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

Throws:

IdRepoException

SSOException

getMemberships

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

Throws:

IdRepoException

SSOException

isExists

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

Throws:

SSOException

IdRepoException

isActive

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

Throws:

SSOException

IdRepoException

setActiveStatus

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

Throws:

SSOException

IdRepoException

modifyMemberShip

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

Throws:

IdRepoException

SSOException

removeAttributes

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

Throws:

IdRepoException

SSOException

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

setAttributes

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

Throws:

IdRepoException

SSOException

changePassword

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

Throws:

IdRepoException

SSOException

getAssignedServices

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

Throws:

IdRepoException

SSOException

assignService

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

Throws:

IdRepoException

SSOException

unassignService

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

Throws:

IdRepoException

SSOException

getServiceAttributes

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

Throws:

IdRepoException

SSOException

getBinaryServiceAttributes

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

Throws:

IdRepoException

SSOException

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

modifyService

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

Throws:

IdRepoException

SSOException

getSupportedTypes

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

Throws:

IdRepoException

SSOException

getSupportedOperations

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

Throws:

IdRepoException

SSOException

clearIdRepoPlugins

void clearIdRepoPlugins()

clearIdRepoPlugins

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

reloadIdRepoServiceSchema

void reloadIdRepoServiceSchema()

reinitialize

void reinitialize()

getFullyQualifiedNames

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

Throws:

IdRepoException

SSOException

getSpecialIdentities

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

Throws:

IdRepoException

SSOException