identity/idm/IdSearchResults.java

8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * opensso/legal/CDDLv1.0.txt
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * at opensso/legal/CDDLv1.0.txt.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: IdSearchResults.java,v 1.4 2008/06/25 05:43:29 qcheng Exp $
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/*
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Portions Copyrighted [2011] [ForgeRock AS]
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpackage com.sun.identity.idm;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.util.HashMap;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.util.HashSet;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.util.Map;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.util.Set;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This class <code>IdSearchResults</code> provides to obtain the search
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * results.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.all.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpublic class IdSearchResults {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Code used to indicate a successful search
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public static final int SUCCESS = 0;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Code used to indicate that the search was unsuccessful as the size limit
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * exceeded during the search process.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public static final int SIZE_LIMIT_EXCEEDED = 1;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Code used to indicate that the search was unsuccessful as the time limit
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * exceeded during the search process.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public static final int TIME_LIMIT_EXCEEDED = 2;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    // Ordered set contain the result identities
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    protected Set searchResults = new HashSet();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    // Contains result of identities and the attributes requested as part
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    // of the search
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    protected Map resultsMap = new HashMap();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    protected int errorCode = SUCCESS;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    private IdType searchType;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    private String org;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public IdSearchResults(IdType type, String orgName) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        searchType = type;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        org = orgName;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Method which returns the search results as a map containing AMIdentity
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * objects as key and the attribute value String. The attribute value is a
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Set.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @return Map containing AMIdentity objects as the key and Maps of
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *         attribute-valuesof the attributes specified as part of the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *         search. The Maps contains attribute names as keys and Set
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *         containing values of those attributes. Returns an empty Map if no
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *         attributes were specified as part of search request.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public Map getResultAttributes() {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        return resultsMap;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Method which returns the search results as an ordered set.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @return Set of AMIdentity objects matching the search criteria
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public Set getSearchResults() {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        // return convertToIdentityObjects();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        return searchResults;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Method which returns the error code of search.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @return Error code of search. The possible values are
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *         <code>SUCCESS</code>, <code>SIZE_LIMIT_EXCEEDED</code> and
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *         <code>TIME_LIMIT_EXCEEDED</code>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @see #SUCCESS
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @see #SIZE_LIMIT_EXCEEDED
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @see #TIME_LIMIT_EXCEEDED
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public int getErrorCode() {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        return errorCode;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Adds an AMIdentity object to this search result.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @param id
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *            AMIdentity representing the entity.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @param attrs
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *            Map of attrbibutes obtained while performing the search
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public void addResult(AMIdentity id, Map attrs) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        searchResults.add(id);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        resultsMap.put(id, attrs);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Set the error code for this Search Result
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @param error
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *            Error code of Search Result.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @see #SUCCESS
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @see #SIZE_LIMIT_EXCEEDED
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @see #TIME_LIMIT_EXCEEDED
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public void setErrorCode(int error) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        errorCode = error;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    protected IdType getType() {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        return searchType;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    protected String getOrgName() {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        return org;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * Returns String representation of the <code>IdSearchResults</code> object.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * It returns identity names and attributes
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     * @return String representation of the <code>ServiceConfig</code> object.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster     */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    public String toString() {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        StringBuilder sb = new StringBuilder(200);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        sb.append("IdSearchResults:");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        sb.append("\n\tIdentities: ").append(searchResults);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        sb.append("\n\tAttributes: ").append(resultsMap);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster        return (sb.toString());
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster    }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster}