Package org.springframework.boot.actuate.endpoint

Class AbstractExposableEndpoint<O extends Operation>

java.lang.Object

org.springframework.boot.actuate.endpoint.AbstractExposableEndpoint<O>

Type Parameters:

O - the operation type.

All Implemented Interfaces:

ExposableEndpoint<O>

Direct Known Subclasses:

AbstractDiscoveredEndpoint

public abstract class AbstractExposableEndpoint<O extends Operation>
extends Object
implements ExposableEndpoint<O>

Abstract base class for ExposableEndpoint implementations.

Since:

2.0.0

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor	Description
AbstractExposableEndpoint(EndpointId id, boolean enabledByDefault, Collection<? extends O> operations)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 3.6.0 in favor of AbstractExposableEndpoint(EndpointId, Access, Collection)
AbstractExposableEndpoint(EndpointId id, Access defaultAccess, Collection<? extends O> operations)	Create a new AbstractExposableEndpoint instance.

Method Summary

Modifier and Type	Method	Description
Access	getDefaultAccess()	Returns the access to the endpoint that is permitted by default.
EndpointId	getEndpointId()	Return the endpoint ID.
Collection<O>	getOperations()	Returns the operations of the endpoint.
boolean	isEnableByDefault()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractExposableEndpoint

@Deprecated(since="3.4.0",
            forRemoval=true)
public AbstractExposableEndpoint(EndpointId id,
 boolean enabledByDefault,
 Collection<? extends O> operations)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.4.0 for removal in 3.6.0 in favor of AbstractExposableEndpoint(EndpointId, Access, Collection)

Create a new AbstractExposableEndpoint instance.

Parameters:

id - the endpoint id

enabledByDefault - if the endpoint is enabled by default

operations - the endpoint operations

AbstractExposableEndpoint

public AbstractExposableEndpoint(EndpointId id,
 Access defaultAccess,
 Collection<? extends O> operations)

Create a new AbstractExposableEndpoint instance.

Parameters:

id - the endpoint id

defaultAccess - access to the endpoint that is permitted by default

operations - the endpoint operations

Since:

3.4.0

Method Details

getEndpointId

public EndpointId getEndpointId()

Description copied from interface: ExposableEndpoint

Return the endpoint ID.

Specified by:

getEndpointId in interface ExposableEndpoint<O extends Operation>

Returns:

the endpoint ID

isEnableByDefault

@Deprecated(since="3.4.0",
            forRemoval=true)
public boolean isEnableByDefault()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ExposableEndpoint

Returns if the endpoint is enabled by default.

Specified by:

isEnableByDefault in interface ExposableEndpoint<O extends Operation>

Returns:

if the endpoint is enabled by default

getDefaultAccess

public Access getDefaultAccess()

Description copied from interface: ExposableEndpoint

Returns the access to the endpoint that is permitted by default.

Specified by:

getDefaultAccess in interface ExposableEndpoint<O extends Operation>

Returns:

access that is permitted by default

getOperations

public Collection<O> getOperations()

Description copied from interface: ExposableEndpoint

Returns the operations of the endpoint.

Specified by:

getOperations in interface ExposableEndpoint<O extends Operation>

Returns:

the operations