ClientUserToken.java revision 4a2f0f0be43dfd4c1b490cbf3cc48b6ba6084b1c
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://opensso.dev.java.net/public/CDDLv1.0.html or
* opensso/legal/CDDLv1.0.txt
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: ClientUserToken.java,v 1.5 2008/08/27 19:05:53 mrudul_uchil Exp $
*
*/
package com.sun.identity.wss.sts;
import com.sun.xml.ws.security.Token;
import org.w3c.dom.Element;
/**
* This class extends XWSS Security Token and enables the STS Clients to
* use any custom tokens that can be used in WS-Trust protocol element
* <code>OnBehalfOf</code>. This element is used by the OpenSSO
* STS Service to allow any custom changes to the issued tokens by the STS.
*
* This is also known as End user token conversion interface (SPI) that can
* be implemented by any custom token implementation to convert any custom
* end user token to the token issued by Security Token Service. In this case,
* the identity or the owner of the token generated by STS, would be same as
* the End user token.
*
* The implementation of this interface can be configured at global Security
* Token Service configuration (via Admin Console) for server side and in
* client's AMConfig.properties for client side.
*
* @supported.all.api
*/
public interface ClientUserToken extends Token {
/**
* Initializes client user token.
* @param obj credential object to initialize the user token
* @throws com.sun.identity.wss.sts.FAMSTSException
*/
public void init(Object obj) throws FAMSTSException;
/**
* Parses the custom token element. This method is used at the
* receiving end (STS server side).
* @param element the custom token element
* @throws com.sun.identity.wss.sts.FAMSTSException
*/
public void parse(Element element) throws FAMSTSException;
/**
* Returns the principal name that the client user token carries.
* @return the principal name that the client user token carries
* @throws com.sun.identity.wss.sts.FAMSTSException
*/
public String getPrincipalName() throws FAMSTSException;
/**
* Returns the <code>java.lang.String</code> representation of
* this client user token.
* @return the string format for this client user token.
*/
public String toString();
}