org.apache.knox.gateway.services.security

Interface KeystoreService

All Superinterfaces:

Service

public interface KeystoreService
extends Service

Method Summary

Modifier and Type	Method and Description
void	addCredentialForCluster(String clusterName, String alias, String key)
void	addCredentialsForCluster(String clusterName, Map<String,String> credentials)
void	addSelfSignedCertForGateway(String alias, char[] passphrase)
void	addSelfSignedCertForGateway(String alias, char[] passphrase, String hostname)
void	createCredentialStoreForCluster(String clusterName)
void	createKeystoreForGateway()
Certificate	getCertificateForGateway()
char[]	getCredentialForCluster(String clusterName, String alias)
char[]	getCredentialForCluster(String clusterName, String alias, KeyStore ks)
KeyStore	getCredentialStoreForCluster(String clusterName)
Key	getKeyForGateway(char[] passphrase)
Key	getKeyForGateway(String alias, char[] passphrase)
KeyStore	getKeystoreForGateway()
String	getKeystorePath()
Key	getSigningKey(String alias, char[] passphrase)
Key	getSigningKey(String keystoreName, String alias, char[] passphrase)
KeyStore	getSigningKeystore()
KeyStore	getSigningKeystore(String keystoreName)
KeyStore	getTruststoreForHttpClient() Gets the configured keystore instance that contains trust data.
boolean	isCredentialStoreForClusterAvailable(String clusterName)
boolean	isKeystoreForGatewayAvailable()
void	removeCredentialForCluster(String clusterName, String alias)
void	removeCredentialsForCluster(String clusterName, Set<String> aliases)

Methods inherited from interface org.apache.knox.gateway.services.Service

init, start, stop

Method Detail

createKeystoreForGateway

void createKeystoreForGateway()
                       throws KeystoreServiceException

Throws:

KeystoreServiceException

addSelfSignedCertForGateway

void addSelfSignedCertForGateway(String alias,
                                 char[] passphrase)
                          throws KeystoreServiceException

Throws:

KeystoreServiceException

addSelfSignedCertForGateway

void addSelfSignedCertForGateway(String alias,
                                 char[] passphrase,
                                 String hostname)
                          throws KeystoreServiceException

Throws:

KeystoreServiceException

getKeystoreForGateway

KeyStore getKeystoreForGateway()
                        throws KeystoreServiceException

Throws:

KeystoreServiceException

getTruststoreForHttpClient

KeyStore getTruststoreForHttpClient()
                             throws KeystoreServiceException

Gets the configured keystore instance that contains trust data.

Returns:

a KeyStore; or null if not configured

Throws:

KeystoreServiceException - Exception when unable to get truststore

getSigningKeystore

KeyStore getSigningKeystore()
                     throws KeystoreServiceException

Throws:

KeystoreServiceException

getSigningKeystore

KeyStore getSigningKeystore(String keystoreName)
                     throws KeystoreServiceException

Throws:

KeystoreServiceException

getKeyForGateway

Key getKeyForGateway(String alias,
                     char[] passphrase)
              throws KeystoreServiceException

Throws:

KeystoreServiceException

getKeyForGateway

Key getKeyForGateway(char[] passphrase)
              throws KeystoreServiceException

Throws:

KeystoreServiceException

getCertificateForGateway

Certificate getCertificateForGateway()
                              throws KeystoreServiceException,
                                     KeyStoreException

Throws:

KeystoreServiceException

KeyStoreException

getSigningKey

Key getSigningKey(String alias,
                  char[] passphrase)
           throws KeystoreServiceException

Throws:

KeystoreServiceException

getSigningKey

Key getSigningKey(String keystoreName,
                  String alias,
                  char[] passphrase)
           throws KeystoreServiceException

Throws:

KeystoreServiceException

createCredentialStoreForCluster

void createCredentialStoreForCluster(String clusterName)
                              throws KeystoreServiceException

Throws:

KeystoreServiceException

isCredentialStoreForClusterAvailable

boolean isCredentialStoreForClusterAvailable(String clusterName)
                                      throws KeystoreServiceException

Throws:

KeystoreServiceException

isKeystoreForGatewayAvailable

boolean isKeystoreForGatewayAvailable()
                               throws KeystoreServiceException

Throws:

KeystoreServiceException

getCredentialStoreForCluster

KeyStore getCredentialStoreForCluster(String clusterName)
                               throws KeystoreServiceException

Throws:

KeystoreServiceException

addCredentialForCluster

void addCredentialForCluster(String clusterName,
                             String alias,
                             String key)
                      throws KeystoreServiceException

Throws:

KeystoreServiceException

addCredentialsForCluster

void addCredentialsForCluster(String clusterName,
                              Map<String,String> credentials)
                       throws KeystoreServiceException

Throws:

KeystoreServiceException

removeCredentialForCluster

void removeCredentialForCluster(String clusterName,
                                String alias)
                         throws KeystoreServiceException

Throws:

KeystoreServiceException

removeCredentialsForCluster

void removeCredentialsForCluster(String clusterName,
                                 Set<String> aliases)
                          throws KeystoreServiceException

Throws:

KeystoreServiceException

getCredentialForCluster

char[] getCredentialForCluster(String clusterName,
                               String alias)
                        throws KeystoreServiceException

Throws:

KeystoreServiceException

getCredentialForCluster

char[] getCredentialForCluster(String clusterName,
                               String alias,
                               KeyStore ks)
                        throws KeystoreServiceException

Throws:

KeystoreServiceException

getKeystorePath

String getKeystorePath()