Class HttpProtocolHandler

java.lang.Object

com.thecsdev.common.resource.protocol.HttpProtocolHandler

All Implemented Interfaces:

ProtocolHandler

public class HttpProtocolHandler
extends Object
implements ProtocolHandler

A ProtocolHandler implementation for handling "http" and "https" protocol URIs. This handler processes HTTP and HTTPS requests and returns their responses as ResourceResponse objects.

See Also:

• URI.getScheme()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEADER_HTTP_METHOD	The HTTP header key used to specify the HTTP method (e.g., GET, POST, PUT, DELETE) for the request.
static final HttpProtocolHandler	INSTANCE	The main singleton instance of HttpProtocolHandler.
static final int	STATUS_ERROR	A general I/O failure or error occurred while accessing the file.
static final int	STATUS_FORBIDDEN	Access denied; the system refused to open the file due to insufficient permissions.
static final int	STATUS_NOT_FOUND	The specified path does not exist or the file is missing.
static final int	STATUS_OK	Resource found and read successfully from the filesystem.

Method Summary

Modifier and Type	Method	Description
final @NotNull CompletableFuture<ResourceResponse>	handle(@NotNull ResourceRequest rssReq)	Handles the given ResourceRequest and returns a CompletableFuture that will complete with a ResourceResponse.
final boolean	matches(@NotNull URI uri)	Determines if this ProtocolHandler can handle the given URI.

Methods inherited from class Object

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

Field Details

INSTANCE

public static final HttpProtocolHandler INSTANCE

The main singleton instance of HttpProtocolHandler.

HEADER_HTTP_METHOD

public static final String HEADER_HTTP_METHOD

The HTTP header key used to specify the HTTP method (e.g., GET, POST, PUT, DELETE) for the request. If not provided, the default method is "GET".

See Also:

• Constant Field Values

STATUS_OK

public static final int STATUS_OK

Resource found and read successfully from the filesystem.

See Also:

• Constant Field Values

STATUS_FORBIDDEN

public static final int STATUS_FORBIDDEN

Access denied; the system refused to open the file due to insufficient permissions.

See Also:

• Constant Field Values

STATUS_NOT_FOUND

public static final int STATUS_NOT_FOUND

The specified path does not exist or the file is missing.

See Also:

• Constant Field Values

STATUS_ERROR

public static final int STATUS_ERROR

A general I/O failure or error occurred while accessing the file.

See Also:

• Constant Field Values

Method Details

matches

public final boolean matches(@NotNull
 @NotNull URI uri)

Description copied from interface: ProtocolHandler

Determines if this ProtocolHandler can handle the given URI.

Specified by:

matches in interface ProtocolHandler

Parameters:

uri - The URI to check.

Returns:

true if this handler can process the URI; false otherwise.

handle

@NotNull
public final @NotNull CompletableFuture<ResourceResponse> handle(@NotNull
 @NotNull ResourceRequest rssReq)
                                                          throws NullPointerException,
IllegalArgumentException

Description copied from interface: ProtocolHandler

Handles the given ResourceRequest and returns a CompletableFuture that will complete with a ResourceResponse.

Specified by:

handle in interface ProtocolHandler

Parameters:

rssReq - The ResourceRequest to handle.

Throws:

NullPointerException - If the argument is null.

IllegalArgumentException - If URI.getScheme() of the ResourceMessage.getUri() is unsupported.