|
Oracle Fusion Middleware Identity Governance Framework Identity Directory Java API Reference 11g Release 1 (11.1.1) E39432-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.igf.ids.Entity
oracle.igf.ids.Group
public class Group
Class holding the list of attributes of the Group entity fetched using search or read methods. This Group entity class also holds the GroupManager handle and provides methods to modify attribute values in the repository and the methods for getting the related entities per the entity relationship definitions.
Method Summary | |
---|---|
void |
addMember(Group group, ModifyOptions opts) Adds the given group as a member to this group |
void |
addMember(User user, ModifyOptions opts) Adds the given user as a member to this group |
void |
addMemberOf(Group group, ModifyOptions opts) Adds this group as a member to input group |
void |
addOwner(Group group, ModifyOptions opts) Adds the given group as owner of this group |
void |
addOwner(User user, ModifyOptions opts) Adds the given user as owner of this group |
void |
addOwnerOf(Group group, ModifyOptions opts) Adds this group as owner of the given group |
Group |
clone() Clones this object |
void |
deleteMember(Group group, ModifyOptions opts) Deletes the input group as a member to this group |
void |
deleteMember(User user, ModifyOptions opts) Deletes the input user as a member to this group |
void |
deleteMemberOf(Group group, ModifyOptions opts) Deletes this group as a member to input group |
void |
deleteOwner(Group group, ModifyOptions opts) Deletes the given group as owner of this group |
void |
deleteOwner(User user, ModifyOptions opts) Deletes the given user as owner of this group |
void |
deleteOwnerOf(Group group, ModifyOptions opts) Deletes this group as owner of the given group |
ResultSet<Group> |
getMemberGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups that are members of this group matching the given filter condition |
ResultSet<Group> |
getMemberOfGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups this group is a member of and matching the given filter criteria |
ResultSet<User> |
getMembers(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the users that are members of this group matching the given filter condition |
ResultSet<User> |
getMembers(SearchFilter targetFilter, SearchOptions opts) Gets all the users that are members of this group matching the given filter condition. |
ResultSet<Group> |
getOwnedGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups owned by this group matching the given filter condition |
ResultSet<User> |
getOwners(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets owners of this group matching the given filter condition |
boolean |
isMember(Group group, boolean direct, ReadOptions opts) Checks if the input group is a member of this group |
boolean |
isMember(User user, boolean direct, ReadOptions opts) Checks if input user is a member of this group |
boolean |
isMember(User user, ReadOptions opts) Checks if input user is a member of this group. |
boolean |
isMemberOf(Group group, boolean direct, ReadOptions opts) Checks if this group is a member of the given group |
boolean |
isOwnerOf(Group group, boolean direct, ReadOptions opts) Checks if this group is owner of given group |
Methods inherited from class oracle.igf.ids.Entity |
---|
getAllAttributes, getAttribute, getAttributeLocaleValue, getAttributeValue, getCanonicalName, getEntityName, getGuid, getId, getName, getPrincipal, getRelatedEntities, getSubjectName, modify, setAttributeValue |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public ResultSet<Group> getMemberOfGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) throws IDSException, EntityNotFoundException, InvalidAttributesException, InvalidFilterException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels to be searched for the member of Groups recursively. 0 means all levels.targetFilter
- Filter criteria to be applied on the related entitiesopts
- Search optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the entity for which related entities to be fetched is not foundInvalidAttributesException
- If the requsted attributes or the attributes in the target search filter are invalidOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegesInvalidFilterException
public boolean isMember(Group group, boolean direct, ReadOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entitydirect
- if true checks only the direct memberhship otherwise checks all levels recursivelyopts
- Read optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the entity for which related entities to be fetched is not foundOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegespublic boolean isMember(User user, ReadOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
user
- User entityopts
- Read optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the entity for which related entities to be fetched is not foundAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public boolean isMember(User user, boolean direct, ReadOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
user
- User entitydirect
- if true checks only the direct memberhship otherwise checks all levels recursivelyopts
- Read optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the entity for which related entities to be fetched is not foundAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public void addMember(User user, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
user
- User entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity not foundOperationNotSupportedException
- If add member is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void addMember(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities not foundOperationNotSupportedException
- If add member is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteMember(User user, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
user
- User entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity not foundOperationNotSupportedException
- If delete member is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteMember(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities not foundOperationNotSupportedException
- If delete member is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void addMemberOf(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities not foundOperationNotSupportedException
- If add member of is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteMemberOf(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities not foundOperationNotSupportedException
- If delete member of is not supportedAuthorizationException
- If user does not have sufficient privilegespublic ResultSet<User> getMembers(SearchFilter targetFilter, SearchOptions opts) throws IDSException, EntityNotFoundException, InvalidAttributesException, InvalidFilterException, AuthorizationException, OperationNotSupportedException
targetFilter
- Filter condition to be applied on the resulting members of this groupopts
- Search otionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the group entity is not foundInvalidAttributesException
- If the requsted attributes or the attributes in the target search filter are invalidOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegesInvalidFilterException
public ResultSet<User> getMembers(int nLevels, SearchFilter targetFilter, SearchOptions opts) throws IDSException, EntityNotFoundException, InvalidAttributesException, InvalidFilterException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels the Members to be fetched recursively. 0 means all levels.targetFilter
- Filter condition to be applied on the resulting members of this groupopts
- Search otionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the group entity is not foundInvalidAttributesException
- If the requsted attributes or the attributes in the target search filter are invalidOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegesInvalidFilterException
public ResultSet<Group> getMemberGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) throws IDSException, EntityNotFoundException, InvalidAttributesException, InvalidFilterException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels the MemberGruops to be fetched recursively. 0 means all levels.targetFilter
- Filter condition to be applied on the resulting members of this groupopts
- Search otionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the group entity is not foundInvalidAttributesException
- If the requsted attributes or the attributes in the target search filter are invalidOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegesInvalidFilterException
public boolean isMemberOf(Group group, boolean direct, ReadOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entitydirect
- if true checks only the direct memberhship otherwise checks all levels recursivelyopts
- Read optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities is not foundOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegespublic ResultSet<User> getOwners(int nLevels, SearchFilter targetFilter, SearchOptions opts) throws IDSException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels to be searched recursively for the group ownership. 0 means all levels.targetFilter
- Filter condition to be applied on the resulting owners of this groupopts
- Search optionsIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegespublic ResultSet<Group> getOwnedGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) throws IDSException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels to be searched recursively for the group ownership. 0 means all levels.targetFilter
- Filter condition to be applied on the resulting owned groupsopts
- Search optionsIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegespublic boolean isOwnerOf(Group group, boolean direct, ReadOptions opts) throws IDSException, AuthorizationException, OperationNotSupportedException
group
- Group entitydirect
- if true checks only the direct ownership otherwise checks all levels recursivelyopts
- Read optionsIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If entity configuration does not support this methodAuthorizationException
- If user does not have sufficient privilegespublic void addOwner(User user, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
user
- User entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity not foundOperationNotSupportedException
- If add owner is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void addOwner(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities not foundOperationNotSupportedException
- If add owner is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteOwner(User user, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
user
- User entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity not foundOperationNotSupportedException
- If delete owner is not supportedAuthorizationException
- If user does not have sufficient privilegesInvalidAttributesException
public void deleteOwner(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities not foundOperationNotSupportedException
- If delete owner is not supportedAuthorizationException
- If user does not have sufficient privilegesInvalidAttributesException
public void addOwnerOf(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities not foundOperationNotSupportedException
- If add owner of is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteOwnerOf(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either of the group entities not foundOperationNotSupportedException
- If delete owner of is not supportedAuthorizationException
- If user does not have sufficient privilegesInvalidAttributesException
public Group clone()
clone
in class Entity
|
Oracle Fusion Middleware Identity Governance Framework Identity Directory Java API Reference 11g Release 1 (11.1.1) E39432-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |