Top Description Fields Constructors Methods
javax.net.ssl

public abstract Class SNIMatcher

extends Object
Class Inheritance
Known Direct Subclasses
javax.net.ssl.SNIHostName.SNIHostNameMatcher
Imports
java.util.Collection

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.

Since
1.8
See Also
SNIServerName, SNIHostName, SSLParameters#getSNIMatchers(), SSLParameters#setSNIMatchers(Collection)

Field Summary

Modifier and TypeField and Description
private final int

Constructor Summary

AccessConstructor and Description
protected
SNIMatcher(int
the type of the server name that this matcher performs on
type
)

Creates an SNIMatcher using the specified server name type.

Method Summary

Modifier and TypeMethod and Description
public final int

Returns:

the server name type of this SNIMatcher object.
getType
()

Returns the server name type of this SNIMatcher object.

public abstract boolean

Returns:

true if, and only if, the matcher matches the given serverName
matches
(SNIServerName
the SNIServerName instance on which this matcher performs match operations
serverName
)

Attempts to match the given SNIServerName.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

typeback to summary
private final int type

Constructor Detail

SNIMatcherback to summary
protected SNIMatcher(int type)

Creates an SNIMatcher using the specified server name type.

Parameters
type:int

the type of the server name that this matcher performs on

Exceptions
IllegalArgumentException:
if type is not in the range of 0 to 255, inclusive.

Method Detail

getTypeback to summary
public final int getType()

Returns the server name type of this SNIMatcher object.

Returns:int

the server name type of this SNIMatcher object.

See Also
SNIServerName
matchesback to summary
public abstract boolean matches(SNIServerName serverName)

Attempts to match the given SNIServerName.

Parameters
serverName:SNIServerName

the SNIServerName instance on which this matcher performs match operations

Returns:boolean

true if, and only if, the matcher matches the given serverName

Exceptions
NullPointerException:
if serverName is null
IllegalArgumentException:
if serverName is not of the given server name type of this matcher
See Also
SNIServerName