Overwriting Credential Settings

Concept

The interface DynamicSecurityBuilder is implemented as a fluent interface which allows adjusting the settings of a credential. The following section describes the existing methods

The interface DynamicSecurityBuilder

	/**
	 * Returns the named identifier of the credential
	 */
	public NamedReference<Credential> getNamedReference();

	/**
	 * Returns the named identifier of the credential
	 */
	public Reference<Credential> getReference();

	/**
	 * Obtain a builder interface to overwrite the password settings.
	 */
	public PasswortBuilder updatePassword() throws EpiBaseException;
	
	/**
	 * Obtain a builder interface to overwrite the keystore settings.
	 */
	public PrivateKeyStoreBuilder updatePKCSKeyStore() throws EpiBaseException;
	
	/**
	 * Obtain a builder interface to overwrite the ssh key settings.
	 */
	public SSHKeyBuilder updateSSH() throws EpiBaseException;
	
	/**
	 * Obtain a builder interface to overwrite the x509 settings.
	 */
	public X509Builder updateX509() throws EpiBaseException;
	
	/**
	 * Obtain a builder interface to overwrite the x509 settings.
	 */
	public JsonWebKeyBuilder updateJsonWebKey() throws EpiBaseException;

The interface DynamicSecurityBuilder

	/**
	 * Assign a new credential name
	 */
	public PasswortBuilder name( String name );
	
	/**
	 * Assign a new password. The password can be given in plain text or in the orchestra
	 * encryption format created by the password tool.
	 */
	public PasswortBuilder password( String password ) throws EpiBaseException;
	
	/**
	 * Update the underlying credential
	 */
	void apply() throws EpiBaseException;	

The interface PrivateKeyStoreBuilder

	/**
	 * Assign the pkcs12 key store by the given byte array
	 */
	public PrivateKeyStoreBuilder fromBinary( byte [] content ) throws ConfigurationException;

	/**
	 * Assign the pkcs12 key store by loading the data from the given file
	 */
	public PrivateKeyStoreBuilder fromFile( String keystoreFile ) throws ConfigurationException;

	/**
	 * Assign the password for the key. The password can be given in plain text or in the orchestra
	 * encryption format created by the password tool.
	 */
	public PrivateKeyStoreBuilder withKeyPassword( String keyPassword ) throws EpiBaseException;

	/**
	 * Assign the password for the key store. The password can be given in plain text or in the orchestra
	 * encryption format created by the password tool.
	 */
	public PrivateKeyStoreBuilder withStorePassword( String storePassword ) throws EpiBaseException;

	/**
	 * Update the underlying credential
	 */
	void apply() throws EpiBaseException;	

The interface SSHKeyBuilder

	/**
	 * Assign the ssh keystore from the given byte array
	 */
	public SSHKeyBuilder fromBinary( byte [] content );

	/**
	 * Assign the ssh keystore with the content from the given file
	 */
	public SSHKeyBuilder fromFile( String keystoreFile ) throws ConfigurationException;

	/**
	 * Assign the name of the ssh user
	 */
	public SSHKeyBuilder user( String user );

	/**
	 * Assign the password of the ssh key. The password can be given in plain text or in the orchestra
	 * encryption format created by the password tool.
	 */
	public SSHKeyBuilder password( String password) throws EpiBaseException;

	/**
	 * Update the underlying credential
	 */
	void apply() throws EpiBaseException;

The interface X509Builder

	/**
	 * Assign the x509 certificate from the given byte array
	 */
	public X509Builder fromBinary( byte [] content ) throws ConfigurationException;

	/**
	 * Load the x509 certificate from the given file
	 */
	public X509Builder fromFile( String certificateFile ) throws ConfigurationException;

	/**
	 * Assign the given x509 certificate
	 */
	public X509Builder fromCert( X509Certificate certificate );
	
	/**
	 * Update the underlying credential
	 */
	void apply() throws EpiBaseException;	

The interface JsonWebKeyBuilder

	/**
	 * Assign a Json Web Key that is defined on basis RSA key
	 */
	public JsonWebKeyBuilder withRSAKey( String key );
		
	/**
	 * Assign a Json Web Key that is defined on basis of an OctetSequenceKey
	 */
	public JsonWebKeyBuilder withOCTKey( String key );
	
	/**
	 * Assign a Json Web Key that is defined on basis Eliptic Curve key
	 */
	public JsonWebKeyBuilder withECKey( String key );
	
	/**
	 * Overwrite the existing key with a Json Web Key. The key type has to be the same as it is
	 * defined in the underlying configuration.
	 */
	public JsonWebKeyBuilder withKey( String key );
	
	/**
	 * Update the underlying credential
	 */
	void apply() throws EpiBaseException;