public class

SocketFetcher

extends Object
java.lang.Object
   ↳ com.google.code.com.sun.mail.util.SocketFetcher

Class Overview

This class is used to get Sockets. Depending on the arguments passed it will either return a plain java.net.Socket or dynamically load the SocketFactory class specified in the classname param and return a socket created by that SocketFactory.

Summary

Fields
private static boolean debug
Public Methods
static Socket getSocket(String host, int port, Properties props, String prefix, boolean useSSL)
This method returns a Socket.
static Socket getSocket(String host, int port, Properties props, String prefix)
static Socket startTLS(Socket socket, Properties props, String prefix)
Start TLS on an existing socket.
static Socket startTLS(Socket socket)
Start TLS on an existing socket.
static Socket startTLS(Socket socket, String host, Properties props, String prefix)
Start TLS on an existing socket.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private static boolean debug

Public Methods

public static Socket getSocket (String host, int port, Properties props, String prefix, boolean useSSL)

This method returns a Socket. Properties control the use of socket factories and other socket characteristics. The properties used are:

  • prefix.socketFactory
  • prefix.socketFactory.class
  • prefix.socketFactory.fallback
  • prefix.socketFactory.port
  • prefix.ssl.socketFactory
  • prefix.ssl.socketFactory.class
  • prefix.ssl.socketFactory.port
  • prefix.timeout
  • prefix.connectiontimeout
  • prefix.localaddress
  • prefix.localport

If we're making an SSL connection, the ssl.socketFactory properties are used first, if set.

If the socketFactory property is set, the value is an instance of a SocketFactory class, not a string. The instance is used directly. If the socketFactory property is not set, the socketFactory.class property is considered. (Note that the SocketFactory property must be set using the put method, not the setProperty method.)

If the socketFactory.class property isn't set, the socket returned is an instance of java.net.Socket connected to the given host and port. If the socketFactory.class property is set, it is expected to contain a fully qualified classname of a javax.net.SocketFactory subclass. In this case, the class is dynamically instantiated and a socket created by that SocketFactory is returned.

If the socketFactory.fallback property is set to false, don't fall back to using regular sockets if the socket factory fails.

The socketFactory.port specifies a port to use when connecting through the socket factory. If unset, the port argument will be used.

If the connectiontimeout property is set, the timeout is passed to the socket connect method.

If the timeout property is set, it is used to set the socket timeout.

If the localaddress property is set, it's used as the local address to bind to. If the localport property is also set, it's used as the local port number to bind to.

Parameters
host The host to connect to
port The port to connect to at the host
props Properties object containing socket properties
prefix Property name prefix, e.g., "mail.imap"
useSSL Use the SSL socket factory as the default
Throws
IOException

public static Socket getSocket (String host, int port, Properties props, String prefix)

Parameters
host
port
props
prefix
Throws
IOException

public static Socket startTLS (Socket socket, Properties props, String prefix)

Start TLS on an existing socket. Supports the "STARTTLS" command in many protocols. This version for compatibility with possible third party code that might've used this API even though it shouldn't.

Parameters
socket
props
prefix
Throws
IOException

public static Socket startTLS (Socket socket)

Start TLS on an existing socket. Supports the "STARTTLS" command in many protocols. This version for compatibility with possible third party code that might've used this API even though it shouldn't.

Parameters
socket
Throws
IOException

public static Socket startTLS (Socket socket, String host, Properties props, String prefix)

Start TLS on an existing socket. Supports the "STARTTLS" command in many protocols.

Parameters
socket
host
props
prefix
Throws
IOException