- All Superinterfaces:
org.refcodes.web.BasicAuthObserver
,org.refcodes.web.HttpMethodAccessor
- All Known Implementing Classes:
BasicAuthEndpointBuilder
public interface BasicAuthEndpoint
extends org.refcodes.web.BasicAuthObserver, org.refcodes.web.HttpMethodAccessor
A
BasicAuthEndpoint
subscribes to a RestfulServer
(
RestfulHttpServer
) and defines the target for a Basic-Auth request.
Therefore the BasicAuthEndpoint
describes the HttpMethod
, the
locator (pattern) to which to respond as well as a BasicAuthObserver
responsible for processing the request. The BasicAuthObserver
is
invoked as soon as a request with the given HttpMethod
for a locator
matching the given Locator-Pattern is being processed by the
RestfulServer
( RestfulHttpServer
). The locator for which a
BasicAuthEndpoint
is responsible for is defined by the
BasicAuthEndpoint
's Locator-Pattern: A single asterisk ("*") matches
zero or more characters within a locator name. A double asterisk ("**")
matches zero or more characters across directory levels. A question mark
("?") matches exactly one character within a locator name. The single
asterisk ("*"), the double asterisk ("**") and the question mark ("?") we
refer to as wildcard: You get an array with the substitutes of the wildcards
using the RestRequestEvent
's method
RestRequestEvent.getWildcardReplacements()
inside the
BasicAuthObserver.onBasicAuthRequest(java.net.InetSocketAddress, java.net.InetSocketAddress, HttpMethod, String, org.refcodes.web.BasicAuthCredentials, String)
method. You may name a wildcard by prefixing it with "{someWildcardName}".
For example a named wildcard may look as follows: "{arg1}*" or "{arg2}**" or
"{arg3}?".-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.web.HttpMethodAccessor
org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<B extends org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<B>>, org.refcodes.web.HttpMethodAccessor.HttpMethodMutator, org.refcodes.web.HttpMethodAccessor.HttpMethodProperty
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves the resource Locator-Pattern this endpoint has been registered to.Methods inherited from interface org.refcodes.web.BasicAuthObserver
onBasicAuthRequest
Methods inherited from interface org.refcodes.web.HttpMethodAccessor
getHttpMethod
-
Method Details
-
getLocatorPathPattern
String getLocatorPathPattern()Retrieves the resource Locator-Pattern this endpoint has been registered to. The Locator-Pattern may contain wildcards as known from file-systems as follows: A single asterisk ("*") matches zero or more characters within a locator name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a locator name. The single asterisk ("*"), the double asterisk ("**") and the question mark ("?") we refer to as wildcard: You get an array with the substitutes of the wildcards using theRestRequestEvent
's methodRestRequestEvent.getWildcardReplacements()
inside theBasicAuthObserver.onBasicAuthRequest(java.net.InetSocketAddress, java.net.InetSocketAddress, HttpMethod, String, org.refcodes.web.BasicAuthCredentials, String)
method. You may name a wildcard by prefixing it with "{someWildcardName}". For example a named wildcard may look as follows: "{arg1}*" or "{arg2}**" or "{arg3}?". TheRestRequestEvent
lets you access the wildcard substitutes either by index or by name.
-