de.alpharogroup.cxf.rest.client

Class WebClientExtensions

java.lang.Object

de.alpharogroup.cxf.rest.client.WebClientExtensions

public class WebClientExtensions
extends Object

The class WebClientExtensions holds factory methods for server and client parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_FILTERS_TYPE_EXCLUDES The Constant DEFAULT_FILTERS_TYPE_EXCLUDES.
static String[]	DEFAULT_FILTERS_TYPE_INCLUDES The Constant DEFAULT_FILTERS_TYPE_INCLUDES.

Constructor Summary

Constructors

Constructor and Description
WebClientExtensions()

Method Summary

Modifier and Type	Method and Description
static org.apache.cxf.configuration.security.FiltersType	newCipherSuitesFilter() Factory method for create a new FiltersType with the default includes and excludes.
static org.apache.cxf.configuration.security.FiltersType	newCipherSuitesFilter(String[] includes, String[] excludes) Factory method for create a new FiltersType from the given includes and excludes.
static org.apache.cxf.configuration.security.ClientAuthentication	newClientAuthentication(boolean want, boolean required) Factory method for create a new ClientAuthentication from the given parameters.
static org.apache.cxf.transports.http.configuration.HTTPClientPolicy	newHTTPClientPolicy(Long connectionTimeout, boolean allowChunking, Long receiveTimeout) Factory method for create a new HTTPClientPolicy object from the given parameters.
static org.apache.cxf.jaxrs.JAXRSServerFactoryBean	newJAXRSServerFactoryBean(String serverConfigFile, String baseUrl) Factory method for create a new JAXRSServerFactoryBean from the given parameters.
static KeyStore	newKeyStore(String type, String password, File keystoreFile) Deprecated. use instead KeyTrustExtensions
static org.apache.cxf.configuration.jsse.TLSClientParameters	newTLSClientParameters(File keystoreDir, String keystoreFilename, String keystoreType, String keystorePassword) Factory method for create a new TLSServerParameters from the given parameters.
static org.apache.cxf.configuration.jsse.TLSClientParameters	newTLSClientParameters(File trustManagersKeystoreFile, String trustManagerAlgorithm, String trustManagersKeystoreType, String trustManagersKeystorePassword, File keyManagersKeystoreFile, String keyManagerAlgorithm, String keyManagersKeystoreType, String keyManagersKeystorePassword, org.apache.cxf.configuration.security.FiltersType cipherSuitesFilter, boolean disableCNCheck) Factory method for create a new TLSClientParameters from the given parameters.
static org.apache.cxf.configuration.jsse.TLSServerParameters	newTLSServerParameters(File trustManagersKeystoreFile, String trustManagerAlgorithm, String trustManagersKeystoreType, String trustManagersKeystorePassword, File keyManagersKeystoreFile, String keyManagerAlgorithm, String keyManagersKeystoreType, String keyManagersKeystorePassword, org.apache.cxf.configuration.security.FiltersType cipherSuitesFilter, org.apache.cxf.configuration.security.ClientAuthentication clientAuthentication) Factory method for create a new TLSServerParameters from the given parameters.
static KeyManager[]	resolveKeyManagers(String type, String password, File keystoreFile, String keyManagerAlgorithm) Resolve the KeyManager array from the keystore that is resolved from the given parameters.
static TrustManager[]	resolveTrustManagers(String type, String password, File keystoreFile, String trustManagerAlgorithm) Resolve the TrustManager array from the keystore that is resolved from the given parameters.
static void	setClientConfiguration(Object client, File trustManagersKeystoreFile, String trustManagerAlgorithm, String trustManagersKeystoreType, String trustManagersKeystorePassword, File keyManagersKeystoreFile, String keyManagerAlgorithm, String keyManagersKeystoreType, String keyManagersKeystorePassword, org.apache.cxf.configuration.security.FiltersType cipherSuitesFilter, boolean disableCNCheck) Sets the client configuration.
static void	setMockClientAuthentication(Object client) Sets a mock client authentication to the given client.
static void	setTLSClientParameters(Object client, org.apache.cxf.configuration.jsse.TLSClientParameters tlsClientParameters) Sets the TLS client parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FILTERS_TYPE_INCLUDES

public static final String[] DEFAULT_FILTERS_TYPE_INCLUDES

The Constant DEFAULT_FILTERS_TYPE_INCLUDES.

DEFAULT_FILTERS_TYPE_EXCLUDES

public static final String[] DEFAULT_FILTERS_TYPE_EXCLUDES

The Constant DEFAULT_FILTERS_TYPE_EXCLUDES.

Constructor Detail

WebClientExtensions

public WebClientExtensions()

Method Detail

setMockClientAuthentication

public static void setMockClientAuthentication(Object client)

Sets a mock client authentication to the given client.

Parameters:

client - the new mock client authentication

setTLSClientParameters

public static void setTLSClientParameters(Object client,
                                          org.apache.cxf.configuration.jsse.TLSClientParameters tlsClientParameters)

Sets the TLS client parameters.

Parameters:

client - the client

tlsClientParameters - the tls client parameters

newHTTPClientPolicy

public static org.apache.cxf.transports.http.configuration.HTTPClientPolicy newHTTPClientPolicy(Long connectionTimeout,
                                                                                                boolean allowChunking,
                                                                                                Long receiveTimeout)

Factory method for create a new HTTPClientPolicy object from the given parameters.

Parameters:

connectionTimeout - the connection timeout

allowChunking - the allow chunking

receiveTimeout - the receive timeout

Returns:

the new HTTPClientPolicy.

newKeyStore

public static KeyStore newKeyStore(String type,
                                   String password,
                                   File keystoreFile)
                            throws NoSuchAlgorithmException,
                                   CertificateException,
                                   FileNotFoundException,
                                   IOException,
                                   KeyStoreException

Deprecated. use instead KeyTrustExtensions

Factory method for load the KeyStore object from the given file.

Parameters:

type - the type of the keystore

password - the password of the keystore

keystoreFile - the keystore file

Returns:

the loaded KeyStore object

Throws:

NoSuchAlgorithmException - the no such algorithm exception

CertificateException - the certificate exception

FileNotFoundException - the file not found exception

IOException - Signals that an I/O exception has occurred.

KeyStoreException - the key store exception

resolveTrustManagers

public static TrustManager[] resolveTrustManagers(String type,
                                                  String password,
                                                  File keystoreFile,
                                                  String trustManagerAlgorithm)
                                           throws NoSuchAlgorithmException,
                                                  CertificateException,
                                                  FileNotFoundException,
                                                  IOException,
                                                  KeyStoreException

Resolve the TrustManager array from the keystore that is resolved from the given parameters.

Parameters:

type - the type

password - the password

keystoreFile - the keystore file

trustManagerAlgorithm - the trust manager algorithm

Returns:

the trust manager[]

Throws:

NoSuchAlgorithmException - the no such algorithm exception

CertificateException - the certificate exception

FileNotFoundException - the file not found exception

IOException - Signals that an I/O exception has occurred.

KeyStoreException - the key store exception

resolveKeyManagers

public static KeyManager[] resolveKeyManagers(String type,
                                              String password,
                                              File keystoreFile,
                                              String keyManagerAlgorithm)
                                       throws NoSuchAlgorithmException,
                                              CertificateException,
                                              FileNotFoundException,
                                              IOException,
                                              KeyStoreException,
                                              UnrecoverableKeyException

Resolve the KeyManager array from the keystore that is resolved from the given parameters.

Parameters:

type - the type

password - the password

keystoreFile - the keystore file

keyManagerAlgorithm - the key manager algorithm

Returns:

the key manager[]

Throws:

NoSuchAlgorithmException - the no such algorithm exception

CertificateException - the certificate exception

FileNotFoundException - the file not found exception

IOException - Signals that an I/O exception has occurred.

KeyStoreException - the key store exception

UnrecoverableKeyException - the unrecoverable key exception

setClientConfiguration

public static void setClientConfiguration(Object client,
                                          File trustManagersKeystoreFile,
                                          String trustManagerAlgorithm,
                                          String trustManagersKeystoreType,
                                          String trustManagersKeystorePassword,
                                          File keyManagersKeystoreFile,
                                          String keyManagerAlgorithm,
                                          String keyManagersKeystoreType,
                                          String keyManagersKeystorePassword,
                                          org.apache.cxf.configuration.security.FiltersType cipherSuitesFilter,
                                          boolean disableCNCheck)
                                   throws NoSuchAlgorithmException,
                                          CertificateException,
                                          FileNotFoundException,
                                          IOException,
                                          KeyStoreException,
                                          UnrecoverableKeyException

Sets the client configuration.

Parameters:

client - the client

trustManagersKeystoreFile - the trust managers keystore file

trustManagerAlgorithm - the trust manager algorithm

trustManagersKeystoreType - the trust managers keystore type

trustManagersKeystorePassword - the trust managers keystore password

keyManagersKeystoreFile - the key managers keystore file

keyManagerAlgorithm - the key manager algorithm

keyManagersKeystoreType - the key managers keystore type

keyManagersKeystorePassword - the key managers keystore password

cipherSuitesFilter - the cipher suites filter

disableCNCheck - the disable CN check

Throws:

NoSuchAlgorithmException - the no such algorithm exception

CertificateException - the certificate exception

FileNotFoundException - the file not found exception

IOException - Signals that an I/O exception has occurred.

KeyStoreException - the key store exception

UnrecoverableKeyException - the unrecoverable key exception

newCipherSuitesFilter

public static org.apache.cxf.configuration.security.FiltersType newCipherSuitesFilter(String[] includes,
                                                                                      String[] excludes)

Factory method for create a new FiltersType from the given includes and excludes.

Parameters:

includes - the includes

excludes - the excludes

Returns:

the new FiltersType with the given includes set.

newClientAuthentication

public static org.apache.cxf.configuration.security.ClientAuthentication newClientAuthentication(boolean want,
                                                                                                 boolean required)

Factory method for create a new ClientAuthentication from the given parameters.

Parameters:

want - the want

required - the required

Returns:

the new ClientAuthentication from the given parameters.

newCipherSuitesFilter

public static org.apache.cxf.configuration.security.FiltersType newCipherSuitesFilter()

Factory method for create a new FiltersType with the default includes and excludes.

Returns:

the new FiltersType with the default includes set.

newJAXRSServerFactoryBean

public static org.apache.cxf.jaxrs.JAXRSServerFactoryBean newJAXRSServerFactoryBean(String serverConfigFile,
                                                                                    String baseUrl)

Factory method for create a new JAXRSServerFactoryBean from the given parameters. Service and resource classes have to be added.

Parameters:

serverConfigFile - the server config file

baseUrl - the base url

Returns:

the new JAXRSServerFactoryBean from the given parameters.

newTLSClientParameters

public static org.apache.cxf.configuration.jsse.TLSClientParameters newTLSClientParameters(File trustManagersKeystoreFile,
                                                                                           String trustManagerAlgorithm,
                                                                                           String trustManagersKeystoreType,
                                                                                           String trustManagersKeystorePassword,
                                                                                           File keyManagersKeystoreFile,
                                                                                           String keyManagerAlgorithm,
                                                                                           String keyManagersKeystoreType,
                                                                                           String keyManagersKeystorePassword,
                                                                                           org.apache.cxf.configuration.security.FiltersType cipherSuitesFilter,
                                                                                           boolean disableCNCheck)
                                                                                    throws NoSuchAlgorithmException,
                                                                                           CertificateException,
                                                                                           FileNotFoundException,
                                                                                           IOException,
                                                                                           KeyStoreException,
                                                                                           UnrecoverableKeyException

Factory method for create a new TLSClientParameters from the given parameters.

Parameters:

trustManagersKeystoreFile - the trust managers keystore file

trustManagerAlgorithm - the trust manager algorithm

trustManagersKeystoreType - the trust managers keystore type

trustManagersKeystorePassword - the trust managers keystore password

keyManagersKeystoreFile - the key managers keystore file

keyManagerAlgorithm - the key manager algorithm

keyManagersKeystoreType - the key managers keystore type

keyManagersKeystorePassword - the key managers keystore password

cipherSuitesFilter - the cipher suites filter

disableCNCheck - the disable CN check

Returns:

the new TLSClientParameters.

Throws:

NoSuchAlgorithmException - the no such algorithm exception

CertificateException - the certificate exception

FileNotFoundException - the file not found exception

IOException - Signals that an I/O exception has occurred.

KeyStoreException - the key store exception

UnrecoverableKeyException - the unrecoverable key exception

newTLSServerParameters

public static org.apache.cxf.configuration.jsse.TLSServerParameters newTLSServerParameters(File trustManagersKeystoreFile,
                                                                                           String trustManagerAlgorithm,
                                                                                           String trustManagersKeystoreType,
                                                                                           String trustManagersKeystorePassword,
                                                                                           File keyManagersKeystoreFile,
                                                                                           String keyManagerAlgorithm,
                                                                                           String keyManagersKeystoreType,
                                                                                           String keyManagersKeystorePassword,
                                                                                           org.apache.cxf.configuration.security.FiltersType cipherSuitesFilter,
                                                                                           org.apache.cxf.configuration.security.ClientAuthentication clientAuthentication)
                                                                                    throws KeyStoreException,
                                                                                           NoSuchAlgorithmException,
                                                                                           CertificateException,
                                                                                           FileNotFoundException,
                                                                                           IOException,
                                                                                           UnrecoverableKeyException

Factory method for create a new TLSServerParameters from the given parameters.

Parameters:

trustManagersKeystoreFile - the trust managers keystore file

trustManagerAlgorithm - the trust manager algorithm

trustManagersKeystoreType - the trust managers keystore type

trustManagersKeystorePassword - the trust managers keystore password

keyManagersKeystoreFile - the key managers keystore file

keyManagerAlgorithm - the key manager algorithm

keyManagersKeystoreType - the key managers keystore type

keyManagersKeystorePassword - the key managers keystore password

cipherSuitesFilter - the cipher suites filter

clientAuthentication - the client authentication

Returns:

the new TLSServerParameters.

Throws:

KeyStoreException - the key store exception

NoSuchAlgorithmException - the no such algorithm exception

CertificateException - the certificate exception

FileNotFoundException - the file not found exception

IOException - Signals that an I/O exception has occurred.

UnrecoverableKeyException - the unrecoverable key exception

newTLSClientParameters

public static org.apache.cxf.configuration.jsse.TLSClientParameters newTLSClientParameters(File keystoreDir,
                                                                                           String keystoreFilename,
                                                                                           String keystoreType,
                                                                                           String keystorePassword)
                                                                                    throws UnrecoverableKeyException,
                                                                                           NoSuchAlgorithmException,
                                                                                           CertificateException,
                                                                                           FileNotFoundException,
                                                                                           KeyStoreException,
                                                                                           IOException

Factory method for create a new TLSServerParameters from the given parameters.

Parameters:

keystoreDir - the keystore dir

keystoreFilename - the keystore filename

keystoreType - the keystore type

keystorePassword - the keystore password

Returns:

the new TLSServerParameters.

Throws:

UnrecoverableKeyException - the unrecoverable key exception

NoSuchAlgorithmException - the no such algorithm exception

CertificateException - the certificate exception

FileNotFoundException - the file not found exception

KeyStoreException - the key store exception

IOException - Signals that an I/O exception has occurred.