Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.ibm.mqlight.api;
import java.io.File;
import com.ibm.mqlight.api.logging.Logger;
import com.ibm.mqlight.api.logging.LoggerFactory;
/**
* A set of options that can be used to configure the behaviour of the NonBlockingClient
* class when it is created using the {code {@link NonBlockingClient#create(String, ClientOptions, NonBlockingClientListener, Object)})
* method. For example:
*
*/
public class ClientOptions {
private static final Logger logger = LoggerFactory.getLogger(ClientOptions.class);
private final String id;
private final String user;
private final String password;
private final File certFile;
private final boolean verifyName;
private ClientOptions(String id, String user, String password, File certFile, boolean verifyName) {
final String methodName = "";
logger.entry(this, methodName, id, user, "******", certFile, verifyName);
this.id = id;
this.user = user;
this.password = password;
this.certFile = certFile;
this.verifyName = verifyName;
logger.exit(this, methodName);
}
public String getId() {
return id;
}
public String getUser() {
return user;
}
public String getPassword() {
return password;
}
public File getCertificateFile() {
return certFile;
}
public boolean getVerifyName() {
return verifyName;
}
@Override
public String toString() {
return super.toString()
+ " [id=" + id
+ ", user=" + user
+ ", password=" + (password == null ? null : "******")
+ ", certFile=" + certFile
+ ", verifyName=" + verifyName + "]";
}
/**
* @return a new instance of the ClientOptionsBuilder object. This can be used to
* build (immutable) ClientOptions objects.
*/
public static ClientOptionsBuilder builder() {
return new ClientOptionsBuilder();
}
/**
* A builder for ClientOptions objects.
*/
public static class ClientOptionsBuilder {
private String id = null;
private String user = null;
private String password = null;
private File certFile = null;
private boolean verifyName = true;
private ClientOptionsBuilder() {}
/**
* Sets a client identifier, that will be associated with the NonBlockingClient object
* returned by {@link NonBlockingClient#create(String, ClientOptions, NonBlockingClientListener, Object)}.
*
* @param 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 (_).
* @return the same instance of ClientOptionsBuilder that this method was invoked on.
* @throws IllegalArgumentException if an invalid id value is specified.
*/
public ClientOptionsBuilder setId(String id) throws IllegalArgumentException {
final String methodName = "setId";
logger.entry(this, methodName, id);
if (id != null) {
if (id.length() > 256) {
final IllegalArgumentException exception = new IllegalArgumentException("Client identifier '" + id + "' is longer than the maximum ID length of 256.");
logger.throwing(this, methodName, exception);
throw exception;
} else if (id.length() < 1) {
final IllegalArgumentException exception = new IllegalArgumentException("Client identifier must be a minimum ID length of 1.");
logger.throwing(this, methodName, exception);
throw exception;
}
for (int i = 0; i < id.length(); ++i) {
if (!"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789%/._".contains(id.substring(i, i+1))) {
final IllegalArgumentException exception = new IllegalArgumentException("Client identifier '" + id + "' contains invalid character: '" + id.substring(i, i+1) + "'");
logger.throwing(this, methodName, exception);
throw exception;
}
}
}
this.id = id;
logger.exit(this, methodName, this);
return this;
}
/**
* Sets the credentials, that will be associated with the NonBlockingClient object
* returned by {@link 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.
* @param user the user name that the client will identify itself using.
* @param password the password that the client will use to authenticate itself.
* @return the same instance of ClientOptionsBuilder that this method was invoked on.
*/
public ClientOptionsBuilder setCredentials(String user, String password) {
this.user = user;
this.password = password;
return this;
}
/**
* 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.
*
* @param 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.
* @return the same instance of ClientOptionsBuilder that
* this method was invoked on.
*/
public ClientOptionsBuilder setSslTrustCertificate(File certificateFile) {
this.certFile = certificateFile;
return this;
}
/**
* Determines whether the client validates that the CN name of the server's certificate
* matches its DNS name.
* @param 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.
* @return the same instance of ClientOptionsBuilder that this method was invoked on.
*/
public ClientOptionsBuilder setSslVerifyName(boolean verifyName) {
this.verifyName = verifyName;
return this;
}
/**
* @return an instance of the ClientOptions object, built using the various
* settings of this ClientOptionsBuilder class at the point this method
* is invoked.
*/
public ClientOptions build() {
return new ClientOptions(id, user, password, certFile, verifyName);
}
}
}
