com.soa.identity

Interface IdentitySource

public interface IdentitySource

This is the interface for browsering identity system. Each IdentitySource instance must be configured with a proxy user account, which will be used when the user cannot be determined from the context or when the user is from different domain who is allowed to browse the identity store according to the rules defined in PolicyManager.

Method Summary

Modifier and Type	Method and Description
IResultSet	getAllGroupsAssignedToUser(javax.security.auth.Subject subject, java.lang.String userName, IGroupSearchConstraint option) Get all the groups that a user belongs to.
IResultSet	getMembersInGroup(javax.security.auth.Subject subject, java.lang.String groupName, IUserSearchConstraint options) Get all the members in a group
javax.security.auth.Subject	getProxyUser() Create a new logging session with proxy user's credential.
boolean	isSortSupported()
void	releaseProxyUser(javax.security.auth.Subject subject) Application should call this method if the proxy user login session is not needed so that the Module Provider can release this resource associated with the login session.
IResultSet	searchGroups(javax.security.auth.Subject subject, IGroupFilter filter, IGroupSearchConstraint option) Search groups based on certain search criteria.
IResultSet	searchUsers(javax.security.auth.Subject subject, IUserFilter filter, IUserSearchConstraint option) Search users based on some search criteria

Method Detail

getProxyUser

javax.security.auth.Subject getProxyUser()
                                  throws AuthenticationException

Create a new logging session with proxy user's credential.

Returns:

the identity and login sessionof the proxy user.

Throws:

AuthenticationException

releaseProxyUser

void releaseProxyUser(javax.security.auth.Subject subject)

Application should call this method if the proxy user login session is not needed so that the Module Provider can release this resource associated with the login session.

Parameters:

subject - the proxy user's login session

searchUsers

IResultSet searchUsers(javax.security.auth.Subject subject,
                       IUserFilter filter,
                       IUserSearchConstraint option)
                throws GException

Search users based on some search criteria

Parameters:

subject - The user who initiate the search, it can be the proxy user also.

filter - Specify which users to search.

option - Specify page/sort option, and which attributes should be returned in the result

Returns:

List of IUserInfo objects

Throws:

GException

searchGroups

IResultSet searchGroups(javax.security.auth.Subject subject,
                        IGroupFilter filter,
                        IGroupSearchConstraint option)
                 throws GException

Search groups based on certain search criteria.

Parameters:

subject - The the user who initiate the search, it can be the proxy user also.

filter - Specify which groups to search.

option - Page/sort option and which attributes should be returned in the result

Returns:

List of IGroupInfo objects.

Throws:

GException

getAllGroupsAssignedToUser

IResultSet getAllGroupsAssignedToUser(javax.security.auth.Subject subject,
                                      java.lang.String userName,
                                      IGroupSearchConstraint option)
                               throws GException

Get all the groups that a user belongs to. If the identity store supports nested groups, then returned value must have all the nested groups also.

Parameters:

subject - The user who initiate the search

user - The user that the group information should be returned

Returns:

List of IGroupInfo objects.

Throws:

ConnectorException

GException

getMembersInGroup

IResultSet getMembersInGroup(javax.security.auth.Subject subject,
                             java.lang.String groupName,
                             IUserSearchConstraint options)
                      throws GException

Get all the members in a group

Parameters:

subject - The user who initiates the search

groupName -

options -

Returns:

List of IUserInfo or IGroupInfo object, depending on whether the identity system supports nested groups

Throws:

GException

isSortSupported

boolean isSortSupported()

Returns:

true is the IdentitySource support sorting entries.