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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSSOManager.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_auth_XSSOManager_idl__
  32 #define __com_sun_star_auth_XSSOManager_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_auth_InvalidArgumentException_idl__
  39 #include <com/sun/star/auth/InvalidArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_auth_SSOExceptions_idl__
  43 #include <com/sun/star/auth/SSOExceptions.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_auth_XSSOAcceptorContext_idl__
  47 #include <com/sun/star/auth/XSSOAcceptorContext.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_auth_XSSOInitiatorContext_idl__
  51 #include <com/sun/star/auth/XSSOInitiatorContext.idl>
  52 #endif
  53
  54 module com { module sun { module star { module auth {
  55
  56 /** supports the creation of security contexts for both
  57     the initiator/source side and the acceptor/target side.
  58
  59     @since OOo 1.1.2
  60  */
  61 published interface XSSOManager : ::com::sun::star::uno::XInterface
  62 {
  63     /** retrieves the mechanism name of all security contexts created using
  64         this manager.
  65
  66         @returns
  67         the mechanism name ( e.g. "KERBEROS" )
  68      */
  69     string                                      getMechanism();
  70
  71
  72     /** creates an initiator side security context.
  73
  74         @param SourcePrincipal
  75         the name of the initiator side principal for which the context
  76         will be created.
  77
  78         @param TargetPrincipal
  79         the name of the target/acceptor side principal to which the source
  80         principal intends to authenticate.
  81
  82         @paran TargetHost
  83         the host name associated with the target principal.
  84
  85         @returns
  86         the newly created initiator context.
  87      */
  88     XSSOInitiatorContext        createInitiatorContext(
  89                                 [in] string     SourcePrincipal,
  90                                 [in] string     TargetPrincipal,
  91                                 [in] string     TargetHost )
  92                                     raises( InvalidArgumentException,
  93                                             InvalidCredentialException,
  94                                             InvalidPrincipalException,
  95                                             UnsupportedException );
  96
  97
  98     /** creates an acceptor side security context.
  99
 100         @param TargetPrincipal
 101         the name of the acceptor side principal.
 102
 103         @returns
 104         the newly created acceptor side context.
 105      */
 106     XSSOAcceptorContext         createAcceptorContext(
 107                                 [in] string     TargetPrincipal )
 108                                     raises( InvalidArgumentException,
 109                                             InvalidCredentialException,
 110                                             InvalidPrincipalException,
 111                                             UnsupportedException );
 112 };
 113
 114 }; }; }; };
 115
 116 #endif