offapi/com/sun/star/auth/XSSOInitiatorContext.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: XSSOInitiatorContext.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_XSSOInitiatorContext_idl__
  32 #define __com_sun_star_auth_XSSOInitiatorContext_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 initiator side security context.
  45     <P>This context may be used to initialise authetication tokens to send to
  46     an acceptor and to authenticate any token sent back in response.
  47
  48     @since OOo 1.1.2
  49  */
  50 published interface XSSOInitiatorContext : ::com::sun::star::auth::XSSOContext
  51 {
  52     /** initialises an SSO Token to send to the acceptor side and
  53         authenticates an SSO Token returned by the acceptor if the
  54         context supports mutual authentication.
  55         <P>
  56         init should be called only once for contexts which don't support
  57         mutual authentication and at most twice for contexts which do
  58         support mutual authentication. Additional calls produce undefined
  59         results.
  60
  61         @param Token
  62         the SSO token received from the acceptor side in response to an
  63         authentication request. This token is ignored on the first call
  64         to init and should only be specified for the second call on a
  65         context supporting mutual authentication.
  66
  67         @returns
  68         the sequence of bytes to be sent to the acceptor side as part of
  69         an authentication request. This sequence will be non zero length
  70         for the first call to init, zero length for the second call to init
  71         on a context supporting mutual authentication and undefined in all
  72         other cases.
  73      */
  74     sequence< byte > init(      [in] sequence< byte > Token )
  75         raises( InvalidArgumentException,
  76                 InvalidCredentialException,
  77                 InvalidContextException,
  78                 AuthenticationFailedException );
  79 };
  80
  81 }; }; }; };
  82
  83 #endif