The DispatchChallengeHandler type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | DispatchChallengeHandler |
Methods
Name | Description | |||||
---|---|---|---|---|---|---|
![]() | CanHandle | (Overrides ChallengeHandler..::..CanHandle(ChallengeRequest).) | ||||
![]() | Equals | (Inherited from Object.) | ||||
![]() | Finalize | (Inherited from Object.) | ||||
![]() | GetHashCode | (Inherited from Object.) | ||||
![]() | GetType | (Inherited from Object.) | ||||
![]() | Handle | (Overrides ChallengeHandler..::..Handle(ChallengeRequest).) | ||||
![]() | MemberwiseClone | (Inherited from Object.) | ||||
![]() | Register |
Register a challenge handler to respond to challenges at one or more locations.
When a challenge is received for a protected URI, the {@code locationDescription} matches against elements of the protected URI; if a match is found, one consults the challenge handler(s) registered at that {@code locationDescription} to find a challenge handler suitable to respond to the challenge. A {@code 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 {@code locationDescription}, a default port will be inferred based on the scheme mentioned in the location description, according to the following table:
The protocol scheme (e.g. http or ws) if present in {@code locationDescription} will not be used to match {@code 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 {@code "foo.example.com"} matches both URIs {@code http://foo.example.com} and {@code ws://foo.example.com}. Some examples of {@code locationDescription} values with wildcards are:
Return Valuea reference to this challenge handler for chained calls | ||||
![]() | ToString | (Inherited from Object.) | ||||
![]() | Unregister | 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. If no such location or challengeHandler registration exists, this method silently succeeds. the exact location description at which the challenge handler was originally registeredthe challenge handler to de-register.Return Valuea reference to this object for chained call support |