FSAuthDomainsModel.java revision 4a2f0f0be43dfd4c1b490cbf3cc48b6ba6084b1c
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
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 * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
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 * $Id: FSAuthDomainsModel.java,v 1.3 2008/06/25 05:49:39 qcheng Exp $
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpackage com.sun.identity.console.federation.model;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport com.sun.identity.console.base.model.AMConsoleException;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport com.sun.identity.console.base.model.AMModel;
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * Attribute Name for Authenticaton Domain Description.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Attribute Name for Authenticaton Domain Description.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington * Attribute Name for Writer Service URL.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String TF_IDFF_WRITER_SERVICE_URL = "tfIDFFWriterServiceURL";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Attribute Name for Reader Service URL.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String TF_IDFF_READER_SERVICE_URL = "tfIDFFReaderServiceURL";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Attribute Name for Writer Service URL.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String TF_SAML2_WRITER_SERVICE_URL = "tfSAML2WriterServiceURL";
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * Attribute Name for Reader Service URL.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String TF_SAML2_READER_SERVICE_URL = "tfSAML2ReaderServiceURL";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Attribute Name for Authenticaton Domain Status.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String SINGLE_CHOICE_STATUS = "singleChoiceStatus";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Attribute Name for Authenticaton Domain realm.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String SINGLE_CHOICE_REALM = "singleChoiceShowMenu";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns authentication domains
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return authentication domains
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns a Set of COT descriptors
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return Set of COT descriptors
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Creates authentication domain.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param attrValues Map of attribute name to set of attribute values.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMConsoleException if authentication domain cannot be created.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster void createAuthenticationDomain(Map attrValues, Set providers)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Deletes authentication domains.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param realm
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param cotName Name of circle of trust
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMConsoleException if authentication domains cannot be deleted.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster void deleteAuthenticationDomain(String realm, String cotName)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns attribute values.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param realm
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param name Name of authentication domain.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return attribute values.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws FSAllianceManagementException if attribute values cannot be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Map getAttributeValues(String realm, String name)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Set attribute values.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param realm Realm of authentication domain.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param name Name of authentication domain.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param values Map of attribute name to value.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMConsoleException if attribute values cannot be set.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster void setAttributeValues(String realm, String name, Map values)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns a map of authentication domain attributes.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return Map of authentication domain attributes.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns a set of provider names.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param realm
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return a set of provider names.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMConsoleException if provider names cannot be obtained.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns a set of provider names under a authentication domain.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param realm
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param name Name of authentication domain.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return a set of provider names under a authentication domain.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMConsoleException if provider names cannot be obtained.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Set getTrustedProviderNames(String realm, String name)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Adds providers.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param realm realm of circle of trust
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param cotName Name of circle of trust
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param names Names provider to be added.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMConsoleException if provider cannot be added.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public void addProviders(String realm, String cotName, Collection names)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns realms that have names matching with a filter.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param base Base realm name for this search. null indicates root
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param filter Filter string.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return realms that have names matching with a filter.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMConsoleException if search fails.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns the realm associated with the given circle of trust.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param name circle of trust name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return realm where the circle of trust exists.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMConsoleException if search fails.