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.validator;
018
019import org.forgerock.openam.sts.TokenValidationException;
020
021/**
022 * Defines the contract for token validators deployed in the context of token transformation.
023 *
024 * The generic type T corresponds to the type of the to-be-validated token. These types are currently limited to:
025 * 1. java.security.cert.X509Certificate[]
026 * 2. the classes in the org.forgerock.openam.sts.token.model package of the openam-sts-client package: RestUsernameToken,
027 * OpenAMSessionToken, OpenIdConnectIdToken.
028 * 3. JsonValue, which is the type common to all custom token validators.
029 *
030 * @supported.all.api
031 */
032public interface RestTokenTransformValidator<T> {
033
034    /**
035     * Validates the token supplied in the provided {@code RestTokenTransformValidatorParameters}
036     *
037     * @param restTokenTransformValidatorParameters The token validation parameters which provide access to the to-be-validated
038     *                                     token
039     * @return The RestTokenTransformValidatorResult encapsulating the Principal and OpenAM session id corresponding to a
040     * successfully-validated token
041     * @throws TokenValidationException If the token could not be successfully validated.
042     */
043    RestTokenTransformValidatorResult validateToken(RestTokenTransformValidatorParameters<T> restTokenTransformValidatorParameters) throws TokenValidationException;
044
045}