001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: TokenProvider.java,v 1.3 2008/08/27 19:05:53 mrudul_uchil Exp $
026 *
027 */
028
029package com.sun.identity.wss.security;
030
031/**
032 * The interface <code>TokenProvider</code> represents a Security Token
033 * provider for generating the Security Tokens. 
034 *
035 * <p> Each token provider implementation must implement this interface
036 * to generate the <code>SecurityToken</code>s that may be attached to the
037 * Web services security (SOAP) headers.
038 * 
039 * @supported.all.api
040 */
041public interface TokenProvider {
042
043    /**
044     * Initializes the <code>TokenProvider</code> to generate the necessary
045     * Security Token. 
046     *
047     * @param tokenSpec the token specification required to generate the
048     *        Security Token. 
049     */
050    public void init(SecurityTokenSpec tokenSpec);
051
052    /**
053     * Returns the <code>SecurityToken</code> for the WS-Security.
054     *
055     * @return the Security Token.
056     *
057     * @exception SecurityException if unable to generate the Security Token.
058     */
059    public  SecurityToken getSecurityToken() throws SecurityException;
060
061}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.