org.wildfly.security.ssl.Protocol Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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 org.wildfly.security.ssl;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
/**
* The protocol type for SSL/TLS cipher suite selection and protocol selection.
*
* @author David M. Lloyd
*/
public enum Protocol {
/**
* The SSL version 2 protocol.
*/
SSLv2 ("SSLV2"),
/**
* The SSL version 3 protocol.
*/
SSLv3 ("SSLV3"),
/**
* The TLS version 1.0 protocol.
*/
TLSv1 ("TLSV1"),
/**
* The TLS version 1.1 protocol. Note that there are no cipher suites which are specifically defined in this protocol.
*/
TLSv1_1 ("TLSV1.1"),
/**
* The TLS version 1.2 protocol.
*/
TLSv1_2 ("TLSV1.2"),
/**
* The TLS version 1.3 protocol.
*/
TLSv1_3 ("TLSV1.3"),
/**
* The SSL version 2 hello protocol
*/
SSLv2Hello("SSLV2HELLO")
;
static final int fullSize = values().length;
static final Map map;
static {
map = new HashMap<>();
Protocol[] protocols = values();
for (int i = 0; i < fullSize; i++) {
map.put(protocols[i].name, protocols[i]);
}
}
public final String name;
Protocol(String name) {
this.name = name;
}
/**
* Gets an enum item for given protocol name.
*
* @param name the protocol name
* @return an enum item
*/
public static Protocol forName(final String name) {
return name == null ? null : map.get(name.toUpperCase(Locale.ENGLISH));
}
/**
* Determine whether the given set is "full" (meaning it contains all possible values).
*
* @param protocols the set
* @return {@code true} if the set is full, {@code false} otherwise
*/
public static boolean isFull(final EnumSet protocols) {
return protocols != null && protocols.size() == fullSize;
}
/**
* Determine whether this instance is equal to one of the given instances.
*
* @param value1 the first instance
* @param value2 the second instance
* @return {@code true} if one of the instances matches this one, {@code false} otherwise
*/
public boolean in(final Protocol value1, final Protocol value2) {
return this == value1 || this == value2;
}
/**
* Determine whether this instance is equal to one of the given instances.
*
* @param value1 the first instance
* @param value2 the second instance
* @param value3 the third instance
* @return {@code true} if one of the instances matches this one, {@code false} otherwise
*/
public boolean in(final Protocol value1, final Protocol value2, final Protocol value3) {
return this == value1 || this == value2 || this == value3;
}
/**
* Determine whether this instance is equal to one of the given instances.
*
* @param values the values to match against
* @return {@code true} if one of the instances matches this one, {@code false} otherwise
*/
public boolean in(final Protocol... values) {
if (values != null) for (Protocol value : values) {
if (this == value) return true;
}
return false;
}
}