offapi/com/sun/star/auth/XSSOContext.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: XSSOContext.idl,v $
  10  * $Revision: 1.7 $
  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_XSSOContext_idl__
  32 #define __com_sun_star_auth_XSSOContext_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module auth {
  39
  40 /** Base SSO security context representation
  41
  42     @since OOo 1.1.2
  43  */
  44 published interface XSSOContext : ::com::sun::star::uno::XInterface
  45 {
  46     /** retrieves the principal name of the source/initiator of the context.
  47         <P>
  48         In the case of an acceptor side security context, the source principal
  49         name is available only after the initiator has been authenticated.
  50
  51         @returns
  52         the source principal name
  53      */
  54     string getSource();
  55
  56     /** retrieves the principal name of the target/acceptor of the context.
  57
  58         @returns
  59         the target principal name
  60      */
  61     string getTarget();
  62
  63     /** retrieves the mechanism associated with the context.
  64
  65         @returns
  66         the mechanism name
  67      */
  68     string getMechanism();
  69
  70     /** retrieves whether or not the context supports mutual authentication
  71
  72         @returns
  73         <TRUE/> if mutual authentication is supported, <FALSE/> otherwise.
  74      */
  75     boolean     getMutual();
  76 };
  77
  78 }; }; }; };
  79
  80 #endif