oracle.igf.ids

Class OrgManager

java.lang.Object

oracle.igf.ids.AbstractEntityManager

oracle.igf.ids.OrgManager

public class OrgManager
extends AbstractEntityManager

Class for handling operations like read, create and search of org entity

Method Summary

Modifier and Type	Method and Description
java.security.Principal	createOrg(java.util.List<Attribute> attrVals, CreateOptions opts) Creates org in the repository with given list of attribute values
void	deleteOrg(java.security.Principal principal, DeleteOptions opts) Deletes the org from repository for given user principal
void	deleteOrg(java.lang.String id, DeleteOptions opts) Deletes the org from repository for given id attribute value
void	deleteOrg(java.lang.String attrName, java.lang.String attrVal, DeleteOptions opts) Deletes the org from repository for given unique attrname and value
EntityCapabilities	getCapabilities() Gets org entity capabilities
Org	getOrg(java.security.Principal principal, ReadOptions opts) Get org for the given principal identifier
Org	searchOrg(java.lang.String id, ReadOptions opts) Search for org matching given id attribute value that uniquely identifies the user
Org	searchOrg(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts) Finds org matching given attribute name and value
Org	searchOrgByGuid(java.lang.String guid, ReadOptions opts) Search for org matching given GUID value that uniquely identifies the org
ResultSet<Org>	searchOrgs(SearchFilter filter, SearchOptions opts) Searches the repository and returns list of org matching the given filter condition.

Methods inherited from class oracle.igf.ids.AbstractEntityManager

compareEntityAttr, compareEntityAttr, getAttributeDef, getAttributeRef, getEntityAttributes, getEntityDef, getEntityRelationships, getGlobalCommonIdAttribute, getIdAttribute, modify, modify, modify, rename

Methods inherited from class java.lang.Object

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

Method Detail

createOrg

public java.security.Principal createOrg(java.util.List<Attribute> attrVals,
                                         CreateOptions opts)
                                  throws IDSException,
                                         EntityAlreadyExistsException,
                                         OperationNotSupportedException,
                                         AuthorizationException,
                                         InvalidAttributesException

Creates org in the repository with given list of attribute values

Parameters:

attrVals - List of attribute values

opts - Create operation options

Returns:

Principal identifier of the gruop created

Throws:

IDSException - Generic Identity Directory Service exception

EntityAlreadyExistsException - When the org to be created already exists

OperationNotSupportedException - If the org create operation is not supported

InvalidAttributesException - When the add attributes list is invalid

AuthorizationException - If user does not have sufficient privileges

getOrg

public Org getOrg(java.security.Principal principal,
                  ReadOptions opts)
           throws EntityNotFoundException,
                  IDSException,
                  AuthorizationException,
                  InvalidAttributesException

Get org for the given principal identifier

Parameters:

principal - Principal identifier of the org

opts - Read operation options

Returns:

Org for the requested principal identifier

Throws:

EntityNotFoundException - When there is no org in the repository for given org principal

IDSException - Generic Identity Directory Service exception

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchOrg

public Org searchOrg(java.lang.String id,
                     ReadOptions opts)
              throws IDSException,
                     EntityNotFoundException,
                     EntityNotUniqueException,
                     AuthorizationException,
                     InvalidAttributesException

Search for org matching given id attribute value that uniquely identifies the user

Parameters:

id - Value of the org's id attribute

opts - Read operation options

Returns:

Org matching given ID value

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When there is no org found for given ID value

EntityNotUniqueException - When the given filter condition does not uniquely identify the org

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchOrg

public Org searchOrg(java.lang.String attrName,
                     java.lang.String attrVal,
                     ReadOptions opts)
              throws IDSException,
                     EntityNotFoundException,
                     EntityNotUniqueException,
                     InvalidFilterException,
                     AuthorizationException,
                     InvalidAttributesException

Finds org matching given attribute name and value

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Read operation options

Returns:

Org matching given search filter

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no org found for given search filter

EntityNotUniqueException - When the given filter condition does not uniquely identify the org

InvalidFilterException - If the attribute is invalid filter attribute

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchOrgByGuid

public Org searchOrgByGuid(java.lang.String guid,
                           ReadOptions opts)
                    throws IDSException,
                           EntityNotFoundException,
                           EntityNotUniqueException,
                           AuthorizationException,
                           InvalidAttributesException

Search for org matching given GUID value that uniquely identifies the org

Parameters:

guid - guid value of org

opts - Read operation options

Returns:

Org matching given GUID value

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When there is no org found for given GUID value

EntityNotUniqueException - When the given GUID values does not uniquely identify the org

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchOrgs

public ResultSet<Org> searchOrgs(SearchFilter filter,
                                 SearchOptions opts)
                          throws IDSException,
                                 InvalidFilterException,
                                 OperationNotSupportedException,
                                 AuthorizationException,
                                 InvalidAttributesException

Searches the repository and returns list of org matching the given filter condition. Pagesize, Sorting and other options can be specified in the search options.

Parameters:

filter - Search filter

opts - Search operation options

Returns:

Search results matching given filter

Throws:

IDSException - Generic Identity Directory Service exception

InvalidFilterException - When the input search filter is not valid

OperationNotSupportedException - When this user search operation is not supported

InvalidAttributesException - When the requested attributes or the attributes in the search filter are invalid

AuthorizationException - If user does not have sufficient privileges

deleteOrg

public void deleteOrg(java.security.Principal principal,
                      DeleteOptions opts)
               throws EntityNotFoundException,
                      IDSException,
                      AuthorizationException,
                      OperationNotSupportedException

Deletes the org from repository for given user principal

Parameters:

principal - Org principal

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no org in the repository for given org principal

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the org delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteOrg

public void deleteOrg(java.lang.String id,
                      DeleteOptions opts)
               throws EntityNotFoundException,
                      IDSException,
                      AuthorizationException,
                      OperationNotSupportedException

Deletes the org from repository for given id attribute value

Parameters:

id - id value

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no org in the repository for given id value

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the org delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteOrg

public void deleteOrg(java.lang.String attrName,
                      java.lang.String attrVal,
                      DeleteOptions opts)
               throws EntityNotFoundException,
                      IDSException,
                      AuthorizationException,
                      OperationNotSupportedException

Deletes the org from repository for given unique attrname and value

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no org in the repository for given org principal

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the org delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

getCapabilities

public EntityCapabilities getCapabilities()

Gets org entity capabilities

Returns:

org entity capabilities