org.openliberty.wsc

Class OpenLibertyBootstrap

java.lang.Object

org.openliberty.wsc.OpenLibertyBootstrap

public class OpenLibertyBootstrap
extends Object

This class is used to bootstrap the openLiberty WSC Client Library with the default configurations that ship with the library. It is also used to store basic settings for an Authentication server, SSL parameters, and trusted certificates.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	authenticationServiceUrl Default URL for a starting Authentication Service to enable bootstrapping the ID-WSF environment
static String	AUTHETICATION_SERVICE_URL_KEY
private static AuthenticationService.AuthMechanism	authMechanism
private static String	authPassword Default password for default AS
private static String	authUsername Default username for default AS
private static boolean	checkExpiry SSLClient setting for SSLUtilities: If false the expiration date is ignored on certs used for TLS.
private static boolean	checkHostName SSLClient setting for SSLUtilities: If false, host name is not verified for SSL transactions.
private static String	defaultClientTLSPKSAlias Alias for the ClientTLS PKS private key
private static String	defaultClientTLSPKSPassword Password for the ClientTLS PKS private key
private static String	defaultClientTLSPKSPath This is the path (resource or system path) to the default PKS that the ClientLib will use for ClientTLS.
private static String	defaultSigningPKSAlias Alias for the signing PKS private key
private static String	defaultSigningPKSPassword Password for the signing PKS private key
private static String	defaultSigningPKSPath This is the path (resource or system path) to the default PKS that the ClientLib will use for signing.
private static Logger	log
private static String	providerIDUri ProviderID to be used in the Sender header of WSF SOAP messages
private static List<X509Certificate>	trustedCertificates These certificates are loaded as Trust material into the SSLClient when a request is about to be made.
private static String[]	xmlToolingConfigs List of default XMLTooling configuration files.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenLibertyBootstrap() protected constructor

Method Summary

Methods

Modifier and Type	Method and Description
static void	bootstrap() Initializes the OpenLiberty library, loading default configurations.
static void	bootstrap(String[] additionalXmlToolingConfigs) Initializes the OpenLiberty library, loading default configurations, and providing a mechanism for a user to specify additional configs
static String	getAuthenticationServiceUrl()
static AuthenticationService.AuthMechanism	getAuthMechanism()
static String	getAuthPassword()
static String	getAuthUsername()
static String	getDefaultClientTLSPKSAlias()
static String	getDefaultClientTLSPKSPassword()
static String	getDefaultClientTLSPKSPath()
static String	getDefaultSigningPKSAlias()
static String	getDefaultSigningPKSPassword()
static String	getDefaultSigningPKSPath()
static String	getProviderIDUri()
static List<X509Certificate>	getTrustedCertificates()
protected static void	initializeClientLibProperties() This static initializer loads all of the base settings for the ClientLib
private static void	initializeOpenSAML()
protected static void	initializeXMLTooling(String[] providerConfigs) Initializes the XMLTooling library with a default set of object providers.
static boolean	isCheckExpiry()
static boolean	isCheckHostName()
static void	setAuthenticationServiceDefaults(String authenticationServiceUrl, String authUsername, String authPassword)
static void	setAuthenticationServiceUrl(String authenticationServiceUrl)
static void	setAuthMechanism(AuthenticationService.AuthMechanism authMechanism)
static void	setAuthPassword(String authPassword)
static void	setAuthUsername(String authUsername)
static void	setCheckExpiry(boolean checkExpiry)
static void	setCheckHostName(boolean checkHostName)
static void	setDefaultClientTLSPKSAlias(String defaultClientTLSPKSAlias)
static void	setDefaultClientTLSPKSPassword(String defaultClientTLSPKSPassword)
static void	setDefaultClientTLSPKSPath(String defaultClientTLSPKSPath)
static void	setDefaultSigningPKSAlias(String defaultSigningPKSAlias)
static void	setDefaultSigningPKSPassword(String defaultSigningPKSPassword)
static void	setDefaultSigningPKSPath(String defaultSigningPKSPath)
static void	setProviderIDUri(String providerIDUri)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static Logger log

AUTHETICATION_SERVICE_URL_KEY

public static final String AUTHETICATION_SERVICE_URL_KEY

See Also:

Constant Field Values

providerIDUri

private static String providerIDUri

ProviderID to be used in the Sender header of WSF SOAP messages

authenticationServiceUrl

private static String authenticationServiceUrl

Default URL for a starting Authentication Service to enable bootstrapping the ID-WSF environment

authUsername

private static String authUsername

Default username for default AS

authPassword

private static String authPassword

Default password for default AS

authMechanism

private static AuthenticationService.AuthMechanism authMechanism

trustedCertificates

private static List<X509Certificate> trustedCertificates

These certificates are loaded as Trust material into the SSLClient when a request is about to be made.

defaultSigningPKSPath

private static String defaultSigningPKSPath

This is the path (resource or system path) to the default PKS that the ClientLib will use for signing.

defaultSigningPKSAlias

private static String defaultSigningPKSAlias

Alias for the signing PKS private key

defaultSigningPKSPassword

private static String defaultSigningPKSPassword

Password for the signing PKS private key

defaultClientTLSPKSPath

private static String defaultClientTLSPKSPath

This is the path (resource or system path) to the default PKS that the ClientLib will use for ClientTLS.

defaultClientTLSPKSAlias

private static String defaultClientTLSPKSAlias

Alias for the ClientTLS PKS private key

defaultClientTLSPKSPassword

private static String defaultClientTLSPKSPassword

Password for the ClientTLS PKS private key

checkHostName

private static boolean checkHostName

SSLClient setting for SSLUtilities: If false, host name is not verified for SSL transactions. In production this should always be set to true. The default value is true.

checkExpiry

private static boolean checkExpiry

SSLClient setting for SSLUtilities: If false the expiration date is ignored on certs used for TLS. The default value is true.

xmlToolingConfigs

private static String[] xmlToolingConfigs

List of default XMLTooling configuration files. This list is used to initialize all of the openLiberty and OpenSAML XML Tooling libraries.

Constructor Detail

OpenLibertyBootstrap

protected OpenLibertyBootstrap()

protected constructor

Method Detail

bootstrap

public static void bootstrap()
                      throws org.opensaml.core.xml.config.XMLConfigurationException

Initializes the OpenLiberty library, loading default configurations.

Throws:

ConfigurationException - thrown if there is a problem initializing the OpenSAML library

org.opensaml.core.xml.config.XMLConfigurationException

initializeOpenSAML

private static void initializeOpenSAML()

bootstrap

public static void bootstrap(String[] additionalXmlToolingConfigs)
                      throws org.opensaml.core.xml.config.XMLConfigurationException

Initializes the OpenLiberty library, loading default configurations, and providing a mechanism for a user to specify additional configs

Throws:

ConfigurationException - thrown if there is a problem initializing the OpenSAML library

org.opensaml.core.xml.config.XMLConfigurationException

initializeXMLTooling

protected static void initializeXMLTooling(String[] providerConfigs)
                                    throws org.opensaml.core.xml.config.XMLConfigurationException

Initializes the XMLTooling library with a default set of object providers.

Parameters:

providerConfigs - list of provider configuration files located on the classpath

Throws:

org.opensaml.core.xml.config.XMLConfigurationException - thrown if there is a problem loading the configuration files

initializeClientLibProperties

protected static void initializeClientLibProperties()

This static initializer loads all of the base settings for the ClientLib

TODO: Load the base configuration from a settings file

getAuthenticationServiceUrl

public static String getAuthenticationServiceUrl()

getAuthPassword

public static String getAuthPassword()

getAuthUsername

public static String getAuthUsername()

getProviderIDUri

public static String getProviderIDUri()

getAuthMechanism

public static AuthenticationService.AuthMechanism getAuthMechanism()

getDefaultClientTLSPKSAlias

public static String getDefaultClientTLSPKSAlias()

getDefaultClientTLSPKSPassword

public static String getDefaultClientTLSPKSPassword()

getDefaultClientTLSPKSPath

public static String getDefaultClientTLSPKSPath()

getDefaultSigningPKSAlias

public static String getDefaultSigningPKSAlias()

getDefaultSigningPKSPassword

public static String getDefaultSigningPKSPassword()

getDefaultSigningPKSPath

public static String getDefaultSigningPKSPath()

getTrustedCertificates

public static List<X509Certificate> getTrustedCertificates()

isCheckHostName

public static boolean isCheckHostName()

isCheckExpiry

public static boolean isCheckExpiry()

setAuthenticationServiceDefaults

public static void setAuthenticationServiceDefaults(String authenticationServiceUrl,
                                    String authUsername,
                                    String authPassword)

setAuthenticationServiceUrl

public static void setAuthenticationServiceUrl(String authenticationServiceUrl)

setAuthPassword

public static void setAuthPassword(String authPassword)

setAuthUsername

public static void setAuthUsername(String authUsername)

setProviderIDUri

public static void setProviderIDUri(String providerIDUri)

setAuthMechanism

public static void setAuthMechanism(AuthenticationService.AuthMechanism authMechanism)

setDefaultClientTLSPKSAlias

public static void setDefaultClientTLSPKSAlias(String defaultClientTLSPKSAlias)

setDefaultClientTLSPKSPassword

public static void setDefaultClientTLSPKSPassword(String defaultClientTLSPKSPassword)

setDefaultClientTLSPKSPath

public static void setDefaultClientTLSPKSPath(String defaultClientTLSPKSPath)

setDefaultSigningPKSAlias

public static void setDefaultSigningPKSAlias(String defaultSigningPKSAlias)

setDefaultSigningPKSPassword

public static void setDefaultSigningPKSPassword(String defaultSigningPKSPassword)

setDefaultSigningPKSPath

public static void setDefaultSigningPKSPath(String defaultSigningPKSPath)

setCheckHostName

public static void setCheckHostName(boolean checkHostName)

setCheckExpiry

public static void setCheckExpiry(boolean checkExpiry)