summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/task/XPasswordContainer.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/task/XPasswordContainer.idl')
-rw-r--r--offapi/com/sun/star/task/XPasswordContainer.idl122
1 files changed, 122 insertions, 0 deletions
diff --git a/offapi/com/sun/star/task/XPasswordContainer.idl b/offapi/com/sun/star/task/XPasswordContainer.idl
new file mode 100644
index 000000000..a105deabd
--- /dev/null
+++ b/offapi/com/sun/star/task/XPasswordContainer.idl
@@ -0,0 +1,122 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_task_XPasswordContainer_idl__
+#define __com_sun_star_task_XPasswordContainer_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/task/UrlRecord.idl>
+#include <com/sun/star/task/XInteractionHandler.idl>
+
+
+
+module com { module sun { module star { module task {
+
+/** Allows to save passwords with URL-pattern, to use them later.
+*/
+published interface XPasswordContainer : com::sun::star::uno::XInterface
+{
+ /** Save passwords into the container.
+
+ @param Url URL-pattern, that will be used later to retrieve
+ passwords.
+
+ @param UserName The username.
+
+ @param Passwords The password-list.
+
+ @param Handler The handler to get super password to en/decrypt passwords
+
+
+ */
+ void add( [in] string Url, [in] string UserName, [in] sequence<string> Passwords, [in] XInteractionHandler Handler );
+
+ /** Save passwords into the container, and store them in the file.
+
+ @param Url URL-pattern, that will be used later to retrieve
+ passwords.
+
+ @param UserName The username.
+
+ @param Passwords The password-list.
+
+ @param Handler The handler to get super password to en/decrypt passwords
+
+
+ */
+ void addPersistent( [in] string Url, [in] string UserName, [in] sequence<string> Passwords, [in] XInteractionHandler Handler );
+
+ /** Find users with passwords for the url pattern.
+
+ @param Url URL-pattern to retrieve password for.
+
+ @param Handler The handler to get super password to en/decrypt passwords
+
+ @returns Best matched url-pattern with user-records list.
+ */
+ UrlRecord find( [in] string Url, [in] XInteractionHandler Handler );
+
+ /** Find passwords for the url pattern and username.
+
+ @param Url URL-pattern to retrieve passwords for.
+
+ @param UserName Username to retrieve passwords for.
+
+ @param Handler The handler to get super password to en/decrypt passwords
+
+ @returns Best matched url-pattern for the username.
+ */
+ UrlRecord findForName( [in] string Url, [in] string UserName , [in] XInteractionHandler Handler );
+
+ /** Remove passwords for the url pattern and username.
+
+ @param Url URL-pattern to remove passwords for.
+
+ @param UserName Username to remove passwords for.
+
+ */
+ void remove( [in] string Url, [in] string UserName );
+
+
+ /** Remove passwords for the url pattern and username from the file.
+
+ @param Url URL-pattern to remove passwords for.
+
+ @param UserName Username to remove passwords for.
+
+ */
+ void removePersistent( [in] string Url, [in] string UserName );
+
+ /** Clean the file.
+ */
+ void removeAllPersistent();
+
+ /** Get all records from the file.
+
+ @returns List of url-records.
+ */
+ sequence<UrlRecord> getAllPersistent( [in] XInteractionHandler Handler );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */