offapi/com/sun/star/task/PasswordContainerInteractionHandler.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_task_PasswordContainerInteractionHandler_idl__
  29 #define __com_sun_star_task_PasswordContainerInteractionHandler_idl__
  30
  31 module com { module sun { module star {
  32     module task { published interface XInteractionHandler; };
  33 }; }; };
  34
  35 module com { module sun { module star { module task {
  36
  37 //============================================================================
  38 /** An interaction request handler that uses the
  39     <type scope="com::sun::star::task">PasswordContainer</type> service to
  40     handle <type scope="com::sun::star::ucb">AuthenticationRequest</type>s.
  41
  42     If the password container contains credentials matching the authentication
  43     request, the service implementation selects the
  44     <type scope="com::sun::star::ucb">XInteractionSupplyAuthentication</type>
  45     continuation, that should be supplied with the interaction request.
  46
  47     If the password container does not contain credentials matching the
  48     authentication request, the service implementation selects no continuation.
  49
  50     @since OOo 3.3
  51  */
  52 published service PasswordContainerInteractionHandler
  53    : com::sun::star::task::XInteractionHandler;
  54
  55 }; }; }; };
  56
  57 #endif