org.springframework.boot.actuate.endpoint.mvc

Class EndpointHandlerMapping

java.lang.Object

RequestMappingHandlerMapping

org.springframework.boot.actuate.endpoint.mvc.EndpointHandlerMapping

All Implemented Interfaces:

Aware, ApplicationContextAware

public class EndpointHandlerMapping
extends RequestMappingHandlerMapping
implements ApplicationContextAware

HandlerMapping to map Endpoints to URLs via Endpoint.getId(). The semantics of @RequestMapping should be identical to a normal @Controller, but the endpoints should not be annotated as @Controller (otherwise they will be mapped by the normal MVC mechanisms).

One of the aims of the mapping is to support endpoints that work as HTTP endpoints but can still provide useful service interfaces when there is no HTTP server (and no Spring MVC on the classpath). Note that any endpoints having method signaturess will break in a non-servlet environment.

Author:

Phillip Webb, Christian Dupuis, Dave Syer

Constructor Summary

Constructors

Constructor and Description
EndpointHandlerMapping(Collection<? extends MvcEndpoint> endpoints) Create a new EndpointHandlerMapping instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
Set<? extends MvcEndpoint>	getEndpoints() Return the endpoints
String	getPath(String endpoint)
String	getPrefix()
boolean	isDisabled() Returns if this mapping is disabled.
protected boolean	isHandler(Class<?> beanType) Since all handler beans are passed into the constructor there is no need to detect anything here
boolean	isPrincipalHandler(HttpServletRequest request) Returns true if the given request is mapped to an endpoint and to a method that includes a Principal argument.
protected void	registerHandlerMethod(Object handler, Method method, RequestMappingInfo mapping)
void	setDisabled(boolean disabled) Sets if this mapping is disabled.
void	setPrefix(String prefix)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Constructor Detail

EndpointHandlerMapping

public EndpointHandlerMapping(Collection<? extends MvcEndpoint> endpoints)

Create a new EndpointHandlerMapping instance. All Endpoints will be detected from the ApplicationContext.

Parameters:

endpoints -

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

isHandler

protected boolean isHandler(Class<?> beanType)

Since all handler beans are passed into the constructor there is no need to detect anything here

registerHandlerMethod

protected void registerHandlerMethod(Object handler,
                         Method method,
                         RequestMappingInfo mapping)

isPrincipalHandler

public boolean isPrincipalHandler(HttpServletRequest request)

Returns true if the given request is mapped to an endpoint and to a method that includes a Principal argument.

Parameters:

request - the http request

Returns:

true if the request is

setPrefix

public void setPrefix(String prefix)

Parameters:

prefix - the prefix to set

getPrefix

public String getPrefix()

Returns:

the prefix used in mappings

getPath

public String getPath(String endpoint)

Returns:

the path used in mappings

setDisabled

public void setDisabled(boolean disabled)

Sets if this mapping is disabled.

isDisabled

public boolean isDisabled()

Returns if this mapping is disabled.

getEndpoints

public Set<? extends MvcEndpoint> getEndpoints()

Return the endpoints