org.apache.coyote.tomcat5

Class CoyoteServerSocketFactory

Implemented Interfaces:
ServerSocketFactory

public class CoyoteServerSocketFactory
extends java.lang.Object
implements ServerSocketFactory

This socket factory holds secure socket factory parameters. Besides the usual configuration mechanism based on setting JavaBeans properties, this component may also be configured by passing a series of attributes set with calls to setAttribute(). The following attribute names are recognized, with default values in square brackets:

Authors:
Harish Prabandham
Costin Manolache
Craig McClanahan

Method Summary

ServerSocket
createSocket(int port)
ServerSocket
createSocket(int port, int backlog)
ServerSocket
createSocket(int port, int backlog, InetAddress ifAddress)
String
getAlgorithm()
Gets the certificate encoding algorithm to be used.
String
getCiphers()
Gets the list of SSL cipher suites that are to be enabled
String
getClientAuth()
Provides information about whether client authentication is enforced.
String
getKeyAlias()
Gets the alias name of the keypair and supporting certificate chain used by the server to authenticate itself to SSL clients.
String
getKeystoreFile()
Gets the pathname to the keystore file.
String
getKeystorePass()
Gets the keystore password.
String
getKeystoreType()
Gets the keystore type.
String
getProtocol()
Gets the SSL protocol variant to be used.
String
getProtocols()
Gets the SSL protocol variants to be enabled.
String
getRandomFile()
Gets the pathname to the random file.
String
getRootFile()
Gets the pathname to the root list.
String
getSSLImplementation()
Gets the name of the SSL implementation to be used.
void
setAlgorithm(String algorithm)
Sets the certificate encoding algorithm to be used.
void
setCiphers(String ciphers)
Sets the SSL cipher suites that are to be enabled.
void
setClientAuth(String clientAuth)
Sets the requirement of client authentication.
void
setKeyAlias(String alias)
Sets the alias name of the keypair and supporting certificate chain used by the server to authenticate itself to SSL clients.
void
setKeystoreFile(String keystoreFile)
Sets the pathname to the keystore file.
void
setKeystorePass(String keystorePass)
Sets the keystore password.
void
setKeystoreType(String keystoreType)
Sets the keystore type.
void
setProtocol(String protocol)
Sets the SSL protocol variant to be used.
void
setProtocols(String protocols)
Sets the SSL protocol variants to be enabled.
void
setRandomFile(String randomFile)
Sets the pathname to the random file.
void
setRootFile(String rootFile)
Sets the pathname to the root list.
void
setSSLImplementation(String sslImplementation)
Sets the name of the SSL implementation to be used.

Method Details

createSocket

public ServerSocket createSocket(int port)
Specified by:
createSocket in interface ServerSocketFactory


createSocket

public ServerSocket createSocket(int port,
                                 int backlog)
Specified by:
createSocket in interface ServerSocketFactory


createSocket

public ServerSocket createSocket(int port,
                                 int backlog,
                                 InetAddress ifAddress)
Specified by:
createSocket in interface ServerSocketFactory


getAlgorithm

public String getAlgorithm()
Gets the certificate encoding algorithm to be used.

Returns:
Certificate encoding algorithm


getCiphers

public String getCiphers()
Gets the list of SSL cipher suites that are to be enabled

Returns:
Comma-separated list of SSL cipher suites, or null if all cipher suites supported by the underlying SSL implementation are being enabled


getClientAuth

public String getClientAuth()
Provides information about whether client authentication is enforced.

Returns:
true if client authentication is enforced, want if client authentication is desired, false otherwise


getKeyAlias

public String getKeyAlias()
Gets the alias name of the keypair and supporting certificate chain used by the server to authenticate itself to SSL clients.

Returns:
The alias name of the keypair and supporting certificate chain


getKeystoreFile

public String getKeystoreFile()
Gets the pathname to the keystore file.

Returns:
Pathname to the keystore file


getKeystorePass

public String getKeystorePass()
Gets the keystore password.

Returns:
Keystore password


getKeystoreType

public String getKeystoreType()
Gets the keystore type.

Returns:
Keystore type


getProtocol

public String getProtocol()
Gets the SSL protocol variant to be used.

Returns:
SSL protocol variant


getProtocols

public String getProtocols()
Gets the SSL protocol variants to be enabled.

Returns:
Comma-separated list of SSL protocol variants


getRandomFile

public String getRandomFile()
Gets the pathname to the random file.

Returns:
Pathname to the random file


getRootFile

public String getRootFile()
Gets the pathname to the root list.

Returns:
Pathname to the root list


getSSLImplementation

public String getSSLImplementation()
Gets the name of the SSL implementation to be used.

Returns:
SSL implementation name


setAlgorithm

public void setAlgorithm(String algorithm)
Sets the certificate encoding algorithm to be used.

Parameters:
algorithm - Certificate encoding algorithm


setCiphers

public void setCiphers(String ciphers)
Sets the SSL cipher suites that are to be enabled. Only those SSL cipher suites that are actually supported by the underlying SSL implementation will be enabled.

Parameters:
ciphers - Comma-separated list of SSL cipher suites


setClientAuth

public void setClientAuth(String clientAuth)
Sets the requirement of client authentication.

Parameters:
clientAuth - true if client authentication is enforced, want if client authentication is desired, false otherwise


setKeyAlias

public void setKeyAlias(String alias)
Sets the alias name of the keypair and supporting certificate chain used by the server to authenticate itself to SSL clients.

Parameters:
alias - The alias name of the keypair and supporting certificate chain


setKeystoreFile

public void setKeystoreFile(String keystoreFile)
Sets the pathname to the keystore file.

Parameters:
keystoreFile - Pathname to the keystore file


setKeystorePass

public void setKeystorePass(String keystorePass)
Sets the keystore password.

Parameters:
keystorePass - Keystore password


setKeystoreType

public void setKeystoreType(String keystoreType)
Sets the keystore type.

Parameters:
keystoreType - Keystore type


setProtocol

public void setProtocol(String protocol)
Sets the SSL protocol variant to be used.

Parameters:
protocol - SSL protocol variant


setProtocols

public void setProtocols(String protocols)
Sets the SSL protocol variants to be enabled.

Parameters:
protocols - Comma-separated list of SSL protocol variants


setRandomFile

public void setRandomFile(String randomFile)
Sets the pathname to the random file.

Parameters:
randomFile - Pathname to the random file


setRootFile

public void setRootFile(String rootFile)
Sets the pathname to the root list.

Parameters:
rootFile - Pathname to the root list


setSSLImplementation

public void setSSLImplementation(String sslImplementation)
Sets the name of the SSL implementation to be used.

Parameters:
sslImplementation - SSL implementation name


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.