Class ResourceMethod

java.lang.Object

com.soklet.ResourceMethod

@ThreadSafe
public final class ResourceMethod
extends Object

Represents a Resource Method, which is a Java Method invoked by Soklet to handle an HTTP request.

Instances can be acquired via the withComponents(HttpMethod, ResourcePathDeclaration, Method, Boolean) factory method.

Detailed documentation available at https://www.soklet.com/docs/request-handling.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
HttpMethod	getHttpMethod()	Returns the HTTP method for this Resource Method.
Method	getMethod()	Returns the Java method to invoke for the combination of HTTP method and resource path.
ResourcePathDeclaration	getResourcePathDeclaration()	Returns the HTTP path for this Resource Method, which might contain placeholders - for example, /example/{exampleId}.
int	hashCode()
Boolean	isServerSentEventSource()	Returns whether this Resource Method functions as a Server-Sent Event Source.
String	toString()
static ResourceMethod	withComponents(HttpMethod httpMethod, ResourcePathDeclaration resourcePathDeclaration, Method method, Boolean serverSentEventSource)	Vends a Resource Method given its unique components.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withComponents

@Nonnull
public static ResourceMethod withComponents(@Nonnull
 HttpMethod httpMethod,
 @Nonnull
 ResourcePathDeclaration resourcePathDeclaration,
 @Nonnull
 Method method,
 @Nonnull
 Boolean serverSentEventSource)

Vends a Resource Method given its unique components.

Parameters:

httpMethod - an HTTP method

resourcePathDeclaration - an HTTP path which might contain placeholders, e.g. /example/{exampleId}

method - a Java method to invoke for the combination of HTTP method and resource path

serverSentEventSource - is this Resource Method configured as a Server-Sent Event source?

Returns:

a Resource Method for the supplied components

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getHttpMethod

@Nonnull
public HttpMethod getHttpMethod()

Returns the HTTP method for this Resource Method.

Returns:

the HTTP method

getResourcePathDeclaration

@Nonnull
public ResourcePathDeclaration getResourcePathDeclaration()

Returns the HTTP path for this Resource Method, which might contain placeholders - for example, /example/{exampleId}.

Returns:

the HTTP path

getMethod

@Nonnull
public Method getMethod()

Returns the Java method to invoke for the combination of HTTP method and resource path.

Returns:

the Java method to invoke

isServerSentEventSource

@Nonnull
public Boolean isServerSentEventSource()

Returns whether this Resource Method functions as a Server-Sent Event Source.

Returns:

true if this Resource Method functions as a Server-Sent Event Source, false otherwise