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