SocialAuthNModel.java revision 3fc1b5e9b2ff286cd528a06154cc998198de1e70
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * The contents of this file are subject to the terms of the Common Development and
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Distribution License (the License). You may not use this file except in compliance with the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * specific language governing permission and limitations under the License.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * When distributing Covered Software, include this CDDL Header Notice in each file and include
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Header, with the fields enclosed by brackets [] replaced by your own identifying
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * information: "Portions copyright [year] [name of copyright owner]".
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Copyright 2014 ForgeRock AS.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenkimport com.sun.identity.console.base.model.AMConsoleException;
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenkimport com.sun.identity.console.base.model.AMModel;
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Model class for common tasks involved in configuring social authentication providers (Google, Facebook etc).
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @since 12.0.0
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenkpublic interface SocialAuthNModel extends AMModel {
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Get a set of all configured realms, sorted lexicographically.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return the set of all realms.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk SortedSet<String> getRealms() throws AMConsoleException;
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * The default URL to use for the OAuth2 redirect proxy. This makes a best-effort guess based on the server
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * configuration, but the user may have to override it to account for load balancers etc.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return The default redirect URL.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Indicates whether the provider has known settings or not. This controls whether we display additional fields.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return true if this is a known social authn provider or false if manual config is required.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Get the name of this social authn provider suitable for display to a user.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return the (possibly localized) name of the authn provider.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * A localized message describing how to register with this particular social authentication provider. This is
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * localized per provider to allow more detailed help messages to be given. If the provider is not known then this
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * method returns null and some default message should be used.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return a localized help message for the provider, or {@code null} if provider unknown.