com.hazelcast.config.SSLConfig Maven / Gradle / Ivy
Show all versions of hazelcast-all Show documentation
/*
* Copyright (c) 2008-2020, Hazelcast, Inc. All Rights Reserved.
*
* 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
*
* 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.hazelcast.config;
import javax.annotation.Nonnull;
import java.util.Objects;
import java.util.Properties;
import static com.hazelcast.internal.util.Preconditions.checkHasText;
import static com.hazelcast.internal.util.Preconditions.checkNotNull;
/**
* SSL configuration.
*/
public final class SSLConfig {
private boolean enabled;
private String factoryClassName;
private Object factoryImplementation;
private Properties properties = new Properties();
public SSLConfig() {
}
public SSLConfig(SSLConfig sslConfig) {
enabled = sslConfig.enabled;
factoryClassName = sslConfig.factoryClassName;
factoryImplementation = sslConfig.factoryImplementation;
properties = new Properties();
properties.putAll(sslConfig.properties);
}
/**
* Returns the name of the implementation class.
*
* Class can either be an {@link com.hazelcast.nio.ssl.SSLContextFactory} or {@code com.hazelcast.nio.ssl.SSLEngineFactory}
* (Enterprise edition).
*
* @return the name implementation class
*/
public String getFactoryClassName() {
return factoryClassName;
}
/**
* Sets the name for the implementation class.
*
* Class can either be an {@link com.hazelcast.nio.ssl.SSLContextFactory} or {@code com.hazelcast.nio.ssl.SSLEngineFactory}
* (Enterprise edition).
*
* @param factoryClassName the name implementation class
*/
public SSLConfig setFactoryClassName(@Nonnull String factoryClassName) {
this.factoryClassName = checkHasText(factoryClassName, "SSL context factory class name cannot be null!");
this.factoryImplementation = null;
return this;
}
/**
* Returns if this configuration is enabled.
*
* @return {@code true} if enabled, {@code false} otherwise
*/
public boolean isEnabled() {
return enabled;
}
/**
* Enables and disables this configuration.
*
* @param enabled {@code true} to enable, {@code false} to disable
*/
public SSLConfig setEnabled(boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* Sets the implementation object.
*
* Object must be instance of an {@link com.hazelcast.nio.ssl.SSLContextFactory} or
* {@code com.hazelcast.nio.ssl.SSLEngineFactory} (Enterprise edition).
*
* @param factoryImplementation the implementation object
* @return this SSLConfig instance
*/
public SSLConfig setFactoryImplementation(@Nonnull Object factoryImplementation) {
this.factoryImplementation = checkNotNull(factoryImplementation, "SSL context factory cannot be null!");
this.factoryClassName = null;
return this;
}
/**
* Returns the factory implementation object.
*
* Object is instance of an {@link com.hazelcast.nio.ssl.SSLContextFactory} or {@code com.hazelcast.nio.ssl.SSLEngineFactory}
* (Enterprise edition).
*
* @return the factory implementation object
*/
public Object getFactoryImplementation() {
return factoryImplementation;
}
/**
* Sets a property.
*
* @param name the name of the property to set
* @param value the value of the property to set
* @return the updated SSLConfig
* @throws NullPointerException if name or value is {@code null}
*/
public SSLConfig setProperty(String name, String value) {
properties.put(name, value);
return this;
}
/**
* Gets a property.
*
* @param name the name of the property to get
* @return the value of the property, null if not found
* @throws NullPointerException if name is {@code null}
*/
public String getProperty(String name) {
return properties.getProperty(name);
}
/**
* Gets all properties.
*
* @return the properties
*/
public Properties getProperties() {
return properties;
}
/**
* Sets the properties.
*
* @param properties the properties to set
* @return the updated SSLConfig
* @throws IllegalArgumentException if properties is {@code null}
*/
public SSLConfig setProperties(Properties properties) {
if (properties == null) {
throw new IllegalArgumentException("properties can't be null");
}
this.properties = properties;
return this;
}
@Override
public String toString() {
return "SSLConfig{"
+ "className='" + factoryClassName + '\''
+ ", enabled=" + enabled
+ ", implementation=" + factoryImplementation
+ ", properties=" + properties
+ '}';
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
SSLConfig sslConfig = (SSLConfig) o;
return Objects.equals(enabled, sslConfig.enabled)
&& Objects.equals(properties, sslConfig.properties)
&& Objects.equals(factoryImplementation, sslConfig.factoryImplementation)
&& Objects.equals(factoryClassName, sslConfig.factoryClassName);
}
@Override
public int hashCode() {
return Objects.hash(enabled, factoryImplementation, factoryClassName, properties);
}
}