|
BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This inteface is used to query ALES user related information. User names are specified in a qualified format which includes the identity directory they belong to. The format is //user/dirName/userName/. Directory name, as parameter of methods should also be specified in a qualified format with prefix //dir/. Example: //dir/myDir . Use EntitlementQueryFactory to obtain an instance of a UserQuery.
EntitlementQueryFactory
Field Summary | |
static int |
ATTRIBUTE_QUERY_TYPE_DIRECT
Attribute query type specifiying the attribute value assigned directly to the user. |
static int |
ATTRIBUTE_QUERY_TYPE_ENFORCED
Attribute query type specifiying the attribute value based on the attribute inheritance logic. |
static int |
ATTRIBUTE_QUERY_TYPE_INHERITED
Attribute query type specifiying the attribute value inherited by the user, from a group membership. |
Method Summary | |
java.util.List |
filter(java.lang.String findPattern)
Finds all users matching the specified filter pattern. |
java.util.List |
getAllGroups(java.lang.String userName)
Finds all groups the user is a member of. |
java.util.List |
getDirectGroups(java.lang.String userName)
Finds all direct group memberships for the specified user. |
java.util.List |
getIndirectGroups(java.lang.String userName)
Finds all indirect(inherited) group memberships for the specified user. |
AttributeElement |
getUserAttribute(java.lang.String userName,
java.lang.String attrName,
int attrQueryType)
Gets the value of an attribute associated with the specified user. |
java.util.List |
getUserAttributes(java.lang.String userName,
int attrQueryType)
Gets all attributes associated with the specified user. |
java.util.List |
getUsersWithAttribute(java.lang.String dirName,
AttributeElement attrElem)
Finds all users with the specified directory name and attribute value. |
Field Detail |
public static final int ATTRIBUTE_QUERY_TYPE_DIRECT
public static final int ATTRIBUTE_QUERY_TYPE_INHERITED
public static final int ATTRIBUTE_QUERY_TYPE_ENFORCED
Method Detail |
public java.util.List filter(java.lang.String findPattern) throws QueryException
findPattern
- pattern for the filterpublic java.util.List getUsersWithAttribute(java.lang.String dirName, AttributeElement attrElem) throws QueryException
dirName
- directory nameattrElem
- the attribute name and valuepublic java.util.List getAllGroups(java.lang.String userName) throws QueryException
userName
- an user to be reported onpublic java.util.List getDirectGroups(java.lang.String userName) throws QueryException
userName
- an user to be reported onpublic java.util.List getIndirectGroups(java.lang.String userName) throws QueryException
userName
- an user to be reported onpublic AttributeElement getUserAttribute(java.lang.String userName, java.lang.String attrName, int attrQueryType) throws QueryException
userName
- the user nameattrName
- the attribute nameattrQueryType
- ATTRIBUTE_QUERY_TYPE_DIRECT, ATTRIBUTE_QUERY_TYPE_INHERITED, ATTRIBUTE_QUERY_TYPE_ENFORCED
AttributeElement
containing the value of the user's attribute, or null
if this attribute is not defined for the specified user.ATTRIBUTE_QUERY_TYPE_DIRECT
,
ATTRIBUTE_QUERY_TYPE_INHERITED
,
ATTRIBUTE_QUERY_TYPE_ENFORCED
public java.util.List getUserAttributes(java.lang.String userName, int attrQueryType) throws QueryException
userName
- the user nameattrQueryType
- ATTRIBUTE_QUERY_TYPE_DIRECT,
ATTRIBUTE_QUERY_TYPE_INHERITED,
ATTRIBUTE_QUERY_TYPE_ENFORCED
ATTRIBUTE_QUERY_TYPE_DIRECT
,
ATTRIBUTE_QUERY_TYPE_INHERITED
,
ATTRIBUTE_QUERY_TYPE_ENFORCED
|
Documentation is available at http://edocs.bea.com/ales/docs30 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |