SNIMatcher
abstract class SNIMatcher
| kotlin.Any | |
| ↳ | javax.net.ssl.SNIMatcher |
Instances of this class represent a matcher that performs match operations on an SNIServerName instance.
Servers can use Server Name Indication (SNI) information to decide if specific SSLSocket or SSLEngine instances should accept a connection. For example, when multiple "virtual" or "name-based" servers are hosted on a single underlying network address, the server application can use SNI information to determine whether this server is the exact server that the client wants to access. Instances of this class can be used by a server to verify the acceptable server names of a particular type, such as host names.
SNIMatcher objects are immutable. Subclasses should not provide methods that can change the state of an instance once it has been created.
Summary
| Protected constructors | |
|---|---|
SNIMatcher(type: Int)Creates an |
|
| Public methods | |
|---|---|
| Int |
getType()Returns the server name type of this |
| abstract Boolean |
matches(serverName: SNIServerName!)Attempts to match the given |
Protected constructors
SNIMatcher
protected SNIMatcher(type: Int)
Creates an SNIMatcher using the specified server name type.
| Parameters | |
|---|---|
type |
Int: the type of the server name that this matcher performs on |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if type is not in the range of 0 to 255, inclusive. |
Public methods
getType
fun getType(): Int
Returns the server name type of this SNIMatcher object.
| Return | |
|---|---|
Int |
the server name type of this SNIMatcher object. |
See Also
matches
abstract fun matches(serverName: SNIServerName!): Boolean
Attempts to match the given SNIServerName.
| Parameters | |
|---|---|
serverName |
SNIServerName!: the SNIServerName instance on which this matcher performs match operations |
| Return | |
|---|---|
Boolean |
true if, and only if, the matcher matches the given serverName |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
if serverName is null |
java.lang.IllegalArgumentException |
if serverName is not of the given server name type of this matcher |
See Also