offapi/com/sun/star/auth/SSOManagerFactory.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: SSOManagerFactory.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_SSOManagerFactory_idl__
  32 #define __com_sun_star_auth_SSOManagerFactory_idl__
  33
  34 #ifndef __com_sun_star_auth_XSSOManagerFactory_idl_
  35 #include <com/sun/star/auth/XSSOManagerFactory.idl>
  36 #endif
  37
  38 module com { module sun { module star { module auth {
  39
  40 /** represents a starting point for Single Signon interactions.
  41     <P>The Single Signon ( SSO ) apis provide UNO based access to underlying
  42        SSO implementations ( e.g. Kerberos ). The aim of the SSO apis is to
  43        enable authentication ( possibly mutual ) between a client ( source or
  44        initiator ) and a network service ( target or acceptor ). This is
  45        achieved via. the creation and processing of security tokens sent
  46        between the two parties. The steps which should be followed to
  47        successfully use the SSO apis are as follows:
  48     <UL>
  49         <LI>Create an <type>XSSOManagerFactory</type> instance</LI>
  50         <LI>Use this factory to create/retrieve an <type>XSSOManager</type>
  51             instance.</LI>
  52         <LI>Depending on whether your code is acting as SSO source or target,
  53             you should use the <type>XSSOManager</type> instance to create an
  54             initiator security context, <type>XSSOInitiatorContext</type> or an
  55             acceptor security context, <type>XSSOAcceptorContext</type>
  56             respectively.</LI>
  57         <LI>On the initiator side, use the previously created context to process
  58             security tokens received from the acceptor side and to create
  59             security tokens to send to the acceptor side. On the acceptor side,
  60             use the previously created context to process security tokens
  61             received from the initiator side and to create security tokens to
  62             send to the initiator side.</LI>
  63     </UL>
  64
  65     @since OOo 1.1.2
  66  */
  67
  68 published service SSOManagerFactory
  69 {
  70    /** supports the creation of <type>XSSOManager</type> instances which can
  71        subsequently be used to create security contexts.
  72     */
  73     interface XSSOManagerFactory;
  74 };
  75
  76 }; }; }; };
  77
  78 #endif