Interface ProtocolHandler

All Known Implementing Classes:

ClasspathProtocolHandler, FileProtocolHandler, HttpProtocolHandler

public interface ProtocolHandler

An interface representing a handler for specific URI protocols. Implementations of this interface are responsible for processing URIs that match their supported protocol schemes.

See Also:

• ResourceResolver
• ResourceResponse

Method Summary

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

Method Details

matches

boolean matches(@NotNull
 @NotNull URI uri)

Determines if this ProtocolHandler can handle the given URI.

Parameters:

uri - The URI to check.

Returns:

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

handle

@NotNull
@NotNull CompletableFuture<ResourceResponse> handle(@NotNull
 @NotNull ResourceRequest request)
                                             throws NullPointerException,
IllegalArgumentException

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

Parameters:

request - The ResourceRequest to handle.

Throws:

NullPointerException - If the argument is null.

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