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