001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyrighted [year] [name of copyright owner]". 013 * 014 * Copyright 2015-2016 ForgeRock AS. 015 */ 016 017package org.forgerock.openam.sts.rest.token.provider; 018 019import org.forgerock.json.JsonValue; 020import org.forgerock.openam.sts.TokenCreationException; 021 022/** 023 * Interface defining token creators in the rest-sts. The generic type T corresponds to a class 024 * which provides the state necessary to produce a token of the specified type. The creation of any 025 * specific token (SAML2, OIDC) requires specific state which cannot be subsumed in a specific type. 026 * 027 * @supported.all.api 028 */ 029public interface RestTokenProvider<T> { 030 031 /** 032 * Creates a token using the specified {@code RestTokenProviderParameters} 033 * 034 * @param restTokenProviderParameters the parameters necessary to create a token of a specific type 035 * @return the JsonValue corresponding to the created token 036 * @throws TokenCreationException if the token could not be created 037 */ 038 JsonValue createToken(RestTokenProviderParameters<T> restTokenProviderParameters) throws TokenCreationException; 039}