java.lang.Object
com.esri.arcgisruntime.security.AuthenticationChallenge
Represents an authentication challenge that is presented upon encountering an authentication error.
The class contains pertinent information, such as the exception that was raised, the service that
was being requested, the credentials used to access them. The challenge will be issued to the current challenge
handler, if one has been provided by setting
AuthenticationManager.setAuthenticationChallengeHandler(AuthenticationChallengeHandler)
.- Since:
- 100.0.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Specifies the different types of authentication challenges that can be raised. -
Method Summary
Modifier and TypeMethodDescriptionGets the original authentication exception that was raised by the request.int
Gets the number of times that the request issuing this challenge has already failed.Gets the RemoteResource that was used to initiate the request.Returns the owning system URL of the server on which the RemoteResource is running, which can be used to determine if the server is federated by a portal.getType()
Gets the type of the authentication challenge.boolean
Returns a boolean that defines if PKCE (proof key code exchange) is supported with the portal associated with this authentication challenge.boolean
Returns true if the server the RemoteResource runs on is federated to a portal.
-
Method Details
-
getFailureCount
public int getFailureCount()Gets the number of times that the request issuing this challenge has already failed.- Returns:
- the number of times this request has failed
- Since:
- 100.0.0
-
getException
Gets the original authentication exception that was raised by the request.- Returns:
- the original authentication exception
- Since:
- 100.0.0
-
getRemoteResource
Gets the RemoteResource that was used to initiate the request.- Returns:
- the RemoteResource that initiated the request
- Since:
- 100.0.0
-
getType
Gets the type of the authentication challenge.- Returns:
- the type of the challenge
- Since:
- 100.0.0
-
getRemoteResourceOwningSystemUrl
Returns the owning system URL of the server on which the RemoteResource is running, which can be used to determine if the server is federated by a portal.- Returns:
- the owning system URL of the RemoteResource
- Since:
- 100.0.0
-
isRemoteResourceFederated
public boolean isRemoteResourceFederated()Returns true if the server the RemoteResource runs on is federated to a portal.- Returns:
- true if the server is federated, else false
- Since:
- 100.0.0
-
isPKCESupported
public boolean isPKCESupported()Returns a boolean that defines if PKCE (proof key code exchange) is supported with the portal associated with this authentication challenge. If this authentication challenge is not associated with a portal, this property returns false.- Returns:
- a boolean that defines if PKCE is supported with the associated portal
- Since:
- 100.12.0
-