Package com.sun.identity.entity

Class EntityObject

java.lang.Object

com.sun.identity.entity.EntityObject

public class EntityObject
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected SOAPClient	client
protected String	entityLocation

Constructor Summary

Constructors

Constructor	Description
EntityObject(SSOToken token, String entityLocation)

Method Summary

Modifier and Type	Method	Description
Set	createEntity(String entityName, String entityType, Map attributes)	Creates entity.
void	deleteEntity(String entityName, String entityType)	Deletes entities.
Map	getEntity(String entityName, String entityType)	Returns the entity object for each entity given the entityType and entityName(s) in that particular organization.
Set	getEntityNames(String entityName, String entityType, String entityFilter)	Returns a set of Entity Names given the Entity Type for that particular organization.
void	modifyEntity(String entityName, String entityType, Map attributes)	Sets or replaces attribute values with the new values supplied and Stores the changes to directory server.

Methods inherited from class java.lang.Object

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

Field Detail

entityLocation

protected String entityLocation

client

protected SOAPClient client

Constructor Detail

EntityObject

public EntityObject(SSOToken token,
                    String entityLocation)
             throws EntityException

Throws:

EntityException

Method Detail

createEntity

public Set createEntity(String entityName,
                        String entityType,
                        Map attributes)
                 throws EntityException,
                        SSOException

Creates entity.

Parameters:

entityName - Name of the entity.eg.cn=websphereAgent.

entityType - Type of entity being created. eg. Agent The types supported by SDK are configured in the list of Managed Objects in the DAI service.

attributes - Map where the key is the name of the entity, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set of AMEntity objects created

Throws:

EntityException - if there is an internal error in the AM Store

SSOException - if the single sign on token is no longer valid

deleteEntity

public void deleteEntity(String entityName,
                         String entityType)
                  throws EntityException,
                         SSOException

Deletes entities.

Parameters:

entityName - Name of the entity.eg.cn=websphereAgent

entityType - Type of entity being created. eg. Agent The types supported by SDK are configured in the list of Managed Objects in the DAI service.

Throws:

EntityException - if there is an internal error in the AM Store

SSOException - if the sign on is no longer valid

getEntity

public Map getEntity(String entityName,
                     String entityType)
              throws EntityException,
                     SSOException

Returns the entity object for each entity given the entityType and entityName(s) in that particular organization.

Parameters:

entityName - Name of the entity. example cn=websphereAgent.

entityType - Type of entity being created. eg. Agent The types supported by SDK are configured in the list of Managed Objects in the DAI service.

Returns:

Set of Entity objects.

Throws:

EntityException - if there is an internal error in the AM Store.

SSOException - if the sign on is no longer valid.

getEntityNames

public Set getEntityNames(String entityName,
                          String entityType,
                          String entityFilter)
                   throws EntityException,
                          SSOException

Returns a set of Entity Names given the Entity Type for that particular organization.

Parameters:

entityName - Name of the entity. example cn=websphereAgent.

entityType - Type of entity being created. eg. Agent The types supported by SDK are configured in the list of Managed Objects in the DAI service.

entityFilter -

Returns:

Set of Entity Names.

Throws:

EntityException - if there is an internal error in the AM Store.

SSOException - if the sign on is no longer valid.

modifyEntity

public void modifyEntity(String entityName,
                         String entityType,
                         Map attributes)
                  throws EntityException,
                         SSOException

Sets or replaces attribute values with the new values supplied and Stores the changes to directory server.

Parameters:

entityName - Name of the entity. example cn=websphereAgent.

entityType - Type of entity being created. eg. Agent The types supported by SDK are configured in the list of Managed Objects in the DAI service.

attributes -

Throws:

EntityException - if there is an internal error in the AM Store.

SSOException - if the sign on is no longer valid.