Skip navigation links

Oracle Fusion Middleware Configuration MBean Java API Reference for Oracle Identity Federation
11g Release 1 (11.1.1)

E14683-01


oracle.security.fed.admin.config.mbeans
Interface SearchMXBean


public interface SearchMXBean

Runtime MBean to manage user and federation record search operations.

A search over user or federation records requires the following parameters:

This MBean exposes two types of search operations: simple, and advanced. Advanced operations require the caller to provide all of the above parameters. Simple operations only require the caller to provide the value to be searched for; the other parameters are retrieved from the Oracle Identity Federation configuration. The operator used in this case is 'or', and a search condition is created for each default search attribute in configuration with the comparator 'contains', and the value given.

When performing a search, the search results will be returned in a String[][], formatted as follows. The first row contains the names of the attributes that were retrieved from each user or federation record entry. Each following row represents an entry satisfying the search conditions. The value of an attribute in a specific entry can be found at the same index in that entry as the corresponding attribute in the first row. Rows are sorted in descending order according to the specified attribute to sort on.

Example: Suppose that the attributes to be retrieved are: "User ID", "Email Address", "First Name", and "Last Name", and that the following users are the only ones satisfying the search conditions.

Further suppose that the attribute to sort on is "User ID". The returned String[][], results, will be such that:

<it>Note:</it> The order of the returned attibutes is not guaranteed. The following String[][] would also be a valid return value:

Special Attributes: In a federation record search, the attribute 'fedid_id', corresponding to the Fed ID of the federation record, will always be returned in the search results. In a user search, the attribute specified as the "User ID Attribute" in the Oracle Identity Federation configuration of the user datastore, will always be returned in the search results.

Since:
11.1.1.1.0

Method Summary
 boolean checkAttributeExistsInDatastore(java.lang.String attribute)
          Returns true if the given attribute is defined in the configured user datastore; false otherwise.
 java.lang.String[][] performFedSearch(java.lang.String[][] conditions, java.lang.String operator, java.lang.String[] attrsToRetrieve, java.lang.String attrToSortOn, boolean includeAddtlSearchAttrs, java.lang.String providerID)
          Performs a search over all federation records from the provider with the given Provider ID, based on the concatenation of the specified search conditions.
 java.lang.String[][] performFedSearch(java.lang.String value, java.lang.String providerID)
          Performs a search over all federation records from the provider with the given Provider ID, based on the value given; will use 'CONTAINS' as comparator and 'OR' as operator and the default search and display attributes
 java.lang.String[][] performFedSearch(java.lang.String value, java.lang.String userID, java.lang.String providerID)
          Performs a search over all federation records for the user with the given User ID and the provider with the given Provider ID, based on the value given; will use 'CONTAINS' as comparator and 'OR' as operator and the default search and display attributes
 java.lang.String[][] performUserFedSearch(java.lang.String value, java.lang.String userID)
          Performs a search over all federation records for the user with the given User ID, based on the value given; will use 'CONTAINS' as comparator and 'OR' as operator and the default search and display attributes
 java.lang.String[][] performUserSearch(java.lang.String value)
          Performs a user search based on the value given; will use 'CONTAINS' as comparator and 'OR' as operator and the default search and display attributes
 java.lang.String[][] performUserSearch(java.lang.String[][] conditions, java.lang.String operator, java.lang.String[] attrsToRetrieve, java.lang.String attrToSortOn)
          Performs a user search based on the concatenation of the specified search conditions.
 java.lang.String[] retrieveAllDisplayFedAttributes()
          Returns all attributes that can be used as display attributes in a federation record search
 java.lang.String[] retrieveAllDisplayUserAttributes()
          Returns all attributes that can be used as display attributes in a user search.
 java.lang.String[] retrieveAllSearchFedAttributes()
          Returns all attributes that can be used as search attributes in a federation record search
 java.lang.String[] retrieveAllSearchUserAttributes()
          Returns all attributes that can be used as search attributes in a user search.

 

Method Detail

performUserSearch

java.lang.String[][] performUserSearch(java.lang.String value)
Performs a user search based on the value given; will use 'CONTAINS' as comparator and 'OR' as operator and the default search and display attributes
Parameters:
value - The value to be searched for
Returns:
A String[][] containing the user entries that satisfy the search conditions, formatted as described above.

performUserSearch

java.lang.String[][] performUserSearch(java.lang.String[][] conditions,
                                       java.lang.String operator,
                                       java.lang.String[] attrsToRetrieve,
                                       java.lang.String attrToSortOn)
Performs a user search based on the concatenation of the specified search conditions.
Parameters:
conditions - A list of search conditions that must be of the form {attribute name, comparator, value}.
operator - Operator to concatenate search conditions. Must be one of: 'and', 'or'.
attrsToRetrieve - A list of attributes to be retrieved from the datastore.
attrToSortOn - The name of the attribute that will be used to sort the resulting user entries.
Returns:
A String[][] containing the user entries that satisfy the search conditions, formatted as described above.

performFedSearch

java.lang.String[][] performFedSearch(java.lang.String value,
                                      java.lang.String providerID)
Performs a search over all federation records from the provider with the given Provider ID, based on the value given; will use 'CONTAINS' as comparator and 'OR' as operator and the default search and display attributes
Parameters:
value - The value to be searched for
providerID - The provider ID of the provider over whose records the search is to be performed
Returns:
A String[][] containing the user entries that satisfy the search conditions, formatted as described above.

performFedSearch

java.lang.String[][] performFedSearch(java.lang.String value,
                                      java.lang.String userID,
                                      java.lang.String providerID)
Performs a search over all federation records for the user with the given User ID and the provider with the given Provider ID, based on the value given; will use 'CONTAINS' as comparator and 'OR' as operator and the default search and display attributes
Parameters:
value - The value to be searched for
userID - The User ID of the user over whose records the search is to be performed
providerID - The Provider ID of the provider over whose records the search is to be performed
Returns:
A String[][] containing the user entries that satisfy the search conditions, formatted as described above.

performFedSearch

java.lang.String[][] performFedSearch(java.lang.String[][] conditions,
                                      java.lang.String operator,
                                      java.lang.String[] attrsToRetrieve,
                                      java.lang.String attrToSortOn,
                                      boolean includeAddtlSearchAttrs,
                                      java.lang.String providerID)
Performs a search over all federation records from the provider with the given Provider ID, based on the concatenation of the specified search conditions.
Parameters:
conditions - A list of search conditions that must be of the form {attribute name, comparator, value}.
operator - Operator to concatenate search conditions. Must be one of: 'and', 'or'.
attrsToRetrieve - A list of attributes to be retrieved from the datastore.
attrToSortOn - The name of the attribute that will be used to sort the resulting federation record entries.
includeAddtlSearchAttrs - Indicates whether 'old' and 'new' Name ID attributes should be included when their standard equivalents are specified.
providerID - The Provider ID of the provider over whose records the search is to be performed.
Returns:
A String[][] containing the user entries that satisfy the search conditions, formatted as described above.

performUserFedSearch

java.lang.String[][] performUserFedSearch(java.lang.String value,
                                          java.lang.String userID)
Performs a search over all federation records for the user with the given User ID, based on the value given; will use 'CONTAINS' as comparator and 'OR' as operator and the default search and display attributes
Parameters:
value - The value to be searched for
userID - The User ID of the user over whose records the search is to be performed
Returns:
A String[][] containing the user entries that satisfy the search conditions, formatted as described above.

retrieveAllSearchFedAttributes

java.lang.String[] retrieveAllSearchFedAttributes()
Returns all attributes that can be used as search attributes in a federation record search
Returns:
all attributes that can be used as search attributes in a federation record search

retrieveAllSearchUserAttributes

java.lang.String[] retrieveAllSearchUserAttributes()
Returns all attributes that can be used as search attributes in a user search.
Returns:
all attributes that can be used as search attributes in a user search.

retrieveAllDisplayFedAttributes

java.lang.String[] retrieveAllDisplayFedAttributes()
Returns all attributes that can be used as display attributes in a federation record search
Returns:
all attributes that can be used as display attributes in a federation record search

retrieveAllDisplayUserAttributes

java.lang.String[] retrieveAllDisplayUserAttributes()
Returns all attributes that can be used as display attributes in a user search.
Returns:
all attributes that can be used as display attributes in a user search.

checkAttributeExistsInDatastore

boolean checkAttributeExistsInDatastore(java.lang.String attribute)
Returns true if the given attribute is defined in the configured user datastore; false otherwise. This operation is not supported in the case that the user datastore is an LDAP directory.
Parameters:
attribute - The attribute whose existance in the user datastore is to be determined
Returns:
Returns true if the given attribute is defined in the configured user datastore; false otherwise.
Throws:
java.lang.UnsupportedOperationException - if the user datastore is an LDAP directory.

Skip navigation links

Oracle Fusion Middleware Configuration MBean Java API Reference for Oracle Identity Federation
11g Release 1 (11.1.1)

E14683-01


Copyright © 2009, Oracle. All rights reserved.