org.springframework.boot.actuate.endpoint.mvc

Class AbstractEndpointMvcAdapter<E extends Endpoint<?>>

java.lang.Object

org.springframework.boot.actuate.endpoint.mvc.AbstractEndpointMvcAdapter<E>

Type Parameters:

E - the delegate endpoint

All Implemented Interfaces:

MvcEndpoint, NamedMvcEndpoint

Direct Known Subclasses:

EndpointMvcAdapter, HealthMvcEndpoint

public abstract class AbstractEndpointMvcAdapter<E extends Endpoint<?>>
extends Object
implements NamedMvcEndpoint

Abstract base class for MvcEndpoint implementations.

Since:

1.3.0

Author:

Dave Syer, Andy Wilkinson, Phillip Webb

Field Summary

Fields inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
AbstractEndpointMvcAdapter(E delegate) Create a new EndpointMvcAdapter.

Method Summary

Modifier and Type	Method and Description
E	getDelegate()
protected ResponseEntity<?>	getDisabledResponse() Returns the response that should be returned when the endpoint is disabled.
Class<? extends Endpoint>	getEndpointType() Return the type of Endpoint exposed, or null if this MvcEndpoint exposes information that cannot be represented as a traditional Endpoint.
String	getName() Return the logical name of the endpoint.
String	getPath() Return the MVC path of the endpoint.
protected Object	invoke()
boolean	isSensitive() Return if the endpoint exposes sensitive information.
void	setPath(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEndpointMvcAdapter

public AbstractEndpointMvcAdapter(E delegate)

Create a new EndpointMvcAdapter.

Parameters:

delegate - the underlying Endpoint to adapt.

Method Detail

invoke

protected Object invoke()

getDelegate

public E getDelegate()

getName

public String getName()

Description copied from interface: NamedMvcEndpoint

Return the logical name of the endpoint. Names should be non-null, non-empty, alpha-numeric values.

Specified by:

getName in interface NamedMvcEndpoint

Returns:

the logical name of the endpoint

getPath

public String getPath()

Description copied from interface: MvcEndpoint

Return the MVC path of the endpoint.

Specified by:

getPath in interface MvcEndpoint

Returns:

the endpoint path

setPath

public void setPath(String path)

isSensitive

public boolean isSensitive()

Description copied from interface: MvcEndpoint

Return if the endpoint exposes sensitive information.

Specified by:

isSensitive in interface MvcEndpoint

Returns:

if the endpoint is sensitive

getEndpointType

public Class<? extends Endpoint> getEndpointType()

Description copied from interface: MvcEndpoint

Return the type of Endpoint exposed, or null if this MvcEndpoint exposes information that cannot be represented as a traditional Endpoint.

Specified by:

getEndpointType in interface MvcEndpoint

Returns:

the endpoint type

getDisabledResponse

protected ResponseEntity<?> getDisabledResponse()

Returns the response that should be returned when the endpoint is disabled.

Returns:

the response to be returned when the endpoint is disabled

Since:

1.2.4

See Also:

Endpoint.isEnabled()