Authenticator Class

Reference

Definition

Namespace:: Java.Net

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The class Authenticator represents an object that knows how to obtain authentication for a network connection.

[Android.Runtime.Register("java/net/Authenticator", DoNotGenerateAcw=true)]
public abstract class Authenticator : Java.Lang.Object

[<Android.Runtime.Register("java/net/Authenticator", DoNotGenerateAcw=true)>]
type Authenticator = class
    inherit Object

Inheritance: Object

Object
Authenticator

Attributes: RegisterAttribute

Remarks

The class Authenticator represents an object that knows how to obtain authentication for a network connection. Usually, it will do this by prompting the user for information.

Applications use this class by overriding #getPasswordAuthentication() in a sub-class. This method will typically use the various getXXX() accessor methods to get information about the entity requesting authentication. It must then acquire a username and password either by interacting with the user or through some other non-interactive means. The credentials are then returned as a PasswordAuthentication return value.

An instance of this concrete sub-class is then registered with the system by calling #setDefault(Authenticator). When authentication is required, the system will invoke one of the requestPasswordAuthentication() methods which in turn will call the getPasswordAuthentication() method of the registered object.

All methods that request authentication have a default implementation that fails.

Added in 1.2.

Java documentation for java.net.Authenticator.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Authenticator()
Authenticator(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PasswordAuthentication	Called when password authorization is needed.
PeerReference	(Inherited from Object)
RequestingHost	Gets the `hostname` of the site or proxy requesting authentication, or `null` if not available.
RequestingPort	Gets the port number for the requested connection.
RequestingPrompt	Gets the prompt string given by the requestor.
RequestingProtocol	Give the protocol that's requesting the connection.
RequestingScheme	Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example).
RequestingSite	Gets the `InetAddress` of the site requesting authorization, or `null` if not available.
RequestingURL	Returns the URL that resulted in this request for authentication.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetRequestorType()	Returns whether the requestor is a Proxy or a Server.
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
RequestPasswordAuthentication(InetAddress, Int32, String, String, String)	Ask the authenticator that has been registered with the system for a password.
RequestPasswordAuthentication(String, InetAddress, Int32, String, String, String)	Ask the authenticator that has been registered with the system for a password.
RequestPasswordAuthentication(String, InetAddress, Int32, String, String, String, URL, Authenticator+RequestorType)	Ask the authenticator that has been registered with the system for a password.
SetDefault(Authenticator)	Sets the authenticator that will be used by the networking code when a proxy or an HTTP server asks for authentication.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to