offapi/com/sun/star/auth/XSSOContext.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_XSSOContext_idl__
  21 #define __com_sun_star_auth_XSSOContext_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com { module sun { module star { module auth {
  26
  27 /** Base SSO security context representation
  28
  29     @since OOo 1.1.2
  30  */
  31 published interface XSSOContext : ::com::sun::star::uno::XInterface
  32 {
  33     /** retrieves the principal name of the source/initiator of the context.
  34         <P>
  35         In the case of an acceptor side security context, the source principal
  36         name is available only after the initiator has been authenticated.
  37
  38         @returns
  39         the source principal name
  40      */
  41     string getSource();
  42
  43     /** retrieves the principal name of the target/acceptor of the context.
  44
  45         @returns
  46         the target principal name
  47      */
  48     string getTarget();
  49
  50     /** retrieves the mechanism associated with the context.
  51
  52         @returns
  53         the mechanism name
  54      */
  55     string getMechanism();
  56
  57     /** retrieves whether or not the context supports mutual authentication
  58
  59         @returns
  60         `TRUE` if mutual authentication is supported, `FALSE` otherwise.
  61      */
  62     boolean getMutual();
  63 };
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */