Package org.springframework.boot.actuate.autoconfigure.web.server

Enum ManagementPortType

java.lang.Object

java.lang.Enum<ManagementPortType>

org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType

All Implemented Interfaces:

Serializable, Comparable<ManagementPortType>, Constable

public enum ManagementPortType
extends Enum<ManagementPortType>

Port types that can be used to control how the management server is started.

Since:

2.0.0

Author:

Andy Wilkinson

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIFFERENT	The management port and server port are different.
DISABLED	The management port has been disabled.
SAME	The management port is the same as the server port.

Method Summary

Modifier and Type	Method	Description
static ManagementPortType	get(Environment environment)	Look at the given environment to determine if the ManagementPortType is DISABLED, SAME or DIFFERENT.
static ManagementPortType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ManagementPortType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final ManagementPortType DISABLED

The management port has been disabled.

SAME

public static final ManagementPortType SAME

The management port is the same as the server port.

DIFFERENT

public static final ManagementPortType DIFFERENT

The management port and server port are different.

Method Details

values

public static ManagementPortType[] values()

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

Returns:

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

valueOf

public static ManagementPortType valueOf(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:

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

NullPointerException - if the argument is null

get

public static ManagementPortType get(Environment environment)

Look at the given environment to determine if the ManagementPortType is DISABLED, SAME or DIFFERENT.

Parameters:

environment - the Spring environment

Returns:

DISABLED if management.server.port is set to a negative value, SAME if management.server.port is not specified or equal to server.port and DIFFERENT otherwise.

Since:

2.1.4