summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/auth/XSSOPasswordCache.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/auth/XSSOPasswordCache.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream.tar.xz
libreoffice-upstream.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/auth/XSSOPasswordCache.idl')
-rw-r--r--offapi/com/sun/star/auth/XSSOPasswordCache.idl95
1 files changed, 95 insertions, 0 deletions
diff --git a/offapi/com/sun/star/auth/XSSOPasswordCache.idl b/offapi/com/sun/star/auth/XSSOPasswordCache.idl
new file mode 100644
index 000000000..23aac255b
--- /dev/null
+++ b/offapi/com/sun/star/auth/XSSOPasswordCache.idl
@@ -0,0 +1,95 @@
+/* -*- 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_auth_XSSOPasswordCache_idl__
+#define __com_sun_star_auth_XSSOPasswordCache_idl__
+
+#include <com/sun/star/auth/InvalidArgumentException.idl>
+#include <com/sun/star/auth/PersistenceFailureException.idl>
+#include <com/sun/star/uno/XInterface.idl>
+
+module com { module sun { module star { module auth {
+
+/** supports password caching for security mechanisms which use passwords as
+ credentials or as an input to credential creation but don't have
+ an external method to cache these passwords.
+
+ @since OOo 1.1.2
+ */
+
+published interface XSSOPasswordCache : ::com::sun::star::uno::XInterface
+{
+ /** adds a username/password combination to the cache.
+ <P>
+ If an entry for the specified username already exists in the cache, it
+ will be overwritten.
+
+ @param UserName
+ the user name to add
+
+ @param Password
+ the associated password
+
+ @param Persist
+ indicates whether or not the username/password combination should be
+ persisted
+ */
+ void addPassword( [in] string UserName,
+ [in] string Password,
+ [in] boolean Persist )
+ raises( InvalidArgumentException,
+ PersistenceFailureException );
+
+ /** retrieves a password for a given user from the cache.
+ <P>
+ Non persistent cache is searched first, followed by the
+ persistent cache ( if it exists ).
+
+ @param UserName
+ the name of the user whose password should be retrieved
+
+ @param Persist
+ indicates whether or not the password is persistent
+
+ @returns
+ the required password
+ */
+ string getPassword( [in] string UserName, [out] boolean Persist )
+ raises( InvalidArgumentException,
+ PersistenceFailureException );
+
+ /** removes a password from the cache
+
+ @param UserName
+ the name of the user whose password should be removed.
+
+ @param RemovePersist
+ indicates whether or not the password should also be removed, if
+ present, from persistent cache.
+ */
+ void removePassword( [in] string UserName, [in] boolean RemovePersist )
+ raises( InvalidArgumentException,
+ PersistenceFailureException );
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */