Added in API level 24

Summary: Protected Ctors | Methods | Inherited Methods

SNIServerName

public abstract class SNIServerName
extends Object

java.lang.Object
↳	javax.net.ssl.SNIServerName

Known direct subclasses SNIHostName SNIHostName Instances of this class represent a server name of type host_name in a Server Name Indication (SNI) extension.

---

Instances of this class represent a server name in a Server Name Indication (SNI) extension.

The SNI extension is a feature that extends the SSL/TLS protocols to indicate what server name the client is attempting to connect to during handshaking. See section 3, "Server Name Indication", of TLS Extensions (RFC 6066).

SNIServerName objects are immutable. Subclasses should not provide methods that can change the state of an instance once it has been created.

See also:

• SSLParameters.getServerNames()
• SSLParameters.setServerNames(List)

Summary

Protected constructors
SNIServerName(int type, byte[] encoded) Creates an SNIServerName using the specified name type and encoded value.

Public methods
boolean	equals(Object other) Indicates whether some other object is "equal to" this server name.
final byte[]	getEncoded() Returns a copy of the encoded server name value of this server name.
final int	getType() Returns the name type of this server name.
int	hashCode() Returns a hash code value for this server name.
String	toString() Returns a string representation of this server name, including the server name type and the encoded server name value in this SNIServerName object.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Protected constructors

SNIServerName

Added in API level 24

protected SNIServerName (int type, 
                byte[] encoded)

Creates an SNIServerName using the specified name type and encoded value.

Note that the encoded byte array is cloned to protect against subsequent modification.

Parameters
type	int: the type of the server name
encoded	byte: the encoded value of the server name

Throws
IllegalArgumentException	if type is not in the range of 0 to 255, inclusive.
NullPointerException	if encoded is null

Public methods

equals

Added in API level 24

public boolean equals (Object other)

Indicates whether some other object is "equal to" this server name.

Parameters
other	Object: the reference object with which to compare.

Returns
boolean	true if, and only if, other is of the same class of this object, and has the same name type and encoded value as this server name.

getEncoded

Added in API level 24

public final byte[] getEncoded ()

Returns a copy of the encoded server name value of this server name.

Returns
byte[]	a copy of the encoded server name value of this server name

getType

Added in API level 24

public final int getType ()

Returns the name type of this server name.

Returns
int	the name type of this server name

hashCode

Added in API level 24

public int hashCode ()

Returns a hash code value for this server name.

The hash code value is generated using the name type and encoded value of this server name.

Returns
int	a hash code value for this server name.

toString

Added in API level 24

public String toString ()

Returns a string representation of this server name, including the server name type and the encoded server name value in this SNIServerName object.

The exact details of the representation are unspecified and subject to change, but the following may be regarded as typical:

     "type=<name type>, value=<name value>"
 

In this class, the format of "<name type>" is "[LITERAL] (INTEGER)", where the optional "LITERAL" is the literal name, and INTEGER is the integer value of the name type. The format of "<name value>" is "XX:...:XX", where "XX" is the hexadecimal digit representation of a byte value. For example, a returned value of an pseudo server name may look like:

     "type=(31), value=77:77:77:2E:65:78:61:6D:70:6C:65:2E:63:6E"
 

or

     "type=host_name (0), value=77:77:77:2E:65:78:61:6D:70:6C:65:2E:63:6E"
 

Please NOTE that the exact details of the representation are unspecified and subject to change, and subclasses may override the method with their own formats.

Returns
String	a string representation of this server name