BasicAuthEndpoint
, org.refcodes.net.BasicAuthObserver
, org.refcodes.component.Closable
, org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.LinkComponent.LinkComponentBuilder<BasicAuthEndpointBuilder>>
, org.refcodes.component.ConnectionStatusAccessor
, org.refcodes.net.HttpMethodAccessor
, org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<BasicAuthEndpointBuilder>
, org.refcodes.net.HttpMethodAccessor.HttpMethodMutator
, org.refcodes.net.HttpMethodAccessor.HttpMethodProperty
, org.refcodes.component.LinkComponent
, org.refcodes.component.LinkComponent.LinkComponentBuilder<BasicAuthEndpointBuilder>
, org.refcodes.component.Openable
, org.refcodes.component.Openable.OpenBuilder<org.refcodes.component.LinkComponent.LinkComponentBuilder<BasicAuthEndpointBuilder>>
BasicAuthEndpointBuilderImpl
public interface BasicAuthEndpointBuilder extends BasicAuthEndpoint, org.refcodes.net.HttpMethodAccessor.HttpMethodProperty, org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<BasicAuthEndpointBuilder>, org.refcodes.component.LinkComponent.LinkComponentBuilder<BasicAuthEndpointBuilder>, org.refcodes.component.ConnectionStatusAccessor
BasicAuthEndpointBuilder
extends an BasicAuthEndpoint
with
builder functionality and adds lambda
support for handling the
requests addressed to this BasicAuthEndpoint
. The lambda
defined as BasicAuthObserver
acts as the single listener to this
BasicAuthEndpoint
responsible for handling the requests for which
this BasicAuthEndpoint
is responsible.
The locator for which an BasicAuthEndpointBuilder
is responsible for
is defined by the BasicAuthEndpointBuilder
'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 method WildcardSubstitutes.getWildcardReplacements()
.
You may name a wildcard by prefixing it with "${someWildcardName}". For
example a named wildcard may look as follows: "${arg1}=*" or "${arg2}=**" or
"${arg3}=?". You can get the text substituting a named wildcard using the
method WildcardSubstitutes.getWildcardReplacement(String)
.
For ease of use, a named wildcard with single asterisk ("*") such as
"${arg1}=*" can be abbreviated as "${arg1}".org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>
org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty
org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<B extends org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<B>>, org.refcodes.net.HttpMethodAccessor.HttpMethodMutator, org.refcodes.net.HttpMethodAccessor.HttpMethodProperty
Modifier and Type | Method | Description |
---|---|---|
org.refcodes.net.BasicAuthObserver |
getRequestObserver() |
Retrieves the
BasicAuthObserver to which any requests are
delegated upon invocation of the
BasicAuthObserver.onBasicAuthRequest(java.net.InetSocketAddress, java.net.InetSocketAddress, HttpMethod, String, org.refcodes.net.BasicAuthCredentials, String)
method. |
void |
setLocatorPattern(String aLocatorPattern) |
Sets the resource locator.
|
void |
setRequestObserver(org.refcodes.net.BasicAuthObserver aLambda) |
Sets the
BasicAuthObserver to which any requests are delegated
upon invocation of the
BasicAuthObserver.onBasicAuthRequest(java.net.InetSocketAddress, java.net.InetSocketAddress, HttpMethod, String, org.refcodes.net.BasicAuthCredentials, String)
method. |
default BasicAuthEndpointBuilder |
withClose() |
|
default BasicAuthEndpointBuilder |
withCloseIn(int aCloseInMillis) |
|
default BasicAuthEndpointBuilder |
withCloseQuietly() |
|
default BasicAuthEndpointBuilder |
withHttpMethod(org.refcodes.net.HttpMethod aHttpMethod) |
|
default BasicAuthEndpointBuilder |
withLocatorPattern(String aLocatorPattern) |
Sets the resource locator as of the Builder-Pattern.
|
default BasicAuthEndpointBuilder |
withOpen() |
|
default BasicAuthEndpointBuilder |
withRequestObserver(org.refcodes.net.BasicAuthObserver aLambda) |
Builder method for setting the
BasicAuthObserver . |
getLocatorPattern
close, closeIn, closeQuietly, closeUnchecked
getConnectionStatus, isConnectionOpened
default BasicAuthEndpointBuilder withHttpMethod(org.refcodes.net.HttpMethod aHttpMethod)
withHttpMethod
in interface org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<BasicAuthEndpointBuilder>
default BasicAuthEndpointBuilder withLocatorPattern(String aLocatorPattern)
WildcardSubstitutes.getWildcardReplacement(String)
.
For ease of use, a named wildcard with single asterisk ("*") such as
"${arg1}=*" can be abbreviated as "${arg1}".aLocatorPattern
- the locator patternBasicAuthEndpoint
builder to continue configuration
(as of the Builder-Pattern).void setLocatorPattern(String aLocatorPattern)
WildcardSubstitutes.getWildcardReplacement(String)
.
For ease of use, a named wildcard with single asterisk ("*") such as
"${arg1}=*" can be abbreviated as "${arg1}".aLocatorPattern
- the new locator patternorg.refcodes.net.BasicAuthObserver getRequestObserver()
BasicAuthObserver
to which any requests are
delegated upon invocation of the
BasicAuthObserver.onBasicAuthRequest(java.net.InetSocketAddress, java.net.InetSocketAddress, HttpMethod, String, org.refcodes.net.BasicAuthCredentials, String)
method.BasicAuthObserver
to handle requests.void setRequestObserver(org.refcodes.net.BasicAuthObserver aLambda)
BasicAuthObserver
to which any requests are delegated
upon invocation of the
BasicAuthObserver.onBasicAuthRequest(java.net.InetSocketAddress, java.net.InetSocketAddress, HttpMethod, String, org.refcodes.net.BasicAuthCredentials, String)
method.aLambda
- The (user defined) BasicAuthObserver
to handle
requests, feel free to code it as lambda
expression!default BasicAuthEndpointBuilder withRequestObserver(org.refcodes.net.BasicAuthObserver aLambda)
BasicAuthObserver
.aLambda
- The (user defined) BasicAuthObserver
to handle
requests, feel free to code it as lambda
expressionBasicAuthEndpointBuilder
for the sake of a fluent
API.default BasicAuthEndpointBuilder withOpen() throws org.refcodes.component.OpenException
withOpen
in interface org.refcodes.component.Openable.OpenBuilder<org.refcodes.component.LinkComponent.LinkComponentBuilder<BasicAuthEndpointBuilder>>
org.refcodes.component.OpenException
default BasicAuthEndpointBuilder withClose() throws org.refcodes.component.CloseException
withClose
in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.LinkComponent.LinkComponentBuilder<BasicAuthEndpointBuilder>>
org.refcodes.component.CloseException
default BasicAuthEndpointBuilder withCloseQuietly()
withCloseQuietly
in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.LinkComponent.LinkComponentBuilder<BasicAuthEndpointBuilder>>
default BasicAuthEndpointBuilder withCloseIn(int aCloseInMillis)
withCloseIn
in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.LinkComponent.LinkComponentBuilder<BasicAuthEndpointBuilder>>
Copyright © 2018. All rights reserved.