001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2005 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: AppSSOTokenProvider.java,v 1.4 2008/06/25 05:43:57 qcheng Exp $
026 *
027 */
028
029package com.sun.identity.security;
030
031import com.iplanet.sso.SSOToken;
032
033/**
034 * This interface defines method to get application single sign on token. An use
035 * case is that an application that uses
036 * <code>com.sun.identity.policy.client.PolicyEvaluator</code> would pass an
037 * implementation of this interface to construct an instance of
038 * <code>com.sun.identity.policy.client.PolicyEvaluator</code>.
039 *
040 * @supported.all.api
041 */
042public interface AppSSOTokenProvider {
043    /**
044     * Returns application single sign on token.
045     * 
046     * @return application single sign on token.
047     */
048    public SSOToken getAppSSOToken();
049}