Massive Argeo APIs refactoring

[lgpl/argeo-commons.git] / org.argeo.cms / src / org / argeo / cms / security / Keyring.java

diff --git a/org.argeo.cms/src/org/argeo/cms/security/Keyring.java b/org.argeo.cms/src/org/argeo/cms/security/Keyring.java
new file mode 100644 (file)
index 0000000..53740c6
--- /dev/null
+++ b/org.argeo.cms/src/org/argeo/cms/security/Keyring.java
@@ -0,0 +1,26 @@
+package org.argeo.cms.security;
+
+import java.io.InputStream;
+
+/**
+ * Access to private (typically encrypted) data. The keyring is responsible for
+ * retrieving the necessary credentials. <b>Experimental. This API may
+ * change.</b>
+ */
+public interface Keyring {
+       /**
+        * Returns the confidential information as chars. Must ask for it if it is
+        * not stored.
+        */
+       public char[] getAsChars(String path);
+
+       /**
+        * Returns the confidential information as a stream. Must ask for it if it
+        * is not stored.
+        */
+       public InputStream getAsStream(String path);
+
+       public void set(String path, char[] arr);
+
+       public void set(String path, InputStream in);
+}