FileDocCategorySizeDatePackage
CoyoteServerSocketFactory.javaAPI DocGlassfish v2 API11082Fri May 04 22:32:44 BST 2007org.apache.coyote.tomcat5

CoyoteServerSocketFactory

public class CoyoteServerSocketFactory extends Object implements org.apache.catalina.net.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:
  • algorithm - Certificate encoding algorithm to use. [SunX509]
  • clientAuth - Require client authentication if set to true. [false]
  • keystoreFile - Pathname to the Key Store file to be loaded. This must be an absolute path, or a relative path that is resolved against the "catalina.base" system property. ["./keystore" in the user home directory]
  • keystorePass - Password for the Key Store file to be loaded. ["changeit"]
  • keystoreType - Type of the Key Store file to be loaded. ["JKS"]
  • protocol - SSL protocol to use. [TLS]
author
Harish Prabandham
author
Costin Manolache
author
Craig McClanahan

Fields Summary
private String
algorithm
private boolean
clientAuth
private String
keystoreFile
private String
randomFile
private String
rootFile
private String
keystorePass
private String
keystoreType
private String
protocol
private String
protocols
private String
sslImplementation
private String
cipherSuites
private String
keyAlias
Constructors Summary
Methods Summary
public java.net.ServerSocketcreateSocket(int port)

        return (null);
    
public java.net.ServerSocketcreateSocket(int port, int backlog)

        return (null);
    
public java.net.ServerSocketcreateSocket(int port, int backlog, java.net.InetAddress ifAddress)

        return (null);
    
public java.lang.StringgetAlgorithm()
Gets the certificate encoding algorithm to be used.

return
Certificate encoding algorithm


    // ------------------------------------------------------------- Properties

                     
       
        return (this.algorithm);
    
public java.lang.StringgetCiphers()
Gets the list of SSL cipher suites that are to be enabled

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

	return this.cipherSuites;
    
public booleangetClientAuth()
Provides information about whether client authentication is enforced.

return
true if client authentication is enforced, false otherwise

        return (this.clientAuth);
    
public java.lang.StringgetKeyAlias()
Gets the alias name of the keypair and supporting certificate chain used by the server to authenticate itself to SSL clients.

return
The alias name of the keypair and supporting certificate chain

        return this.keyAlias;
    
public java.lang.StringgetKeystoreFile()
Gets the pathname to the keystore file.

return
Pathname to the keystore file

        return (this.keystoreFile);
    
public java.lang.StringgetKeystorePass()
Gets the keystore password.

return
Keystore password

        return (this.keystorePass);
    
public java.lang.StringgetKeystoreType()
Gets the keystore type.

return
Keystore type

        return (this.keystoreType);
    
public java.lang.StringgetProtocol()
Gets the SSL protocol variant to be used.

return
SSL protocol variant

        return (this.protocol);
    
public java.lang.StringgetProtocols()
Gets the SSL protocol variants to be enabled.

return
Comma-separated list of SSL protocol variants

        return this.protocols;
    
public java.lang.StringgetRandomFile()
Gets the pathname to the random file.

return
Pathname to the random file

        return (this.randomFile);
    
public java.lang.StringgetRootFile()
Gets the pathname to the root list.

return
Pathname to the root list

        return (this.rootFile);
    
public java.lang.StringgetSSLImplementation()
Gets the name of the SSL implementation to be used.

return
SSL implementation name

        return (this.sslImplementation);
    
public voidsetAlgorithm(java.lang.String algorithm)
Sets the certificate encoding algorithm to be used.

param
algorithm Certificate encoding algorithm

        this.algorithm = algorithm;
    
public voidsetCiphers(java.lang.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.

param
ciphers Comma-separated list of SSL cipher suites

	this.cipherSuites = ciphers;
    
public voidsetClientAuth(boolean clientAuth)
Sets the requirement of client authentication.

param
clientAuth true if client authentication is enforced, false otherwise

        this.clientAuth = clientAuth;
    
public voidsetKeyAlias(java.lang.String alias)
Sets the alias name of the keypair and supporting certificate chain used by the server to authenticate itself to SSL clients.

param
alias The alias name of the keypair and supporting certificate chain

        this.keyAlias = alias;
    
public voidsetKeystoreFile(java.lang.String keystoreFile)
Sets the pathname to the keystore file.

param
keystoreFile Pathname to the keystore file

      
        File file = new File(keystoreFile);
        if (!file.isAbsolute())
            file = new File(System.getProperty("catalina.base"),
                            keystoreFile);
        this.keystoreFile = file.getAbsolutePath();
    
public voidsetKeystorePass(java.lang.String keystorePass)
Sets the keystore password.

param
keystorePass Keystore password

        this.keystorePass = keystorePass;
    
public voidsetKeystoreType(java.lang.String keystoreType)
Sets the keystore type.

param
keystoreType Keystore type

        this.keystoreType = keystoreType;
    
public voidsetProtocol(java.lang.String protocol)
Sets the SSL protocol variant to be used.

param
protocol SSL protocol variant

        this.protocol = protocol;
    
public voidsetProtocols(java.lang.String protocols)
Sets the SSL protocol variants to be enabled.

param
protocols Comma-separated list of SSL protocol variants

        this.protocols = protocols;
    
public voidsetRandomFile(java.lang.String randomFile)
Sets the pathname to the random file.

param
randomFile Pathname to the random file

      
        File file = new File(randomFile);
        if (!file.isAbsolute())
            file = new File(System.getProperty("catalina.base"),
                            randomFile);
        this.randomFile = file.getAbsolutePath();
    
public voidsetRootFile(java.lang.String rootFile)
Sets the pathname to the root list.

param
rootFile Pathname to the root list

      
        File file = new File(rootFile);
        if (!file.isAbsolute())
            file = new File(System.getProperty("catalina.base"),
                            rootFile);
        this.rootFile = file.getAbsolutePath();
    
public voidsetSSLImplementation(java.lang.String sslImplementation)
Sets the name of the SSL implementation to be used.

param
sslImplementation SSL implementation name

        this.sslImplementation = sslImplementation;