org.springframework.boot.actuate.endpoint.mvc

Class LogFileMvcEndpoint

java.lang.Object

org.springframework.boot.actuate.endpoint.mvc.LogFileMvcEndpoint

All Implemented Interfaces:

Aware, MvcEndpoint, EnvironmentAware

@ConfigurationProperties(prefix="endpoints.logfile")
public class LogFileMvcEndpoint
extends Object
implements MvcEndpoint, EnvironmentAware

Controller that provides an API for logfiles, i.e. downloading the main logfile configured in environment property 'logging.file' that is standard, but optional property for spring-boot applications.

Since:

1.3.0

Author:

Johannes Edmeier, Phillip Webb

Field Summary

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

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
LogFileMvcEndpoint()

Method Summary

Modifier and Type	Method and Description
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.
void	invoke(HttpServletRequest request, HttpServletResponse response)
boolean	isEnabled()
boolean	isSensitive() Return if the endpoint exposes sensitive information.
void	setEnabled(boolean enabled)
void	setEnvironment(Environment environment)
void	setPath(String path)
void	setSensitive(Boolean sensitive)

Methods inherited from class java.lang.Object

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

Constructor Detail

LogFileMvcEndpoint

public LogFileMvcEndpoint()

Method Detail

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

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)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

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

setSensitive

public void setSensitive(Boolean 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

invoke

@RequestMapping(method={GET,HEAD})
public void invoke(HttpServletRequest request,
                                                      HttpServletResponse response)
                                               throws ServletException,
                                                      IOException

Throws:

ServletException

IOException