Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.net.ssl
Class SSLSocket  view SSLSocket download SSLSocket.java

java.lang.Object
  extended byjava.net.Socket
      extended byjavax.net.ssl.SSLSocket

public abstract class SSLSocket
extends java.net.Socket

A socket that communicates over the secure socket layer protocol.


Field Summary
 
Fields inherited from class java.net.Socket
 
Constructor Summary
protected SSLSocket()
           
protected SSLSocket(java.net.InetAddress address, int port)
           
protected SSLSocket(java.net.InetAddress address, int port, java.net.InetAddress localAddr, int localPort)
           
protected SSLSocket(java.lang.String host, int port)
           
protected SSLSocket(java.lang.String host, int port, java.net.InetAddress localAddr, int localPort)
           
 
Method Summary
abstract  void addHandshakeCompletedListener(HandshakeCompletedListener listener)
          Adds a handshake completed listener that wants to be notified when the SSL handshake completes.
abstract  java.lang.String[] getEnabledCipherSuites()
          Returns the list of currently enabled cipher suites.
abstract  java.lang.String[] getEnabledProtocols()
          Returns the list of enabled SSL protocols.
abstract  boolean getEnableSessionCreation()
          Returns whether or not sessions will be created by this socket, and thus allow sessions to be continued later.
abstract  boolean getNeedClientAuth()
          Returns whether or not this socket will require connecting clients to authenticate themselves.
abstract  SSLSession getSession()
          Returns this socket's session object.
abstract  java.lang.String[] getSupportedCipherSuites()
          Returns the list of cipher suites supported by this socket.
abstract  java.lang.String[] getSupportedProtocols()
          Returns the list of protocols supported by this socket.
abstract  boolean getUseClientMode()
          Returns whether or not this socket will connect in client mode.
abstract  boolean getWantClientAuth()
          Returns whether or not this socket will request that connecting clients authenticate themselves.
abstract  void removeHandshakeCompletedListener(HandshakeCompletedListener listener)
          Removes a handshake listener from this socket.
abstract  void setEnabledCipherSuites(java.lang.String[] suites)
          Sets the list of enabled cipher suites.
abstract  void setEnabledProtocols(java.lang.String[] protocols)
          Sets the list of enabled SSL protocols.
abstract  void setEnableSessionCreation(boolean enable)
          Sets whether or not sessions will be created by this socket.
abstract  void setNeedClientAuth(boolean needAuth)
          Sets whether or not this socket will require connecting clients to authenticate themselves.
abstract  void setUseClientMode(boolean clientMode)
          Sets whether or not this socket will connect in client mode.
abstract  void setWantClientAuth(boolean wantAuth)
          Sets whether or not this socket will request that connecting clients authenticate themselves.
abstract  void startHandshake()
          Explicitly begins the handshake, or, if the handshake has already completed, requests that the handshake be repeated.
 
Methods inherited from class java.net.Socket
bind, close, connect, connect, getChannel, getInetAddress, getInputStream, getKeepAlive, getLocalAddress, getLocalPort, getLocalSocketAddress, getOOBInline, getOutputStream, getPort, getReceiveBufferSize, getRemoteSocketAddress, getReuseAddress, getSendBufferSize, getSoLinger, getSoTimeout, getTcpNoDelay, getTrafficClass, isBound, isClosed, isConnected, isInputShutdown, isOutputShutdown, sendUrgentData, setKeepAlive, setOOBInline, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSocketImplFactory, setSoLinger, setSoTimeout, setTcpNoDelay, setTrafficClass, shutdownInput, shutdownOutput, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SSLSocket

protected SSLSocket()

SSLSocket

protected SSLSocket(java.lang.String host,
                    int port)
             throws java.io.IOException,
                    java.net.UnknownHostException

SSLSocket

protected SSLSocket(java.net.InetAddress address,
                    int port)
             throws java.io.IOException

SSLSocket

protected SSLSocket(java.lang.String host,
                    int port,
                    java.net.InetAddress localAddr,
                    int localPort)
             throws java.io.IOException,
                    java.net.UnknownHostException

SSLSocket

protected SSLSocket(java.net.InetAddress address,
                    int port,
                    java.net.InetAddress localAddr,
                    int localPort)
             throws java.io.IOException
Method Detail

addHandshakeCompletedListener

public abstract void addHandshakeCompletedListener(HandshakeCompletedListener listener)
Adds a handshake completed listener that wants to be notified when the SSL handshake completes.


removeHandshakeCompletedListener

public abstract void removeHandshakeCompletedListener(HandshakeCompletedListener listener)
Removes a handshake listener from this socket.


getEnabledCipherSuites

public abstract java.lang.String[] getEnabledCipherSuites()
Returns the list of currently enabled cipher suites.


setEnabledCipherSuites

public abstract void setEnabledCipherSuites(java.lang.String[] suites)
Sets the list of enabled cipher suites.


getEnabledProtocols

public abstract java.lang.String[] getEnabledProtocols()
Returns the list of enabled SSL protocols.


setEnabledProtocols

public abstract void setEnabledProtocols(java.lang.String[] protocols)
Sets the list of enabled SSL protocols.


getEnableSessionCreation

public abstract boolean getEnableSessionCreation()
Returns whether or not sessions will be created by this socket, and thus allow sessions to be continued later.


setEnableSessionCreation

public abstract void setEnableSessionCreation(boolean enable)
Sets whether or not sessions will be created by this socket.


getNeedClientAuth

public abstract boolean getNeedClientAuth()
Returns whether or not this socket will require connecting clients to authenticate themselves. This value only applies to sockets in server mode.


setNeedClientAuth

public abstract void setNeedClientAuth(boolean needAuth)
Sets whether or not this socket will require connecting clients to authenticate themselves. This value only applies to sockets in server mode.


getSession

public abstract SSLSession getSession()
Returns this socket's session object.


getSupportedCipherSuites

public abstract java.lang.String[] getSupportedCipherSuites()
Returns the list of cipher suites supported by this socket.


getSupportedProtocols

public abstract java.lang.String[] getSupportedProtocols()
Returns the list of protocols supported by this socket.


getUseClientMode

public abstract boolean getUseClientMode()
Returns whether or not this socket will connect in client mode.


setUseClientMode

public abstract void setUseClientMode(boolean clientMode)
Sets whether or not this socket will connect in client mode.


getWantClientAuth

public abstract boolean getWantClientAuth()
Returns whether or not this socket will request that connecting clients authenticate themselves. This value only applies to sockets in server mode.


setWantClientAuth

public abstract void setWantClientAuth(boolean wantAuth)
Sets whether or not this socket will request that connecting clients authenticate themselves. This value only applies to sockets in server mode.


startHandshake

public abstract void startHandshake()
                             throws java.io.IOException
Explicitly begins the handshake, or, if the handshake has already completed, requests that the handshake be repeated.

The handshake will begin implicitly when any attempt to read or write to the socket is made.