com.sun.identity.entity

Interface EntityObjectIF

All Superinterfaces:

Remote

All Known Implementing Classes:

EntityObjectImpl

public interface EntityObjectIF
extends Remote

JAX-RPC interface for Entity Object and Services to make it remotable.

Method Summary

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

Method Detail

createEntity

Set createEntity(String ssoToken,
                 String entityName,
                 String entityType,
                 String entityLocation,
                 Map attributes)
          throws EntityException,
                 SSOException,
                 RemoteException

Creates entities.

Parameters:

ssoToken - String representing user's SSO Token.

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.

entityLocation - Location of the entity creation.eg.www.abc.com

attributes - Map to represent Attribute-Value Pairs

Returns:

Returns a set of Entity DNs created.

Throws:

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

SSOException - if the sign on is no longer valid

RemoteException

modifyEntity

void modifyEntity(String ssoToken,
                  String entityName,
                  String entityType,
                  String entityLocation,
                  Map attributes)
           throws EntityException,
                  SSOException,
                  RemoteException

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

Parameters:

ssoToken - User's Single Sign On Token.

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.

entityLocation - Location of the entity creation. example www.abc.com

Throws:

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

SSOException - if the sign on is no longer valid.

RemoteException

deleteEntity

void deleteEntity(String ssoToken,
                  String entityName,
                  String entityType,
                  String entityLocation)
           throws EntityException,
                  SSOException,
                  RemoteException

Deletes entities.

Parameters:

ssoToken - String representing user's SSO Token.

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.

entityLocation - Location of the entity creation.eg.www.abc.com

Throws:

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

SSOException - if the sign on is no longer valid

RemoteException

getEntity

Map getEntity(String ssoToken,
              String entityName,
              String entityType,
              String entityLocation)
       throws EntityException,
              SSOException,
              RemoteException

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

Parameters:

ssoToken - String representing user's SSO Token.

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.

entityLocation - Location of the entity creation.eg.www.abc.com

Returns:

Returns a 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

RemoteException

getEntityNames

Set getEntityNames(String ssoToken,
                   String entityType,
                   String entityLocation,
                   String entityFilter)
            throws EntityException,
                   SSOException,
                   RemoteException

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

Parameters:

ssoToken - String representing user's SSO Token.

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.

entityLocation - Location of the entity creation.eg.www.abc.com

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.

RemoteException