org.springframework.boot.actuate.endpoint.mvc

Class LinksMvcEndpoint

java.lang.Object

org.springframework.boot.actuate.endpoint.mvc.LinksMvcEndpoint

All Implemented Interfaces:

MvcEndpoint

@ConfigurationProperties(value="endpoints.links")
public class LinksMvcEndpoint
extends Object
implements MvcEndpoint

MvcEndpoint to add hypermedia links.

Since:

1.3.0

Author:

Dave Syer

Field Summary

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

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
LinksMvcEndpoint(String defaultPath)

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.
boolean	isSensitive() Return if the endpoint exposes sensitive information.
org.springframework.hateoas.ResourceSupport	links()
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

LinksMvcEndpoint

public LinksMvcEndpoint(String defaultPath)

Method Detail

links

@RequestMapping(value={"/",""},
                produces="application/json")
 @ResponseBody
public org.springframework.hateoas.ResourceSupport links()

setPath

public void setPath(String path)

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

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