Package com.pixelservices.flash.components.http

Class HandlerSpecification

java.lang.Object

com.pixelservices.flash.components.http.HandlerSpecification

public class HandlerSpecification
extends Object

Represents the specification for a request handler, including details about the endpoint, HTTP method, and expected request structure.

Constructor Summary

Constructors

Constructor	Description
HandlerSpecification(RequestHandler requestHandler, String endpoint, HttpMethod method, boolean enforcedNonNullBody)	Constructs a HandlerSpecification for a given request handler, endpoint, HTTP method, and body enforcement policy.

Method Summary

Modifier and Type	Method	Description
String	getEndpoint()	Retrieves the endpoint for this handler.
Map<String,ExpectedBodyField>	getExpectedBodyFields()	Retrieves the expected body fields for this handler.
Map<String,ExpectedBodyFile>	getExpectedBodyFiles()	Retrieves the expected body files for this handler.
Map<String,ExpectedRequestParameter>	getExpectedRequestParameters()	Retrieves the expected request parameters for this handler.
HttpMethod	getMethod()	Retrieves the HTTP method for this handler.
boolean	isEnforcedNonNullBody()	Indicates whether a non-null body is enforced for requests.
String	toString()	Returns a string representation of the HandlerSpecification, including endpoint, HTTP method, expected request details, and body enforcement status.

Methods inherited from class java.lang.Object

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

Constructor Details

HandlerSpecification

public HandlerSpecification(RequestHandler requestHandler,
 String endpoint,
 HttpMethod method,
 boolean enforcedNonNullBody)

Constructs a HandlerSpecification for a given request handler, endpoint, HTTP method, and body enforcement policy.

Parameters:

requestHandler - the associated RequestHandler

endpoint - the endpoint for this handler

method - the HTTP method (e.g., GET, POST)

enforcedNonNullBody - whether a non-null body is enforced

Method Details

getEndpoint

public String getEndpoint()

Retrieves the endpoint for this handler.

Returns:

the endpoint

getMethod

public HttpMethod getMethod()

Retrieves the HTTP method for this handler.

Returns:

the HTTP method

isEnforcedNonNullBody

public boolean isEnforcedNonNullBody()

Indicates whether a non-null body is enforced for requests.

Returns:

true if a non-null body is enforced, otherwise false

getExpectedRequestParameters

public Map<String,ExpectedRequestParameter> getExpectedRequestParameters()

Retrieves the expected request parameters for this handler.

Returns:

a map of parameter names to their specifications

getExpectedBodyFields

public Map<String,ExpectedBodyField> getExpectedBodyFields()

Retrieves the expected body fields for this handler.

Returns:

a map of field names to their specifications

getExpectedBodyFiles

public Map<String,ExpectedBodyFile> getExpectedBodyFiles()

Retrieves the expected body files for this handler.

Returns:

a map of file names to their specifications

toString

public String toString()

Returns a string representation of the HandlerSpecification, including endpoint, HTTP method, expected request details, and body enforcement status.

Overrides:

toString in class Object

Returns:

a string representation of the specification