org.springframework.data.redis.connection.RedisStandaloneConfiguration.java Source code

Introduction

Here is the source code for org.springframework.data.redis.connection.RedisStandaloneConfiguration.java

Source

/*
 * Copyright 2017-2019 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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 org.springframework.data.redis.connection;

import org.springframework.data.redis.connection.RedisConfiguration.WithDatabaseIndex;
import org.springframework.data.redis.connection.RedisConfiguration.WithHostAndPort;
import org.springframework.data.redis.connection.RedisConfiguration.WithPassword;
import org.springframework.util.Assert;

/**
 * Configuration class used for setting up {@link RedisConnection} via {@link RedisConnectionFactory} using connecting
 * to a single node <a href="https://redis.io/">Redis</a> installation.
 *
 * @author Mark Paluch
 * @author Christoph Strobl
 * @since 2.0
 */
public class RedisStandaloneConfiguration
        implements RedisConfiguration, WithHostAndPort, WithPassword, WithDatabaseIndex {

    private static final String DEFAULT_HOST = "localhost";
    private static final int DEFAULT_PORT = 6379;

    private String hostName = DEFAULT_HOST;
    private int port = DEFAULT_PORT;
    private int database;
    private RedisPassword password = RedisPassword.none();

    /**
     * Create a new default {@link RedisStandaloneConfiguration}.
     */
    public RedisStandaloneConfiguration() {
    }

    /**
     * Create a new {@link RedisStandaloneConfiguration} given {@code hostName}.
     *
     * @param hostName must not be {@literal null} or empty.
     */
    public RedisStandaloneConfiguration(String hostName) {
        this(hostName, DEFAULT_PORT);
    }

    /**
     * Create a new {@link RedisStandaloneConfiguration} given {@code hostName} and {@code port}.
     *
     * @param hostName must not be {@literal null} or empty.
     * @param port a valid TCP port (1-65535).
     */
    public RedisStandaloneConfiguration(String hostName, int port) {

        Assert.hasText(hostName, "Host name must not be null or empty!");
        Assert.isTrue(port >= 1 && port <= 65535,
                () -> String.format("Port %d must be a valid TCP port in the range between 1-65535!", port));

        this.hostName = hostName;
        this.port = port;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.redis.connection.RedisConfiguration.WithHostAndPort#getHostName()
     */
    @Override
    public String getHostName() {
        return hostName;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.redis.connection.RedisConfiguration.WithHostAndPort#getPort()
     */
    @Override
    public int getPort() {
        return port;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.redis.connection.RedisConfiguration.WithHostAndPort#setHostName(java.lang.String)
     */
    @Override
    public void setHostName(String hostName) {
        this.hostName = hostName;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.redis.connection.RedisConfiguration.WithHostAndPort#setPort(int)
     */
    public void setPort(int port) {
        this.port = port;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.redis.connection.RedisConfiguration.WithDatabaseIndex#getDatabase()
     */
    @Override
    public int getDatabase() {
        return database;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.redis.connection.RedisConfiguration.WithDatabaseIndex#setDatabase(int)
     */
    @Override
    public void setDatabase(int index) {

        Assert.isTrue(index >= 0, () -> String.format("Invalid DB index '%s' (a positive index required)", index));

        this.database = index;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.redis.connection.RedisConfiguration.WithPassword#getPassword()
     */
    @Override
    public RedisPassword getPassword() {
        return password;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.redis.connection.RedisConfiguration.WithPassword#setPassword(org.springframework.data.redis.connection.RedisPassword)
     */
    @Override
    public void setPassword(RedisPassword password) {

        Assert.notNull(password, "RedisPassword must not be null!");

        this.password = password;
    }
}