/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSSOAcceptorContext.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 20:45:58 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_auth_XSSOAcceptorContext_idl__
#define __com_sun_star_auth_XSSOAcceptorContext_idl__

#ifndef __com_sun_star_auth_XSSOContext_idl__
#include <com/sun/star/auth/XSSOContext.idl>
#endif

#ifndef __com_sun_star_auth_SSOExceptions_idl__
#include <com/sun/star/auth/SSOExceptions.idl>
#endif

module com { module sun { module star { module auth {

/** represents an acceptor side security context.
    <P>This context may be used to authenticate a Single Signon initiator based
       on a security token sent by the intiator and to generate a token to be
       sent back to the initiator so that it can authenticate the acceptor.

    @since OOo 1.1.2
*/

published interface XSSOAcceptorContext : ::com::sun::star::auth::XSSOContext
{
    /** accepts/authenticates an SSO token sent from the context initiator side.
        <P>
        accept() should be called only once. Subsequent calls produce
        undefined results.

        @param Token
        the SSO token sent by the initiator.

        @returns
        the sequence of bytes to be sent back to the initiator to allow
        authentication of the acceptor side, if mutual authentication is
        supported by the security context. If mutual authentication is not
        supported a zero length sequence is returned.
     */

    sequence< byte >    accept( [in] sequence< byte > Token )
        raises( InvalidArgumentException,
                InvalidCredentialException,
                InvalidContextException,
                AuthenticationFailedException );
};

}; }; }; };

#endif
