com.solace.labs.spring.boot.autoconfigure.SolaceJavaProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of solace-java-spring-boot-autoconfigure Show documentation
AutoConfiguration for messaging using the Solace Java API
The newest version!
/*
 * 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.solace.labs.spring.boot.autoconfigure;

import org.springframework.boot.context.properties.ConfigurationProperties;

import java.util.Properties;

@ConfigurationProperties("solace.java")
public class SolaceJavaProperties {

     /**
     * Solace Message Router Host address. Port is optional and intelligently defaulted by the Solace Java API.
     */
    private String host = "localhost";

    /**
     * Solace Message Router Message-VPN
     */
    private String msgVpn = "default";
    
    /**
     * Solace Message Router Client Username
     */
    private String clientUsername = "spring-default-client-username";
    
    /**
     * Solace Message Router Client Password
     */
    private String clientPassword;
    
    /**
     * The client name to use when connecting to Solace Message Router. This must be unique. If absent, the API will generate a reasonable client name.
     */
    private String clientName;
    
    /**
     * The number of times to attempt and retry a connection to the host Solace Message Router (or list of routers) during initial connection setup.
     * 
     * This property is optional and defaults to the suggested value when using HA redundant router pairs as documented in the Solace Messaging API Developer Guide.
     * @see http://docs.solace.com/Solace-Messaging-APIs/Configuring-Connection-T.htm
     */
    private int connectRetries = 1;
    
    /**
     * The number of times to attempt to reconnect to the host Solace Message Router (or list of routers) after an initial connected session goes down.
     * 

     * This property is optional and defaults to the suggested value when using HA redundant router pairs as documented in the Solace Messaging API Developer Guide.
     * @see http://docs.solace.com/Solace-Messaging-APIs/Configuring-Connection-T.htm
     */
    private int reconnectRetries = 5;
    
    /**
     * When using a host list for the HOST property, this property defines how many times to try 
     * to connect or reconnect to a single host before moving to the next host in the list. 
     * NOTE: This property works in conjunction with the connect and reconnect retries settings; 
     * it does not replace them.
     * 

     * This property is optional and defaults to the suggested value when using HA redundant router pairs as documented in the Solace Messaging API Developer Guide.
     * @see http://docs.solace.com/Solace-Messaging-APIs/Configuring-Connection-T.htm
     */
    private int connectRetriesPerHost = 20; 
    
    /**
     * How much time in (MS) to wait between each attempt to connect or reconnect to a host. 
     * If a connect or reconnect attempt to host is not successful, the API waits for the 
     * amount of time set for reconnectRetryWaitInMillis, and then makes another connect or 
     * reconnect attempt.
     * 

     * This property is optional and defaults to the suggested value when using HA redundant router pairs as documented in the Solace Messaging API Developer Guide.
     * @see http://docs.solace.com/Solace-Messaging-APIs/Configuring-Connection-T.htm
     */
    private int reconnectRetryWaitInMillis = 3000;

    /**
     * Indicates whether the acknowledgement of a received guaranteed message is done by the
     * the API or by application explicitly calling ackMessage() on the received message
     * 

     * Possible values are: 

     * 

     * auto_ack
     * client_ack
     * 
     * Default value: auto_ack
     */
    private String messageAckMode = "auto_ack";

    /**
     * If enabled, the API maintains a local cache of subscriptions and reapplies
     * them when the subscriber connection is reestablished.
     * 
     * Reapply subscriptions will only apply direct topic subscriptions unpon a Session reconnect.
     * It will not reapply topic subscriptions on durable and non-durable endpoints
     * 
     * Default: false
     */
    private boolean reapplySubscriptions = false;

    /**
     * Advanced attributes that can be set by the attribute naming convention used in
     * fromProperties() and toProperties() in
     * @see  JCSMPProperties
     */
    private Properties advanced = new Properties();
    
    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public String getClientUsername() {
        return clientUsername;
    }

    public void setClientUsername(String clientUsername) {
        this.clientUsername = clientUsername;
    }

    public String getClientPassword() {
        return clientPassword;
    }

    public void setClientPassword(String clientPassword) {
        this.clientPassword = clientPassword;
    }

    public String getMsgVpn() {
        return msgVpn;
    }

    public void setMsgVpn(String msgVpn) {
        this.msgVpn = msgVpn;
    }

    public String getClientName() {
        return clientName;
    }

    public void setClientName(String clientName) {
        this.clientName = clientName;
    }
    
    public int getConnectRetries() {
        return connectRetries;
    }

    public void setConnectRetries(int connectRetries) {
        this.connectRetries = connectRetries;
    }
    
    public int getReconnectRetries() {
        return reconnectRetries;
    }

    public void setReconnectRetries(int reconnectRetries) {
        this.reconnectRetries = reconnectRetries;
    }
    
    public int getConnectRetriesPerHost() {
        return connectRetriesPerHost;
    }

    public void setConnectRetriesPerHost(int connectRetriesPerHost) {
        this.connectRetriesPerHost = connectRetriesPerHost;
    }
    
    public int getReconnectRetryWaitInMillis() {
        return reconnectRetryWaitInMillis;
    }

    public void setReconnectRetryWaitInMillis(int reconnectRetryWaitInMillis) {
        this.reconnectRetryWaitInMillis = reconnectRetryWaitInMillis;
    }

    public void setMessageAckMode(String messageAckMode) {
        this.messageAckMode = messageAckMode;
    }

    public String getMessageAckMode() {
        return this.messageAckMode;
    }

    public boolean getReapplySubscriptions() {
        return this.reapplySubscriptions;
    }

    public void setReapplySubscriptions(boolean reapplySubscriptions) {
        this.reapplySubscriptions = reapplySubscriptions;
    }

    public void setAdvanced(Properties value) {
        this.advanced = value;
    }

    public Properties getAdvanced() {
        return this.advanced;
    }
}