com.unboundid.util.ssl.cert.X509CertificateVersion Maven / Gradle / Ivy
/*
* Copyright 2017-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2017-2024 Ping Identity Corporation
*
* 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.
*/
/*
* Copyright (C) 2017-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.util.ssl.cert;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This enum defines a set of supported X.509 certificate versions.
*/
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public enum X509CertificateVersion
{
/**
* The X.509 v1 certificate version.
*/
V1(0, "v1"),
/**
* The X.509 v2 certificate version.
*/
V2(1, "v2"),
/**
* The X.509 v3 certificate version.
*/
V3(2, "v3");
// The integer value for this certificate version, as used in the encoded
// X.509 certificate.
private final int intValue;
// The name for this X.509 certificate version.
@NotNull private final String name;
/**
* Creates a new X.509 certificate version with the provided information.
*
* @param intValue The integer value for the certificate version. Note that
* this is the integer value that is used in the encoded
* certificate, and not the logical version number that the
* encoded value represents (for example, the "v1"
* certificate version has an integer value of 0 rather than
* 1).
* @param name The name for this certificate version. It must not be
* {@code null}.
*/
X509CertificateVersion(final int intValue, @NotNull final String name)
{
this.intValue = intValue;
this.name = name;
}
/**
* Retrieves the integer value for this certificate version. Note that this
* is the integer value that is used in the encoded certificate, and not the
* logical version number that the encoded value represents (for example, the
* "v1" certificate version has an integer value of 0 rather than 1).
*
* @return The integer value for this certificate version.
*/
int getIntValue()
{
return intValue;
}
/**
* Retrieves the name for this certificate version.
*
* @return The name for this certificate version.
*/
@NotNull()
public String getName()
{
return name;
}
/**
* Retrieves the certificate version for the provided integer value.
*
* @param intValue The integer value for the certificate version to
* retrieve. Note that this is the integer value that is
* used in the encoded certificate, and not the logical
* version number that the encoded value represents (for
* example, the "v1" certificate version has an integer
* value of 0 rather than 1).
*
* @return The certificate version for the provided integer value, or
* {@code null} if the provided version does not correspond to any
* known certificate value.
*/
@Nullable()
static X509CertificateVersion valueOf(final int intValue)
{
for (final X509CertificateVersion v : values())
{
if (v.intValue == intValue)
{
return v;
}
}
return null;
}
/**
* Retrieves the X.509 certificate version with the specified name.
*
* @param name The name of the X.509 certificate version to retrieve. It
* must not be {@code null}.
*
* @return The requested X.509 certificate version, or {@code null} if no
* such version is defined.
*/
@Nullable()
public static X509CertificateVersion forName(@NotNull final String name)
{
switch (StaticUtils.toLowerCase(name))
{
case "1":
case "v1":
return V1;
case "2":
case "v2":
return V2;
case "3":
case "v3":
return V3;
default:
return null;
}
}
}