|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.idm.IdRepo
This interface defines the methods which need to be implemented by identity repository plugins.
Field Summary | |
static int |
ADDMEMBER
The constant defining the add membership operation. |
static int |
AND_MOD
Specifies an AND condition filter. |
java.util.Map |
configMap
The plugin's configuration info. |
static int |
NO_MOD
Specifies a null filter. |
static int |
OR_MOD
Specifies an OR condition filter. |
static int |
REMOVEMEMBER
The constant defining the remove membership operation. |
Constructor Summary | |
IdRepo()
|
Method Summary | |
abstract int |
addListener(SSOToken token,
com.sun.identity.idm.IdRepoListener listener)
Adds a listener for changes in the repository |
abstract void |
assignService(SSOToken token,
IdType type,
java.lang.String name,
java.lang.String serviceName,
SchemaType stype,
java.util.Map attrMap)
This method is used to assign a service to the given identity. |
boolean |
authenticate(javax.security.auth.callback.Callback[] credentials)
Returns true if the data store successfully authenticates
the identity with the provided credentials. |
abstract java.lang.String |
create(SSOToken token,
IdType type,
java.lang.String name,
java.util.Map attrMap)
Creates an identity. |
abstract void |
delete(SSOToken token,
IdType type,
java.lang.String name)
Deletes an identity. |
abstract java.util.Set |
getAssignedServices(SSOToken token,
IdType type,
java.lang.String name,
java.util.Map mapOfServicesAndOCs)
Returns the set of services assigned to this identity. |
abstract java.util.Map |
getAttributes(SSOToken token,
IdType type,
java.lang.String name)
Returns all attributes and values of name object |
abstract java.util.Map |
getAttributes(SSOToken token,
IdType type,
java.lang.String name,
java.util.Set attrNames)
Returns requested attributes and values of name object. |
abstract java.util.Map |
getBinaryAttributes(SSOToken token,
IdType type,
java.lang.String name,
java.util.Set attrNames)
Returns requested binary attributes as an array of bytes. |
java.util.Map |
getConfiguration()
Returns the configuration map. |
java.lang.String |
getFullyQualifiedName(SSOToken token,
IdType type,
java.lang.String name)
Returns the fully qualified name for the identity. |
abstract java.util.Set |
getMembers(SSOToken token,
IdType type,
java.lang.String name,
IdType membersType)
Returns members of an identity. |
abstract java.util.Set |
getMemberships(SSOToken token,
IdType type,
java.lang.String name,
IdType membershipType)
Returns the memberships of an identity. |
abstract java.util.Map |
getServiceAttributes(SSOToken token,
IdType type,
java.lang.String name,
java.lang.String serviceName,
java.util.Set attrNames)
Returns the attribute values of the service attributes. |
java.util.Set |
getSupportedOperations(IdType type)
Returns supported operations for a given IdType |
java.util.Set |
getSupportedTypes()
Returns the supported types of identities for this plugin. |
void |
initialize(java.util.Map configParams)
initialization method. |
boolean |
isActive(SSOToken token,
IdType type,
java.lang.String name)
Returns true if the name object is active. |
abstract boolean |
isExists(SSOToken token,
IdType type,
java.lang.String name)
Returns true if the name object exists in the data store. |
abstract void |
modifyMemberShip(SSOToken token,
IdType type,
java.lang.String name,
java.util.Set members,
IdType membersType,
int operation)
Modify membership of the identity. |
abstract void |
modifyService(SSOToken token,
IdType type,
java.lang.String name,
java.lang.String serviceName,
SchemaType sType,
java.util.Map attrMap)
Modifies the attribute values of the service attributes. |
abstract void |
removeAttributes(SSOToken token,
IdType type,
java.lang.String name,
java.util.Set attrNames)
Removes the attributes from the identity. |
abstract void |
removeListener()
Removes the listener added using the addListener
method. |
abstract com.sun.identity.idm.RepoSearchResults |
search(SSOToken token,
IdType type,
java.lang.String pattern,
int maxTime,
int maxResults,
java.util.Set returnAttrs,
boolean returnAllAttrs,
int filterOp,
java.util.Map avPairs,
boolean recursive)
Search for specific type of identities. |
abstract void |
setActiveStatus(SSOToken token,
IdType type,
java.lang.String name,
boolean active)
Sets the object's status to active . |
abstract void |
setAttributes(SSOToken token,
IdType type,
java.lang.String name,
java.util.Map attributes,
boolean isAdd)
Set the values of attributes of the identity. |
abstract void |
setBinaryAttributes(SSOToken token,
IdType type,
java.lang.String name,
java.util.Map attributes,
boolean isAdd)
Set the values of binary attributes the identity. |
void |
shutdown()
This method is invoked just before the plugin is removed from the IdRepo cache of plugins. |
boolean |
supportsAuthentication()
Returns true if the data store supports authentication
of identities. |
abstract void |
unassignService(SSOToken token,
IdType type,
java.lang.String name,
java.lang.String serviceName,
java.util.Map attrMap)
If the service is already assigned to the identity then this method unassigns the service and removes the related attributes from the entry. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int ADDMEMBER
public static final int REMOVEMEMBER
public java.util.Map configMap
public static final int OR_MOD
public static final int AND_MOD
public static final int NO_MOD
Constructor Detail |
public IdRepo()
Method Detail |
public void initialize(java.util.Map configParams)
configParams
- This plugin's configuration data.public void shutdown()
public java.util.Set getSupportedOperations(IdType type)
type
- Identity type
public java.util.Set getSupportedTypes()
public abstract boolean isExists(SSOToken token, IdType type, java.lang.String name) throws IdRepoException, SSOException
name
object exists in the data store.
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.
true
if name object is in data store
else false
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public boolean isActive(SSOToken token, IdType type, java.lang.String name) throws IdRepoException, SSOException
name
object is active.
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.
true
if name object is in active
else false
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void setActiveStatus(SSOToken token, IdType type, java.lang.String name, boolean active) throws IdRepoException, SSOException
active
.
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.active
- true if setting to active; false otherwise.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract java.util.Map getAttributes(SSOToken token, IdType type, java.lang.String name) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract java.util.Map getAttributes(SSOToken token, IdType type, java.lang.String name, java.util.Set attrNames) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.attrNames
- Set of attribute names to be read
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract java.util.Map getBinaryAttributes(SSOToken token, IdType type, java.lang.String name, java.util.Set attrNames) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.attrNames
- Set of attribute names to be read
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract java.lang.String create(SSOToken token, IdType type, java.lang.String name, java.util.Map attrMap) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.attrMap
- Map of attribute-values assoicated with this object.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void delete(SSOToken token, IdType type, java.lang.String name) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void setAttributes(SSOToken token, IdType type, java.lang.String name, java.util.Map attributes, boolean isAdd) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.attributes
- Map of attribute-values to set or add.isAdd
- if true
add the attribute-values; otherwise
replaces the attribute-values.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void setBinaryAttributes(SSOToken token, IdType type, java.lang.String name, java.util.Map attributes, boolean isAdd) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.attributes
- Map of binary attribute-values to set or add.isAdd
- if true
add the attribute-values; otherwise
replaces the attribute-values.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void removeAttributes(SSOToken token, IdType type, java.lang.String name, java.util.Set attrNames) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.attrNames
- Set of attribute names to remove.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract com.sun.identity.idm.RepoSearchResults search(SSOToken token, IdType type, java.lang.String pattern, int maxTime, int maxResults, java.util.Set returnAttrs, boolean returnAllAttrs, int filterOp, java.util.Map avPairs, boolean recursive) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.pattern
- pattern to search for.maxTime
- maximum wait time for search.maxResults
- maximum records to return.returnAttrs
- Set of attribute names to return.returnAllAttrs
- return all attributesfilterOp
- filter condition.avPairs
- additional search conditions.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void modifyMemberShip(SSOToken token, IdType type, java.lang.String name, java.util.Set members, IdType membersType, int operation) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.members
- Set of names to be added as members of namemembersType
- IdType of members.operation
- operations to perform on members ADDMEMBER or REMOVEMEMBER.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract java.util.Set getMembers(SSOToken token, IdType type, java.lang.String name, IdType membersType) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.membersType
- IdType of members of name object.
name
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract java.util.Set getMemberships(SSOToken token, IdType type, java.lang.String name, IdType membershipType) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.membershipType
- IdType of memberships to return.
name
is a member of.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void assignService(SSOToken token, IdType type, java.lang.String name, java.lang.String serviceName, SchemaType stype, java.util.Map attrMap) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.serviceName
- service to assignstype
- attrMap
- Map of attribute-values.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract java.util.Set getAssignedServices(SSOToken token, IdType type, java.lang.String name, java.util.Map mapOfServicesAndOCs) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.mapOfServicesAndOCs
-
name
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void unassignService(SSOToken token, IdType type, java.lang.String name, java.lang.String serviceName, java.util.Map attrMap) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.serviceName
- Service name to remove.attrMap
- Map of attribute-values to remove
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract java.util.Map getServiceAttributes(SSOToken token, IdType type, java.lang.String name, java.lang.String serviceName, java.util.Set attrNames) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.serviceName
- Name of service.attrNames
- Set of attribute names.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void modifyService(SSOToken token, IdType type, java.lang.String name, java.lang.String serviceName, SchemaType sType, java.util.Map attrMap) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.type
- Identity type of this object.name
- Name of the object of interest.serviceName
- Name of service.sType
- attrMap
- map of attribute-values.
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract int addListener(SSOToken token, com.sun.identity.idm.IdRepoListener listener) throws IdRepoException, SSOException
token
- Single sign on token of identity performing the task.listener
-
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public abstract void removeListener()
addListener
method. This is called by the IdRepo framework when the plugin
is being shutdown due to a configuration change, so that a
new instance can be created with the new configuration map.
public java.util.Map getConfiguration()
public java.lang.String getFullyQualifiedName(SSOToken token, IdType type, java.lang.String name) throws IdRepoException, SSOException
token
- administrator SSOToken that can be used by the datastore
to determine the fully qualified nametype
- type of the identityname
- name of the identity
IdRepoException
- If there are repository related error conditions.
SSOException
- If identity's single sign on token is invalid.public boolean supportsAuthentication()
true
if the data store supports authentication
of identities. Used by IdRepo framework to authenticate identities.
true
if data store supports authentication of
of identities; else false
public boolean authenticate(javax.security.auth.callback.Callback[] credentials) throws IdRepoException, AuthLoginException
true
if the data store successfully authenticates
the identity with the provided credentials. In case the data store
requires additional credentials, the list would be returned via the
IdRepoException
exception.
credentials
- Array of callback objects containing information
such as username and password.
true
if data store authenticates the identity;
else false
IdRepoException
AuthLoginException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |