Package org.springframework.boot.actuate.endpoint.annotation

Class AbstractDiscoveredEndpoint<O extends Operation>

java.lang.Object

org.springframework.boot.actuate.endpoint.AbstractExposableEndpoint<O>

org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredEndpoint<O>

Type Parameters:

O - the operation type

All Implemented Interfaces:

DiscoveredEndpoint<O>, ExposableEndpoint<O>

public abstract class AbstractDiscoveredEndpoint<O extends Operation>
extends AbstractExposableEndpoint<O>
implements DiscoveredEndpoint<O>

Abstract base class for endpoints discovered by a EndpointDiscoverer.

Since:

2.0.0

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor	Description
AbstractDiscoveredEndpoint(EndpointDiscoverer<?,?> discoverer, Object endpointBean, EndpointId id, boolean enabledByDefault, Collection<? extends O> operations)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 3.6.0 in favor of AbstractDiscoveredEndpoint(EndpointDiscoverer, Object, EndpointId, Access, Collection)
AbstractDiscoveredEndpoint(EndpointDiscoverer<?,?> discoverer, Object endpointBean, EndpointId id, Access defaultAccess, Collection<? extends O> operations)	Create a new AbstractDiscoveredEndpoint instance.

Method Summary

Modifier and Type	Method	Description
protected void	appendFields(ToStringCreator creator)
Object	getEndpointBean()	Return the source bean that was used to construct the DiscoveredEndpoint.
String	toString()
boolean	wasDiscoveredBy(Class<? extends EndpointDiscoverer<?,?>> discoverer)	Return true if the endpoint was discovered by the specified discoverer.

Methods inherited from class org.springframework.boot.actuate.endpoint.AbstractExposableEndpoint

getDefaultAccess, getEndpointId, getOperations, isEnableByDefault

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.actuate.endpoint.ExposableEndpoint

getDefaultAccess, getEndpointId, getOperations, isEnableByDefault

Constructor Details

AbstractDiscoveredEndpoint

@Deprecated(since="3.4.0",
            forRemoval=true)
public AbstractDiscoveredEndpoint(EndpointDiscoverer<?,?> discoverer,
 Object endpointBean,
 EndpointId id,
 boolean enabledByDefault,
 Collection<? extends O> operations)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.4.0 for removal in 3.6.0 in favor of AbstractDiscoveredEndpoint(EndpointDiscoverer, Object, EndpointId, Access, Collection)

Create a new AbstractDiscoveredEndpoint instance.

Parameters:

discoverer - the discoverer that discovered the endpoint

endpointBean - the primary source bean

id - the ID of the endpoint

enabledByDefault - if the endpoint is enabled by default

operations - the endpoint operations

AbstractDiscoveredEndpoint

public AbstractDiscoveredEndpoint(EndpointDiscoverer<?,?> discoverer,
 Object endpointBean,
 EndpointId id,
 Access defaultAccess,
 Collection<? extends O> operations)

Create a new AbstractDiscoveredEndpoint instance.

Parameters:

discoverer - the discoverer that discovered the endpoint

endpointBean - the primary source bean

id - the ID of the endpoint

defaultAccess - access to the endpoint that is permitted by default

operations - the endpoint operations

Since:

3.4.0

Method Details

getEndpointBean

public Object getEndpointBean()

Description copied from interface: DiscoveredEndpoint

Return the source bean that was used to construct the DiscoveredEndpoint.

Specified by:

getEndpointBean in interface DiscoveredEndpoint<O extends Operation>

Returns:

the source endpoint bean

wasDiscoveredBy

public boolean wasDiscoveredBy(Class<? extends EndpointDiscoverer<?,?>> discoverer)

Description copied from interface: DiscoveredEndpoint

Return true if the endpoint was discovered by the specified discoverer.

Specified by:

wasDiscoveredBy in interface DiscoveredEndpoint<O extends Operation>

Parameters:

discoverer - the discoverer type

Returns:

true if discovered using the specified discoverer

toString

public String toString()

Overrides:

toString in class Object

appendFields

protected void appendFields(ToStringCreator creator)