Share via


SSLParameters Class

Definition

Encapsulates parameters for an SSL/TLS connection.

[Android.Runtime.Register("javax/net/ssl/SSLParameters", DoNotGenerateAcw=true)]
public class SSLParameters : Java.Lang.Object
[<Android.Runtime.Register("javax/net/ssl/SSLParameters", DoNotGenerateAcw=true)>]
type SSLParameters = class
    inherit Object
Inheritance
SSLParameters
Attributes

Remarks

Encapsulates parameters for an SSL/TLS connection. The parameters are the list of ciphersuites to be accepted in an SSL/TLS handshake, the list of protocols to be allowed, the endpoint identification algorithm during SSL/TLS handshaking, the Server Name Indication (SNI), the algorithm constraints and whether SSL/TLS servers should request or require client authentication, etc.

SSLParameters can be created via the constructors in this class. Objects can also be obtained using the getSSLParameters() methods in SSLSocket#getSSLParameters SSLSocket and SSLServerSocket#getSSLParameters SSLServerSocket and SSLEngine#getSSLParameters SSLEngine or the SSLContext#getDefaultSSLParameters getDefaultSSLParameters() and SSLContext#getSupportedSSLParameters getSupportedSSLParameters() methods in SSLContext.

SSLParameters can be applied to a connection via the methods SSLSocket#setSSLParameters SSLSocket.setSSLParameters() and SSLServerSocket#setSSLParameters SSLServerSocket.setSSLParameters() and SSLEngine#setSSLParameters SSLEngine.setSSLParameters().

Added in 1.6.

Java documentation for javax.net.ssl.SSLParameters.

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

SSLParameters()

Constructs SSLParameters.

SSLParameters(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

SSLParameters(String[], String[])

Constructs SSLParameters from the specified array of ciphersuites and protocols.

SSLParameters(String[])

Constructs SSLParameters from the specified array of ciphersuites.

Properties

AlgorithmConstraints

Returns the cryptographic algorithm constraints. -or- Sets the cryptographic algorithm constraints, which will be used in addition to any configured by the runtime environment.

Class

Returns the runtime class of this Object.

(Inherited from Object)
EndpointIdentificationAlgorithm

Gets the endpoint identification algorithm. -or- Sets the endpoint identification algorithm.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
NeedClientAuth

Returns whether client authentication should be required. -or- Sets whether client authentication should be required.

PeerReference (Inherited from Object)
ServerNames

Returns a List containing all SNIServerNames of the Server Name Indication (SNI) parameter, or null if none has been set. -or- Sets the desired SNIServerNames of the Server Name Indication (SNI) parameter.

SNIMatchers

Returns a Collection containing all SNIMatchers of the Server Name Indication (SNI) parameter, or null if none has been set. -or- Sets the SNIMatchers of the Server Name Indication (SNI) parameter.

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.

UseCipherSuitesOrder

Returns whether the local cipher suites preference should be honored. -or- Sets whether the local cipher suites preference should be honored.

WantClientAuth

Returns whether client authentication should be requested. -or- Sets whether client authentication should be requested.

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)
GetApplicationProtocols()

Returns a prioritized array of application-layer protocol names that can be negotiated over the SSL/TLS protocols.

GetCipherSuites()

Returns a copy of the array of ciphersuites or null if none have been set.

GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
GetProtocols()

Returns a copy of the array of protocols or null if none have been set.

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)
SetApplicationProtocols(String[])

Sets the prioritized array of application-layer protocol names that can be negotiated over the SSL/TLS protocols.

SetCipherSuites(String[])

Sets the array of ciphersuites.

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetProtocols(String[])

Sets the array of protocols.

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, 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)
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)

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