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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_auth_XSSOInitiatorContext_idl__
  21 #define __com_sun_star_auth_XSSOInitiatorContext_idl__
  22
  23 #include <com/sun/star/auth/AuthenticationFailedException.idl>
  24 #include <com/sun/star/auth/InvalidArgumentException.idl>
  25 #include <com/sun/star/auth/InvalidContextException.idl>
  26 #include <com/sun/star/auth/InvalidCredentialException.idl>
  27 #include <com/sun/star/auth/XSSOContext.idl>
  28
  29 module com { module sun { module star { module auth {
  30
  31 /** represents an initiator side security context.
  32     <P>This context may be used to initialize authentication tokens to send to
  33     an acceptor and to authenticate any token sent back in response.
  34
  35     @since OOo 1.1.2
  36  */
  37 published interface XSSOInitiatorContext : ::com::sun::star::auth::XSSOContext
  38 {
  39     /** initializes an SSO Token to send to the acceptor side and
  40         authenticates an SSO Token returned by the acceptor if the
  41         context supports mutual authentication.
  42         <P>
  43         init should be called only once for contexts which don't support
  44         mutual authentication and at most twice for contexts which do
  45         support mutual authentication. Additional calls produce undefined
  46         results.
  47
  48         @param Token
  49         the SSO token received from the acceptor side in response to an
  50         authentication request. This token is ignored on the first call
  51         to init and should only be specified for the second call on a
  52         context supporting mutual authentication.
  53
  54         @returns
  55         the sequence of bytes to be sent to the acceptor side as part of
  56         an authentication request. This sequence will be non zero length
  57         for the first call to init, zero length for the second call to init
  58         on a context supporting mutual authentication and undefined in all
  59         other cases.
  60      */
  61     sequence< byte > init(  [in] sequence< byte > Token )
  62         raises( InvalidArgumentException,
  63                 InvalidCredentialException,
  64                 InvalidContextException,
  65                 AuthenticationFailedException );
  66 };
  67
  68 }; }; }; };
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */