|
Préférences
Moteurs de recherche
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JavaTM 2 Platform Std. Ed. v1.6.0
javax.net.ssl
|
Constructor Summary | |
---|---|
protected |
SSLSocket()
Used only by subclasses. |
protected |
SSLSocket(InetAddress address,
int port)
Used only by subclasses. |
protected |
SSLSocket(InetAddress address,
int port,
InetAddress clientAddress,
int clientPort)
Used only by subclasses. |
protected |
SSLSocket(String host,
int port)
Used only by subclasses. |
protected |
SSLSocket(String host,
int port,
InetAddress clientAddress,
int clientPort)
Used only by subclasses. |
Method Summary | |
---|---|
abstract void |
addHandshakeCompletedListener(HandshakeCompletedListener listener)
Registers an event listener to receive notifications that an SSL handshake has completed on this connection. |
abstract String[] |
getEnabledCipherSuites()
Returns the names of the SSL cipher suites which are currently enabled for use on this connection. |
abstract String[] |
getEnabledProtocols()
Returns the names of the protocol versions which are currently enabled for use on this connection. |
abstract boolean |
getEnableSessionCreation()
Returns true if new SSL sessions may be established by this socket. |
abstract boolean |
getNeedClientAuth()
Returns true if the socket will require client authentication. |
abstract SSLSession |
getSession()
Returns the SSL Session in use by this connection. |
SSLParameters |
getSSLParameters()
Returns the SSLParameters in effect for this SSLSocket. |
abstract String[] |
getSupportedCipherSuites()
Returns the names of the cipher suites which could be enabled for use on this connection. |
abstract String[] |
getSupportedProtocols()
Returns the names of the protocols which could be enabled for use on an SSL connection. |
abstract boolean |
getUseClientMode()
Returns true if the socket is set to use client mode when handshaking. |
abstract boolean |
getWantClientAuth()
Returns true if the socket will request client authentication. |
abstract void |
removeHandshakeCompletedListener(HandshakeCompletedListener listener)
Removes a previously registered handshake completion listener. |
abstract void |
setEnabledCipherSuites(String[] suites)
Sets the cipher suites enabled for use on this connection. |
abstract void |
setEnabledProtocols(String[] protocols)
Sets the protocol versions enabled for use on this connection. |
abstract void |
setEnableSessionCreation(boolean flag)
Controls whether new SSL sessions may be established by this socket. |
abstract void |
setNeedClientAuth(boolean need)
Configures the socket to require client authentication. |
void |
setSSLParameters(SSLParameters params)
Applies SSLParameters to this socket. |
abstract void |
setUseClientMode(boolean mode)
Configures the socket to use client (or server) mode when handshaking. |
abstract void |
setWantClientAuth(boolean want)
Configures the socket to request client authentication. |
abstract void |
startHandshake()
Starts an SSL handshake on this connection. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected SSLSocket()
protected SSLSocket(String host, int port) throws IOException, UnknownHostException
host
- name of the host with which to connectport
- number of the server's port
IOException
- if an I/O error occurs when creating the socket
UnknownHostException
- if the host is not knownprotected SSLSocket(InetAddress address, int port) throws IOException
address
- the server's hostport
- its port
IOException
- if an I/O error occurs when creating the socketprotected SSLSocket(String host, int port, InetAddress clientAddress, int clientPort) throws IOException, UnknownHostException
host
- name of the host with which to connectport
- number of the server's portclientAddress
- the client's hostclientPort
- number of the client's port
IOException
- if an I/O error occurs when creating the socket
UnknownHostException
- if the host is not knownprotected SSLSocket(InetAddress address, int port, InetAddress clientAddress, int clientPort) throws IOException
address
- the server's hostport
- its portclientAddress
- the client's hostclientPort
- number of the client's port
IOException
- if an I/O error occurs when creating the socketMethod Detail |
---|
public abstract String[] getSupportedCipherSuites()
getEnabledCipherSuites()
,
setEnabledCipherSuites(String [])
public abstract String[] getEnabledCipherSuites()
Even if a suite has been enabled, it might never be used. (For example, the peer does not support it, the requisite certificates (and private keys) for the suite are not available, or an anonymous suite is enabled but authentication is required.
getSupportedCipherSuites()
,
setEnabledCipherSuites(String [])
public abstract void setEnabledCipherSuites(String[] suites)
Each cipher suite in the suites
parameter must have
been listed by getSupportedCipherSuites(), or the method will
fail. Following a successful call to this method, only suites
listed in the suites
parameter are enabled for use.
See getEnabledCipherSuites()
for more information
on why a specific ciphersuite may never be used on a connection.
suites
- Names of all the cipher suites to enable
IllegalArgumentException
- when one or more of the ciphers
named by the parameter is not supported, or when the
parameter is null.getSupportedCipherSuites()
,
getEnabledCipherSuites()
public abstract String[] getSupportedProtocols()
public abstract String[] getEnabledProtocols()
setEnabledProtocols(String [])
public abstract void setEnabledProtocols(String[] protocols)
The protocols must have been listed by
getSupportedProtocols()
as being supported.
Following a successful call to this method, only protocols listed
in the protocols
parameter are enabled for use.
protocols
- Names of all the protocols to enable.
IllegalArgumentException
- when one or more of
the protocols named by the parameter is not supported or
when the protocols parameter is null.getEnabledProtocols()
public abstract SSLSession getSession()
This method will initiate the initial handshake if necessary and then block until the handshake has been established.
If an error occurs during the initial handshake, this method returns an invalid session object which reports an invalid cipher suite of "SSL_NULL_WITH_NULL_NULL".
SSLSession
public abstract void addHandshakeCompletedListener(HandshakeCompletedListener listener)
listener
- the HandShake Completed event listener
IllegalArgumentException
- if the argument is null.startHandshake()
,
removeHandshakeCompletedListener(HandshakeCompletedListener)
public abstract void removeHandshakeCompletedListener(HandshakeCompletedListener listener)
listener
- the HandShake Completed event listener
IllegalArgumentException
- if the listener is not registered,
or the argument is null.addHandshakeCompletedListener(HandshakeCompletedListener)
public abstract void startHandshake() throws IOException
If data has already been sent on the connection, it continues to flow during this handshake. When the handshake completes, this will be signaled with an event. This method is synchronous for the initial handshake on a connection and returns when the negotiated handshake is complete. Some protocols may not support multiple handshakes on an existing socket and may throw an IOException.
IOException
- on a network level erroraddHandshakeCompletedListener(HandshakeCompletedListener)
public abstract void setUseClientMode(boolean mode)
This method must be called before any handshaking occurs. Once handshaking has begun, the mode can not be reset for the life of this socket.
Servers normally authenticate themselves, and clients are not required to do so.
mode
- true if the socket should start its handshaking
in "client" mode
IllegalArgumentException
- if a mode change is attempted
after the initial handshake has begun.getUseClientMode()
public abstract boolean getUseClientMode()
setUseClientMode(boolean)
public abstract void setNeedClientAuth(boolean need)
A socket's client authentication setting is one of the following:
Unlike setWantClientAuth(boolean)
, if this option is set and
the client chooses not to provide authentication information
about itself, the negotiations will stop and the connection
will be dropped.
Calling this method overrides any previous setting made by
this method or setWantClientAuth(boolean)
.
need
- set to true if client authentication is required,
or false if no client authentication is desired.getNeedClientAuth()
,
setWantClientAuth(boolean)
,
getWantClientAuth()
,
setUseClientMode(boolean)
public abstract boolean getNeedClientAuth()
setNeedClientAuth(boolean)
,
setWantClientAuth(boolean)
,
getWantClientAuth()
,
setUseClientMode(boolean)
public abstract void setWantClientAuth(boolean want)
A socket's client authentication setting is one of the following:
Unlike setNeedClientAuth(boolean)
, if this option is set and
the client chooses not to provide authentication information
about itself, the negotiations will continue.
Calling this method overrides any previous setting made by
this method or setNeedClientAuth(boolean)
.
want
- set to true if client authentication is requested,
or false if no client authentication is desired.getWantClientAuth()
,
setNeedClientAuth(boolean)
,
getNeedClientAuth()
,
setUseClientMode(boolean)
public abstract boolean getWantClientAuth()
setNeedClientAuth(boolean)
,
getNeedClientAuth()
,
setWantClientAuth(boolean)
,
setUseClientMode(boolean)
public abstract void setEnableSessionCreation(boolean flag)
flag
- true indicates that sessions may be created; this
is the default. false indicates that an existing session
must be resumedgetEnableSessionCreation()
public abstract boolean getEnableSessionCreation()
setEnableSessionCreation(boolean)
public SSLParameters getSSLParameters()
public void setSSLParameters(SSLParameters params)
This means:
params.getCipherSuites()
is non-null,
setEnabledCipherSuites()
is called with that value
params.getProtocols()
is non-null,
setEnabledProtocols()
is called with that value
params.getNeedClientAuth()
or
params.getWantClientAuth()
return true
,
setNeedClientAuth(true)
and
setWantClientAuth(true)
are called, respectively;
otherwise setWantClientAuth(false)
is called.
params
- the parameters
IllegalArgumentException
- if the setEnabledCipherSuites() or
the setEnabledProtocols() call fails