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 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
* {@link NonBlockingClient#send(String, java.nio.ByteBuffer, Map, SendOptions, CompletionListener, Object)} and
* {@link NonBlockingClient#send(String, String, Map, SendOptions, CompletionListener, Object)} methods. For example:
*
*/
public class SendOptions {
private static final Logger logger = LoggerFactory.getLogger(SendOptions.class);
private final QOS qos;
private final long ttl;
private final boolean retainLink;
private SendOptions(QOS qos, long ttl, boolean retainLink) {
final String methodName = "";
logger.entry(this, methodName, qos, ttl);
this.qos = qos;
this.ttl = ttl;
this.retainLink = retainLink;
logger.exit(this, methodName);
}
public final QOS getQos() {
return qos;
}
public final long getTtl() {
return ttl;
}
public final boolean getRetainLink() {
return retainLink;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder(super.toString());
sb.append(" [qos=")
.append(qos)
.append(", ttl=")
.append(ttl)
.append(", retainLink=")
.append(retainLink)
.append("]");
return sb.toString();
}
/**
* @return a new instance of SendOptionsBuilder that can be used to build
* (immutable) instances of SendOptions.
*/
public static SendOptionsBuilder builder() {
return new SendOptionsBuilder();
}
/**
* A builder for SendOptions objects.
*/
public static class SendOptionsBuilder {
private QOS qos = QOS.AT_MOST_ONCE;
private long ttl = 0;
private boolean retainLink = true;
private SendOptionsBuilder() {}
/**
* Sets the quality of service that will be used to send messages to the MQ Light
* server.
* @param qos The required quality of service. Cannot be null.
* @return the instance of SendOptionsBuilder that this method was
* called on.
* @throws IllegalArgumentException if an invalid qos value is specified.
*/
public SendOptionsBuilder setQos(QOS qos) throws IllegalArgumentException {
final String methodName = "setQos";
logger.entry(this, methodName, qos);
if (qos == null) {
final IllegalArgumentException exception = new IllegalArgumentException("qos argument cannot be null");
logger.throwing(this, methodName, exception);
throw exception;
}
this.qos = qos;
logger.exit(this, methodName, this);
return this;
}
/**
* Sets the time to live that will be used for messages sent to the MQ Light server.
* @param ttl time to live in milliseconds. This must be a positive value, and a maximum of 4294967295 (0xFFFFFFFF)
* @return the instance of SendOptionsBuilder that this method was
* called on.
* @throws IllegalArgumentException if an invalid ttl value is specified.
*/
public SendOptionsBuilder setTtl(long ttl) throws IllegalArgumentException {
final String methodName = "setTtl";
logger.entry(this, methodName, ttl);
if (ttl < 1 || ttl > 4294967295L) {
final IllegalArgumentException exception = new IllegalArgumentException("ttl value '" + ttl + "' is invalid, must be an unsigned non-zero integer number");
logger.throwing(this, methodName, exception);
throw exception;
}
this.ttl = ttl;
logger.exit(this, methodName, this);
return this;
}
/**
* Set the retainLink option. True by default this value will determine if the AMQP Link should
* be retained by the connection so that it can be re-used for subsequent messages. When a client
* will not send further messages to a given topic this value can be set to false to automatically
* close the Link after sending this message.
* @param retainLink true if the Link should be retained, false to close after message send.
* @return the instance of SendOptionsBuilder that this method was
* called on.
*/
public SendOptionsBuilder setRetainLink(boolean retainLink) {
final String methodName = "setRetainLink";
logger.entry(this, methodName, retainLink);
this.retainLink = retainLink;
logger.exit(this, methodName, this);
return this;
}
/**
* @return an instance of SendOptions based on the current settings of
* this builder.
*/
public SendOptions build() {
return new SendOptions(qos, ttl, retainLink);
}
}
}
