|
Cumulus4j API (1.1.1) |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.cumulus4j.keymanager.api.KeyManagerAPIConfiguration
public class KeyManagerAPIConfiguration
Configuration of the KeyManagerAPI
.
An instance of this class tells the KeyManagerAPI
where
the key store
is located and which key-store (identified by its keyStoreID
) is to be used (among other things).
When you pass a KeyManagerAPIConfiguration
instance to KeyManagerAPI.setConfiguration(KeyManagerAPIConfiguration)
,
it becomes immutable
. If you want to change the configuration afterwards,
create a new one
and call
KeyManagerAPI.setConfiguration(KeyManagerAPIConfiguration)
again.
Constructor Summary | |
---|---|
KeyManagerAPIConfiguration()
Create an empty configuration. |
|
KeyManagerAPIConfiguration(KeyManagerAPIConfiguration source)
Create a copy of another configuration. |
Method Summary | |
---|---|
protected void |
finalize()
|
char[] |
getAuthPassword()
Get the password that will be used for authentication at the KeyStore . |
String |
getAuthUserName()
Get the user name that will be used for authentication at the KeyStore . |
String |
getKeyManagerBaseURL()
Get the URL where the KeyStore is accessible. |
String |
getKeyStoreID()
Get the KeyStore 's identifier. |
boolean |
isReadOnly()
Get the immutable flag. |
void |
markReadOnly()
Set the immutable flag. |
void |
setAuthPassword(char[] authPassword)
Set the password that will be used for authentication at the KeyStore . |
void |
setAuthUserName(String authUserName)
Set the user name that will be used for authentication at the KeyStore . |
void |
setKeyManagerBaseURL(String keyManagerBaseURL)
Set the URL where the KeyStore is accessible. |
void |
setKeyStoreID(String keyStoreID)
Set the KeyStore 's identifier. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public KeyManagerAPIConfiguration()
public KeyManagerAPIConfiguration(KeyManagerAPIConfiguration source)
source
- the original configuration to be copied. Can be null
, which means that the new configuration
will be completely empty (just as if it was created by the default constructor).Method Detail |
---|
public boolean isReadOnly()
true
, every attempt to modify this instance (i.e. every setter)
will throw an IllegalStateException
.
markReadOnly()
public void markReadOnly()
IllegalStateException
rendering this instance read-only.
isReadOnly()
public String getAuthUserName()
KeyStore
.
KeyStore
.setAuthUserName(String)
public void setAuthUserName(String authUserName)
KeyStore
.
authUserName
- the user name for authentication at the KeyStore
.getAuthUserName()
public char[] getAuthPassword()
KeyStore
.
KeyStore
.setAuthPassword(char[])
public void setAuthPassword(char[] authPassword)
KeyStore
.
authPassword
- the password for authentication at the KeyStore
.
This will be copied, i.e. later modifications to the given password will not
affect this configuration. You indeed should zero-out the given password as soon
as you don't need to keep it in memory, anymore.getAuthPassword()
public String getKeyStoreID()
Get the KeyStore
's identifier.
One key manager can manage multiple key stores. This identifier specifies which one to use.
KeyStore
's identifier.setKeyStoreID(String)
public void setKeyStoreID(String keyStoreID)
KeyStore
's identifier.
keyStoreID
- the KeyStore
's identifier. This should not contain spaces and other special characters that
might not be used in restricted operating-systems (like Windows), because this might be used as (part of) a file name.
Actually, it should contain only characters that can be used in URLs.getKeyStoreID()
public String getKeyManagerBaseURL()
KeyStore
is accessible. This can either be a local directory (the URL starts with
"file:") or a key-server (accessible via REST over HTTP or HTTPS).
KeyStore
's base-URL (the complete URL is composed of this and the key-store-ID
.setKeyManagerBaseURL(String)
public void setKeyManagerBaseURL(String keyManagerBaseURL)
KeyStore
is accessible. This can either be a local directory (the URL starts with
"file:") or a key-server (accessible via REST over HTTP or HTTPS).
keyManagerBaseURL
- the base-URL of the remote key-server or a local file-URL (referencing a directory!),
if a local key-store is to be used. This argument can be null
, which means to use a local file in
the default directory "${user.home}/.cumulus4j/".getKeyManagerBaseURL()
protected void finalize() throws Throwable
finalize
in class Object
Throwable
|
Cumulus4j API (1.1.1) |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |