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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_auth_XSSOInitiatorContext_idl__
  30 #define __com_sun_star_auth_XSSOInitiatorContext_idl__
  31
  32 #include <com/sun/star/auth/XSSOContext.idl>
  33 #include <com/sun/star/auth/SSOExceptions.idl>
  34
  35 module com { module sun { module star { module auth {
  36
  37 /** represents an initiator side security context.
  38     <P>This context may be used to initialize authentication tokens to send to
  39     an acceptor and to authenticate any token sent back in response.
  40
  41     @since OOo 1.1.2
  42  */
  43 published interface XSSOInitiatorContext : ::com::sun::star::auth::XSSOContext
  44 {
  45     /** initializes an SSO Token to send to the acceptor side and
  46         authenticates an SSO Token returned by the acceptor if the
  47         context supports mutual authentication.
  48         <P>
  49         init should be called only once for contexts which don't support
  50         mutual authentication and at most twice for contexts which do
  51         support mutual authentication. Additional calls produce undefined
  52         results.
  53
  54         @param Token
  55         the SSO token received from the acceptor side in response to an
  56         authentication request. This token is ignored on the first call
  57         to init and should only be specified for the second call on a
  58         context supporting mutual authentication.
  59
  60         @returns
  61         the sequence of bytes to be sent to the acceptor side as part of
  62         an authentication request. This sequence will be non zero length
  63         for the first call to init, zero length for the second call to init
  64         on a context supporting mutual authentication and undefined in all
  65         other cases.
  66      */
  67     sequence< byte > init(  [in] sequence< byte > Token )
  68         raises( InvalidArgumentException,
  69                 InvalidCredentialException,
  70                 InvalidContextException,
  71                 AuthenticationFailedException );
  72 };
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */