OAuth2Model.java revision 8b6198b1170e3128c5df83267597f0058d07c70d
4169N/A/*
1178N/A * The contents of this file are subject to the terms of the Common Development and
1178N/A * Distribution License (the License). You may not use this file except in compliance with the
1178N/A * License.
1178N/A *
1178N/A * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
1178N/A * specific language governing permission and limitations under the License.
1178N/A *
1178N/A * When distributing Covered Software, include this CDDL Header Notice in each file and include
1178N/A * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
1178N/A * Header, with the fields enclosed by brackets [] replaced by your own identifying
1178N/A * information: "Portions copyright [year] [name of copyright owner]".
1178N/A *
1178N/A * Copyright 2015 ForgeRock AS.
1178N/A */
1178N/A
1178N/Apackage com.sun.identity.console.task.model;
2362N/A
2362N/Aimport java.util.SortedSet;
2362N/A
1178N/Aimport com.sun.identity.console.base.model.AMConsoleException;
5176N/Aimport com.sun.identity.console.base.model.AMModel;
1178N/A
1178N/A/**
4033N/A * Model class for common tasks involved in configuring social authentication providers (Google, Facebook etc).
4935N/A *
4033N/A * @since 12.0.0
4033N/A */
1178N/Apublic interface OAuth2Model extends AMModel {
1178N/A
4935N/A /**
1178N/A * Get a set of all configured realms, sorted lexicographically.
4033N/A *
0N/A * @return the set of all realms.
0N/A */
0N/A SortedSet<String> getRealms() throws AMConsoleException;
0N/A
0N/A /**
0N/A * Get the name of this OAuth2 profile, suitable for display to a user.
0N/A *
4033N/A * @return the (possibly localized) name of the OAuth2 profile.
0N/A */
0N/A String getDisplayName();
1178N/A
0N/A /**
0N/A * A localized message describing the OAuth2 profile.
4935N/A *
0N/A * @return a localized help message for the profile.
0N/A */
0N/A String getLocalizedHelpMessage();
0N/A}
0N/A