SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Constructor Summary | |
DispatchChallengeHandler()
A DispatchChallengeHandler is responsible for dispatching challenge requests
to appropriate challenge handlers when challenges
arrive from specific URI locations in challenge responses.
|
Method Summary | |
ChallengeHandler
|
register(locationDescription, challengeHandler)
Register a challenge handler to respond to challenges at one or more locations. |
ChallengeHandler
|
unregister(locationDescription, challengeHandler)
If the provided challengeHandler is registered at the provided location, clear that association such that any future challenge requests matching the location will never be handled by the provided challenge handler. |
Constructor Detail |
DispatchChallengeHandler()
DispatchChallengeHandler
is responsible for dispatching challenge requests
to appropriate challenge handlers when challenges
arrive from specific URI locations in challenge responses.
This allows clients to use specific challenge handlers to handle specific types of challenges at different URI locations.
Method Detail |
ChallengeHandler register(locationDescription, challengeHandler)
When a challenge response is received for a protected URI, the locationDescription
matches against elements of the protected URI; if a match is found, one
consults the challenge handler(s) registered at that locationDescription
to find
a challenge handler suitable to respond to the challenge.
A locationDescription
comprises a username, password, host, port and paths,
any of which can be wild-carded with the *
character to match any number of request URIs.
If no port is explicitly mentioned in a locationDescription
, a default port will be inferred
based on the scheme mentioned in the location description, according to the following table:
scheme | default port | Sample locationDescription |
---|---|---|
http | 80 | foo.example.com or http://foo.example.com |
ws | 80 | foo.example.com or ws://foo.example.com |
https | 443 | https://foo.example.com |
wss | 443 | wss://foo.example.com |
The protocol scheme (e.g. http or ws) if present in locationDescription
will not be used to
match locationDescription
with the protected URI, because authentication challenges are
implemented on top of one of the HTTP/s protocols always, whether one is initiating web socket
connections or regular HTTP connections. That is to say for example, the locationDescription
foo.example.com
matches both URIs http://foo.example.com
and ws://foo.example.com
.
Some examples of locationDescription
values with wildcards are:
.hostname.com:8000
-- matches all requests to port 8000 on any sub-domain of hostname.com
,
but not hostname.com
itself.server.hostname.com:
*/* -- matches all requests to a particular server on any port on any path but not the empty path. locationDescription
- the (possibly wild-carded) location(s) at which to register a handler.
challengeHandler
- the challenge handler to register at the location(s).
ChallengeHandler
a reference to this challenge handler for chained calls
ChallengeHandler unregister(locationDescription, challengeHandler)
If no such location or challengeHandler registration exists, this method silently succeeds.
locationDescription
- the exact location description at which the challenge handler was originally registered
challengeHandler
- the challenge handler to de-register.
ChallengeHandler
a reference to this object for chained call support