com.ibm.mqlight.api

Class ClientOptions.ClientOptionsBuilder

java.lang.Object

com.ibm.mqlight.api.ClientOptions.ClientOptionsBuilder

Enclosing class:

ClientOptions

public static class ClientOptions.ClientOptionsBuilder
extends Object

A builder for ClientOptions objects.

Method Summary

Methods

Modifier and Type	Method and Description
ClientOptions	build()
ClientOptions.ClientOptionsBuilder	setCredentials(String user, String password) Sets the credentials, that will be associated with the NonBlockingClient object returned by NonBlockingClient.create(String, ClientOptions, NonBlockingClientListener, Object).
ClientOptions.ClientOptionsBuilder	setId(String id) Sets a client identifier, that will be associated with the NonBlockingClient object returned by NonBlockingClient.create(String, ClientOptions, NonBlockingClientListener, Object).
ClientOptions.ClientOptionsBuilder	setSslTrustCertificate(File certificateFile) Specifies a X.509 certificate chain file for SSL/TLS certificates that the client will trust.
ClientOptions.ClientOptionsBuilder	setSslVerifyName(boolean verifyName) Determines whether the client validates that the CN name of the server's certificate matches its DNS name.

Methods inherited from class java.lang.Object

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

Method Detail

setId

public ClientOptions.ClientOptionsBuilder setId(String id)
                                         throws IllegalArgumentException

Sets a client identifier, that will be associated with the NonBlockingClient object returned by NonBlockingClient.create(String, ClientOptions, NonBlockingClientListener, Object).

Parameters:

id - a unique identifier for this client. If this is not set then the default is the string "AUTO_" followed by a randomly chosen 7 digit hex value (with hex characters lowercase). A maximum of one instance of the client (as identified by the value of this parameter) can be connected the an MQ Light server at a given point in time. If another instance of the same client connects, then the previously connected instance will be disconnected. This is reported, to the first client, as a ReplacedException, and the client transitioning into stopped state. When set, the id must be a minimum of 1 character and a maximum of 256 characters in length. The id can only contain alphanumeric characters, and any of the following characters: percent sign (%), slash (/), period (.), underscore (_).

Returns:

the same instance of ClientOptionsBuilder that this method was invoked on.

Throws:

IllegalArgumentException - if an invalid id value is specified.

setCredentials

public ClientOptions.ClientOptionsBuilder setCredentials(String user,
                                                String password)

Sets the credentials, that will be associated with the NonBlockingClient object returned by NonBlockingClient.create(String, ClientOptions, NonBlockingClientListener, Object). If these values are not set (or both values are set to null then the client will attempt to use the SASL ANNONYMOUS mechanism when it connects to the MQ Light server.

Parameters:

user - the user name that the client will identify itself using.

password - the password that the client will use to authenticate itself.

Returns:

the same instance of ClientOptionsBuilder that this method was invoked on.

setSslTrustCertificate

public ClientOptions.ClientOptionsBuilder setSslTrustCertificate(File certificateFile)

Specifies a X.509 certificate chain file for SSL/TLS certificates that the client will trust. This can either be a file in PEM format or a Java KeyStore (JKS) file.

Parameters:

certificateFile - a trust store that contains SSL/TLS certificates that the client is to trust. If this is not set (or is set to null) then the client will use the set of trusted certificates supplied with the JVM.

Returns:

the same instance of ClientOptionsBuilder that this method was invoked on.

setSslVerifyName

public ClientOptions.ClientOptionsBuilder setSslVerifyName(boolean verifyName)

Determines whether the client validates that the CN name of the server's certificate matches its DNS name.

Parameters:

verifyName - should the client validate the server's CN name? If this method is not called, the default is to behave as if this method was called with a value of true.

Returns:

the same instance of ClientOptionsBuilder that this method was invoked on.

build

public ClientOptions build()

Returns:

an instance of the ClientOptions object, built using the various settings of this ClientOptionsBuilder class at the point this method is invoked.