a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: IDPPContainer.java,v 1.2 2008/06/25 05:47:17 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.liberty.ws.idpp.plugin;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.idpp.common.IDPPException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The interface <code>IDPPContainer</code> provides a plugin for the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * IDPP containers. Each IDPP container needs to implement this interface
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * for those containers that the Personal profile supports.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Converts all the supported container values into an XML document.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param userMap user data map
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return Document XML representation of container.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception IDPPException.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public Document toXMLDocument(Map userMap) throws IDPPException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the supported container attributes.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return Set set of supported container attributes.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the container attributes for a select expression.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param select select string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return Set set of container attributes for the given select.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public Set getContainerAttributesForSelect(String select);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the data map for a given select and the data.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param select select expression.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param data list of new data objects.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return Map Attribute value pair for the given select and data.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception IDPPException.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public Map getDataMapForSelect(String select, List data)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Checks if the container has any binary attributes.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if any of the container attributes are binary.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the UserDN for the container that needs to be built by using
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * this user attributes.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param userDN User's DN.