1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_task_XMasterPasswordHandling_idl__
24#define __com_sun_star_task_XMasterPasswordHandling_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_task_XInteractionHandler_idl__
31#include <com/sun/star/task/XInteractionHandler.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module task {
38
39//=============================================================================
40/** allows to change the master password, or let it be requested and checked.
41*/
42published interface XMasterPasswordHandling : com::sun::star::uno::XInterface
43{
44	//-------------------------------------------------------------------------
45	/** allows to check the user authorization.
46
47        <p>
48        This call let the master password be requested from user using the
49        provided interaction handler.
50        </p>
51
52        <p>
53        The call will use the standard interactin handler service
54        <type>InteractionHandler</type> if no handler is provided.
55        </p>
56
57	*/
58	boolean authorizateWithMasterPassword( [in] XInteractionHandler xHandler );
59
60	//-------------------------------------------------------------------------
61	/** allows to change the master password.
62
63        <p>
64        If there is still no master password, the user will be asked to provide
65        the new one.
66        </p>
67
68        <p>
69        The call will use the standard interaction handler service
70        <type>InteractionHandler</type> if no handler is provided.
71        </p>
72	*/
73	boolean changeMasterPassword( [in] XInteractionHandler xHandler );
74
75	//-------------------------------------------------------------------------
76	/** let the master password and all the related stored passwords be
77        removed.
78	*/
79	void removeMasterPassword();
80
81	//-------------------------------------------------------------------------
82	/** allows to detect whether there is already a master password
83	*/
84	boolean hasMasterPassword();
85
86	//-------------------------------------------------------------------------
87	/** allows to specify whether persistent storing of passwords is allowed
88
89        <p>
90        After the storing is forbidden the master password and all the stored
91        passwords are removed.
92        </p>
93	*/
94	boolean allowPersistentStoring( [in] boolean bAllow );
95
96	//-------------------------------------------------------------------------
97	/** allows to detect whether persistent storing of passwords is allowed
98	*/
99	boolean isPersistentStoringAllowed();
100
101};
102
103//=============================================================================
104
105}; }; }; };
106
107#endif
108
109