org.opencms.site

Enum CmsSSLMode

java.lang.Object

java.lang.Enum<CmsSSLMode>

org.opencms.site.CmsSSLMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsSSLMode>

public enum CmsSSLMode
extends java.lang.Enum<CmsSSLMode>

Enumeration for different SSL Modes of sites.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LETS_ENCRYPT Encryption via Let's encrypt.
MANUAL Manual ssl configuration of server.
MANUAL_EP_TERMINATION Manual ssl configuration of server with endpoint termination.
NO No encryption.
SECURE_SERVER Encryption via secure server (the old OpenCms way).

Method Summary

Modifier and Type	Method and Description
static java.util.List<CmsSSLMode>	availableModes(boolean includeOldStyle, boolean includeLetsEncrypt) List of all available modes.
static CmsSSLMode	getDefault() The default SSL Mode.
java.lang.String	getLocalizedMessage() Gets localized message.
static CmsSSLMode	getModeFromXML(java.lang.String xmlValue) Gets CmsSSLMode from given XML value.
java.lang.String	getXMLValue() Gets the XML value.
boolean	isSecure() Returns if SSL Mode is secure.
static CmsSSLMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CmsSSLMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO

public static final CmsSSLMode NO

No encryption.

MANUAL

public static final CmsSSLMode MANUAL

Manual ssl configuration of server.

MANUAL_EP_TERMINATION

public static final CmsSSLMode MANUAL_EP_TERMINATION

Manual ssl configuration of server with endpoint termination.

LETS_ENCRYPT

public static final CmsSSLMode LETS_ENCRYPT

Encryption via Let's encrypt.

SECURE_SERVER

public static final CmsSSLMode SECURE_SERVER

Encryption via secure server (the old OpenCms way).

Method Detail

values

public static CmsSSLMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CmsSSLMode c : CmsSSLMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CmsSSLMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

availableModes

public static java.util.List<CmsSSLMode> availableModes(boolean includeOldStyle,
                                                        boolean includeLetsEncrypt)

List of all available modes.

Parameters:

includeOldStyle - include old Secure Server Styles?

includeLetsEncrypt - if true, include the LETS_ENCRYPT mode in the result

Returns:

List -- the list of available modes

getDefault

public static CmsSSLMode getDefault()

The default SSL Mode.

Returns:

CmsSSLMode

getModeFromXML

public static CmsSSLMode getModeFromXML(java.lang.String xmlValue)

Gets CmsSSLMode from given XML value.

Parameters:

xmlValue - to get CmsSSLMode for

Returns:

CmsSSLMode

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Gets localized message.

Returns:

localized message

getXMLValue

public java.lang.String getXMLValue()

Gets the XML value.

Returns:

the XML value

isSecure

public boolean isSecure()

Returns if SSL Mode is secure.

Returns:

true if secure