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;
018
019/**
020 * Provides an extensible means of identifying a to-be-validated or to-be-provided token type. The TokenType enum will
021 * implement this interface, and this interface will be used to identify tokens specified in token transformations.
022 * An extensible means of identifying tokens types is necessary to support end-user-provided JsonTokenValidators and
023 * JsonTokenProviders.
024 *
025 * @supported.all.api
026 */
027public interface TokenTypeId {
028
029    /**
030     * Gets the token type id.
031     *
032     * @return the token type id.
033     */
034    String getId();
035}