Class WebOperationRequestPredicate

java.lang.Object

org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate

public final class WebOperationRequestPredicate
extends Object

A predicate for a request to an operation on a web endpoint.

Since:

2.0.0

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor	Description
WebOperationRequestPredicate(String path, WebEndpointHttpMethod httpMethod, Collection<String> consumes, Collection<String> produces)	Creates a new OperationRequestPredicate.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Collection<String>	getConsumes()	Returns the media types that the operation consumes.
WebEndpointHttpMethod	getHttpMethod()	Returns the HTTP method for the operation.
@Nullable String	getMatchAllRemainingPathSegmentsVariable()	Returns the name of the variable used to catch all remaining path segments or null.
String	getPath()	Returns the path for the operation.
Collection<String>	getProduces()	Returns the media types that the operation produces.
int	hashCode()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WebOperationRequestPredicate

public WebOperationRequestPredicate(String path,
 WebEndpointHttpMethod httpMethod,
 Collection<String> consumes,
 Collection<String> produces)

Creates a new OperationRequestPredicate.

Parameters:

path - the path for the operation

httpMethod - the HTTP method that the operation supports

consumes - the media types that the operation consumes

produces - the media types that the operation produces

Method Details

getPath

public String getPath()

Returns the path for the operation.

Returns:

the path

getMatchAllRemainingPathSegmentsVariable

public @Nullable String getMatchAllRemainingPathSegmentsVariable()

Returns the name of the variable used to catch all remaining path segments or null.

Returns:

the variable name

Since:

2.2.0

getHttpMethod

public WebEndpointHttpMethod getHttpMethod()

Returns the HTTP method for the operation.

Returns:

the HTTP method

getConsumes

public Collection<String> getConsumes()

Returns the media types that the operation consumes.

Returns:

the consumed media types

getProduces

public Collection<String> getProduces()

Returns the media types that the operation produces.

Returns:

the produced media types

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object