offapi/com/sun/star/auth/XSSOManager.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 /** supports the creation of security contexts for both
  23     the initiator/source side and the acceptor/target side.
  24
  25     @since OOo 1.1.2
  26  */
  27 published interface XSSOManager : ::com::sun::star::uno::XInterface
  28 {
  29     /** retrieves the mechanism name of all security contexts created using
  30         this manager.
  31
  32         @returns
  33         the mechanism name ( e.g. "KERBEROS" )
  34      */
  35     string                  getMechanism();
  36
  37
  38     /** creates an initiator side security context.
  39
  40         @param SourcePrincipal
  41         the name of the initiator side principal for which the context
  42         will be created.
  43
  44         @param TargetPrincipal
  45         the name of the target/acceptor side principal to which the source
  46         principal intends to authenticate.
  47
  48         @param TargetHost
  49         the host name associated with the target principal.
  50
  51         @returns
  52         the newly created initiator context.
  53      */
  54     XSSOInitiatorContext    createInitiatorContext(
  55                                 [in] string SourcePrincipal,
  56                                 [in] string TargetPrincipal,
  57                                 [in] string TargetHost )
  58                                     raises( InvalidArgumentException,
  59                                             InvalidCredentialException,
  60                                             InvalidPrincipalException,
  61                                             UnsupportedException );
  62
  63
  64     /** creates an acceptor side security context.
  65
  66         @param TargetPrincipal
  67         the name of the acceptor side principal.
  68
  69         @returns
  70         the newly created acceptor side context.
  71      */
  72     XSSOAcceptorContext     createAcceptorContext(
  73                                 [in] string TargetPrincipal )
  74                                     raises( InvalidArgumentException,
  75                                             InvalidCredentialException,
  76                                             InvalidPrincipalException,
  77                                             UnsupportedException );
  78 };
  79
  80 }; }; }; };
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */