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