offapi/com/sun/star/auth/XSSOAcceptorContext.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSSOAcceptorContext.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_auth_XSSOAcceptorContext_idl__
  32 #define __com_sun_star_auth_XSSOAcceptorContext_idl__
  33
  34 #ifndef __com_sun_star_auth_XSSOContext_idl__
  35 #include <com/sun/star/auth/XSSOContext.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_auth_SSOExceptions_idl__
  39 #include <com/sun/star/auth/SSOExceptions.idl>
  40 #endif
  41
  42 module com { module sun { module star { module auth {
  43
  44 /** represents an acceptor side security context.
  45     <P>This context may be used to authenticate a Single Signon initiator based
  46        on a security token sent by the intiator and to generate a token to be
  47        sent back to the initiator so that it can authenticate the acceptor.
  48
  49     @since OOo 1.1.2
  50 */
  51
  52 published interface XSSOAcceptorContext : ::com::sun::star::auth::XSSOContext
  53 {
  54     /** accepts/authenticates an SSO token sent from the context initiator side.
  55         <P>
  56         accept() should be called only once. Subsequent calls produce
  57         undefined results.
  58
  59         @param Token
  60         the SSO token sent by the initiator.
  61
  62         @returns
  63         the sequence of bytes to be sent back to the initiator to allow
  64         authentication of the acceptor side, if mutual authentication is
  65         supported by the security context. If mutual authentication is not
  66         supported a zero length sequence is returned.
  67      */
  68
  69     sequence< byte >    accept( [in] sequence< byte > Token )
  70         raises( InvalidArgumentException,
  71                 InvalidCredentialException,
  72                 InvalidContextException,
  73                 AuthenticationFailedException );
  74 };
  75
  76 }; }; }; };
  77
  78 #endif