org.springframework.boot.actuate.endpoint.mvc

Class EndpointMvcAdapter

java.lang.Object

org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter

All Implemented Interfaces:

MvcEndpoint

Direct Known Subclasses:

EnvironmentMvcEndpoint, MetricsMvcEndpoint, ShutdownMvcEndpoint

public class EndpointMvcAdapter
extends Object
implements MvcEndpoint

Adapter class to expose Endpoints as MvcEndpoints.

Author:

Dave Syer, Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
EndpointMvcAdapter(Endpoint<?> delegate) Create a new EndpointMvcAdapter.

Method Summary

Methods

Modifier and Type	Method and Description
Endpoint<?>	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	getPath() Return the MVC path of the endpoint.
Object	invoke()
boolean	isSensitive() Return if the endpoint exposes sensitive information.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointMvcAdapter

public EndpointMvcAdapter(Endpoint<?> delegate)

Create a new EndpointMvcAdapter.

Parameters:

delegate - the underlying Endpoint to adapt.

Method Detail

invoke

@RequestMapping(method=GET)
@ResponseBody
public Object invoke()

getDelegate

public Endpoint<?> getDelegate()

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

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()