Save This Page
Home » apache-tomcat-6.0.26-src » org.apache » coyote » tomcat5 » [javadoc | source]
org.apache.coyote.tomcat5
public class: CoyoteConnector [javadoc | source]
java.lang.Object
   org.apache.coyote.tomcat5.CoyoteConnector

All Implemented Interfaces:
    Connector, MBeanRegistration, Lifecycle

Implementation of a Coyote connector for Tomcat 5.x.
Field Summary
protected  Container container    The Container used for processing requests received by this Connector. 
protected  LifecycleSupport lifecycle    The lifecycle event support for this component. 
protected  int minProcessors    The minimum number of processors to start at initialization time. 
protected  boolean initialized    Has this component been initialized yet? 
protected  MapperListener mapperListener    Mapper listener. 
protected  boolean authPassthroughEnabled    Flag indicating whether this connector is receiving its requests from a trusted intermediate server 
protected  ProxyHandler proxyHandler     
protected  String domain     
protected  ObjectName oname     
protected  MBeanServer mserver     
 ObjectName controller     
Method from org.apache.coyote.tomcat5.CoyoteConnector Summary:
addLifecycleListener,   createRequest,   createResponse,   destroy,   findLifecycleListeners,   getAcceptCount,   getAdapter,   getAddress,   getAllowTrace,   getAuthPassthroughEnabled,   getBlocking,   getBufferSize,   getCertificates,   getCiphers,   getClientAuth,   getCompression,   getConnectionLinger,   getConnectionTimeout,   getConnectionUploadTimeout,   getContainer,   getController,   getDebug,   getDefaultHost,   getDisableUploadTimeout,   getDomain,   getEnableLookups,   getFactory,   getInfo,   getKeepAlive,   getKeyAlias,   getKeystoreFile,   getKeystorePass,   getMapper,   getMaxHttpHeaderSize,   getMaxKeepAliveRequests,   getMaxPostSize,   getMaxProcessors,   getMinProcessors,   getObjectName,   getPort,   getProperty,   getProtocol,   getProtocolHandler,   getProtocolHandlerClassName,   getProxyHandler,   getProxyName,   getProxyPort,   getRedirectPort,   getScheme,   getSecure,   getSelectorThreadImpl,   getServerSocketTimeout,   getService,   getSslProtocol,   getSslProtocols,   getTcpNoDelay,   getTomcatAuthentication,   getURIEncoding,   init,   initialize,   isAvailable,   isEnabled,   isXpoweredBy,   postDeregister,   postRegister,   preDeregister,   preRegister,   removeLifecycleListener,   removeProperty,   setAcceptCount,   setAdapter,   setAddress,   setAllowTrace,   setAuthPassthroughEnabled,   setBlocking,   setBufferSize,   setCiphers,   setClientAuth,   setCompression,   setConnectionLinger,   setConnectionTimeout,   setConnectionUploadTimeout,   setContainer,   setController,   setDebug,   setDefaultHost,   setDisableUploadTimeout,   setEnableLookups,   setFactory,   setIsEnabled,   setKeepAlive,   setKeyAlias,   setKeystoreFile,   setKeystorePass,   setMaxHttpHeaderSize,   setMaxKeepAliveRequests,   setMaxPostSize,   setMaxProcessors,   setMinProcessors,   setPort,   setProperty,   setProtocol,   setProtocolHandler,   setProtocolHandlerClassName,   setProxyHandler,   setProxyName,   setProxyPort,   setRedirectPort,   setSSL3SessionTimeout,   setSSLSessionCacheSize,   setSSLSessionTimeout,   setScheme,   setSecure,   setSelectorThreadImpl,   setServerSocketTimeout,   setService,   setSslProtocol,   setSslProtocols,   setTcpNoDelay,   setTomcatAuthentication,   setURIEncoding,   setXpoweredBy,   start,   stop
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.coyote.tomcat5.CoyoteConnector Detail:
 public  void addLifecycleListener(LifecycleListener listener) 
    Add a lifecycle event listener to this component.
 public Request createRequest() 
    Create (or allocate) and return a Request object suitable for specifying the contents of a Request to the responsible Container.
 public Response createResponse() 
    Create (or allocate) and return a Response object suitable for receiving the contents of a Response from the responsible Container.
 public  void destroy() throws Exception 
 public LifecycleListener[] findLifecycleListeners() 
    Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.
 public int getAcceptCount() 
    Return the accept count for this Connector.
 public Adapter getAdapter() 
    Get the Adapter used by this connector.
 public String getAddress() 
    Return the bind IP address for this Connector.
 public boolean getAllowTrace() 
    True if the TRACE method is allowed. Default value is "false".
 public boolean getAuthPassthroughEnabled() 
    Returns the value of this connector's authPassthroughEnabled flag.
 public boolean getBlocking() 
    Return the blocking connection flag that will be assigned to requests received through this connector. Default value is "false".
 public int getBufferSize() 
    Return the input buffer size for this Connector.
 public X509Certificate[] getCertificates(Request request) 
    Get the underlying WebContainer certificate for the request
 public String getCiphers() 
    Gets the list of SSL cipher suites that are to be enabled
 public boolean getClientAuth() 
 public String getCompression() 
    Get the value of compression.
 public int getConnectionLinger() 
    Return the connection linger for this Connector.
 public int getConnectionTimeout() 
    Return the connection timeout for this Connector.
 public int getConnectionUploadTimeout() 
    Return the connection upload timeout for this Connector.
 public Container getContainer() 
    Return the Container used for processing requests received by this Connector.
 public ObjectName getController() 
 public int getDebug() 
    Return the debugging detail level for this component.
 public String getDefaultHost() 
    Gets the default host of this Connector.
 public boolean getDisableUploadTimeout() 
    Return the flag that specifies upload time-out behavior.
 public String getDomain() 
 public boolean getEnableLookups() 
    Return the "enable DNS lookups" flag.
 public ServerSocketFactory getFactory() 
    Return the server socket factory used by this Container.
 public String getInfo() 
    Return descriptive information about this Connector implementation.
 public boolean getKeepAlive() 
    Return the Keep-Alive policy for the connection.
 public String getKeyAlias() 
    Gets the alias name of the keypair and supporting certificate chain used by this Connector to authenticate itself to SSL clients.
 public String getKeystoreFile() 
 public String getKeystorePass() 
    Return keystorePass
 public Mapper getMapper() 
    Return the mapper.
 public int getMaxHttpHeaderSize() 
    Return the maximum HTTP header size.
 public int getMaxKeepAliveRequests() 
    Return the maximum number of Keep-Alive requests to honor per connection.
 public int getMaxPostSize() 
    Return the maximum size of a POST which will be automatically parsed by the container.
 public int getMaxProcessors() 
    Return the maximum number of processors allowed, or <0 for unlimited.
 public int getMinProcessors() 
    Return the minimum number of processors to start at initialization.
 public ObjectName getObjectName() 
 public int getPort() 
    Return the port number on which we listen for requests.
 public Object getProperty(String name) 
    Return a configured property.
 public String getProtocol() 
    Return the Coyote protocol handler in use.
 public ProtocolHandler getProtocolHandler() 
    Return the protocol handler associated with the connector.
 public String getProtocolHandlerClassName() 
    Return the class name of the Coyote protocol handler in use.
 public ProxyHandler getProxyHandler() 
    Gets the ProxyHandler instance associated with this CoyoteConnector.
 public String getProxyName() 
    Return the proxy server name for this Connector.
 public int getProxyPort() 
    Return the proxy server port for this Connector.
 public int getRedirectPort() 
    Return the port number to which a request should be redirected if it comes in on a non-SSL port and is subject to a security constraint with a transport guarantee that requires SSL.
 public String getScheme() 
    Return the scheme that will be assigned to requests received through this connector. Default value is "http".
 public boolean getSecure() 
    Return the secure connection flag that will be assigned to requests received through this connector. Default value is "false".
 public String getSelectorThreadImpl() 
    Get the underlying SelectorThread implementation, null if the default is used.
 public int getServerSocketTimeout() 
    Return the server socket timeout for this Connector.
 public Service getService() 
    Return the Service with which we are associated (if any).
 public String getSslProtocol() 
    Gets the SSL protocol variant to be used.
 public String getSslProtocols() 
    Gets the SSL protocol variants to be enabled.
 public boolean getTcpNoDelay() 
    Return the TCP no delay flag value.
 public boolean getTomcatAuthentication() 
 public String getURIEncoding() 
    Return the character encoding to be used for the URI.
 public  void init() throws Exception 
 public  void initialize() throws LifecycleException 
    Initialize this connector (create ServerSocket here!)
 public boolean isAvailable() 
    Is this connector available for processing requests?
 public boolean isEnabled() 
 public boolean isXpoweredBy() 
    Indicates whether the generation of an X-Powered-By response header for servlet-generated responses is enabled or disabled for this Connector.
 public  void postDeregister() 
 public  void postRegister(Boolean registrationDone) 
 public  void preDeregister() throws Exception 
 public ObjectName preRegister(MBeanServer server,
    ObjectName name) throws Exception 
 public  void removeLifecycleListener(LifecycleListener listener) 
    Remove a lifecycle event listener from this component.
 public  void removeProperty(String name) 
    remove a configured property.
 public  void setAcceptCount(int count) 
    Set the accept count for this Connector.
 public  void setAdapter(Adapter adapter) 
    Set the Adapter used by this connector.
 public  void setAddress(String address) 
    Set the bind IP address for this Connector.
 public  void setAllowTrace(boolean allowTrace) 
    Set the allowTrace flag, to disable or enable the TRACE HTTP method. *
 public  void setAuthPassthroughEnabled(boolean authPassthroughEnabled) 
    Sets the value of this connector's authPassthroughEnabled flag.
 public  void setBlocking(boolean blocking) 
    Set the blocking connection flag that will be assigned to requests received through this connector.
 public  void setBufferSize(int bufferSize) 
    Set the input buffer size for this Connector.
 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.
 public  void setClientAuth(boolean clientAuth) 
 public  void setCompression(String compression) 
    Set the value of compression.
 public  void setConnectionLinger(int connectionLinger) 
    Set the connection linger for this Connector.
 public  void setConnectionTimeout(int connectionTimeout) 
    Set the connection timeout for this Connector.
 public  void setConnectionUploadTimeout(int connectionUploadTimeout) 
    Set the connection upload timeout for this Connector.
 public  void setContainer(Container container) 
    Set the Container used for processing requests received by this Connector.
 public  void setController(ObjectName controller) 
 public  void setDebug(int debug) 
    Set the debugging detail level for this component.
 public  void setDefaultHost(String defaultHost) 
    Sets the default host for this Connector.
 public  void setDisableUploadTimeout(boolean isDisabled) 
    Set the flag to specify upload time-out behavior.
 public  void setEnableLookups(boolean enableLookups) 
    Set the "enable DNS lookups" flag.
 public  void setFactory(ServerSocketFactory factory) 
    Set the server socket factory used by this Container.
 public  void setIsEnabled(boolean isEnabled) 
 public  void setKeepAlive(boolean keepAlive) 
    Set the keep-alive policy for this connection.
 public  void setKeyAlias(String alias) 
    Sets the alias name of the keypair and supporting certificate chain used by this Connector to authenticate itself to SSL clients.
 public  void setKeystoreFile(String keystoreFile) 
 public  void setKeystorePass(String keystorePass) 
    Set keystorePass
 public  void setMaxHttpHeaderSize(int size) 
    Set the maximum HTTP header size.
 public  void setMaxKeepAliveRequests(int mkar) 
    Set the maximum number of Keep-Alive requests to honor per connection.
 public  void setMaxPostSize(int maxPostSize) 
    Set the maximum size of a POST which will be automatically parsed by the container.
 public  void setMaxProcessors(int maxProcessors) 
    Set the maximum number of processors allowed, or <0 for unlimited.
 public  void setMinProcessors(int minProcessors) 
    Set the minimum number of processors to start at initialization.
 public  void setPort(int port) 
    Set the port number on which we listen for requests.
 public  void setProperty(String name,
    Object value) 
    Set a configured property.
 public  void setProtocol(String protocol) 
    Set the Coyote protocol which will be used by the connector.
 public  void setProtocolHandler(ProtocolHandler protocolHandler) 
    Set the ProtocolHandler used by this connector.
 public  void setProtocolHandlerClassName(String protocolHandlerClassName) 
    Set the class name of the Coyote protocol handler which will be used by the connector.
 public  void setProxyHandler(ProxyHandler proxyHandler) 
    Sets the ProxyHandler implementation for this CoyoteConnector to use.
 public  void setProxyName(String proxyName) 
    Set the proxy server name for this Connector.
 public  void setProxyPort(int proxyPort) 
    Set the proxy server port for this Connector.
 public  void setRedirectPort(int redirectPort) 
    Set the redirect port number.
 public  void setSSL3SessionTimeout(String timeout) 
    Sets the number of seconds after which SSL3 sessions expire and are removed from the SSL sessions cache.
 public  void setSSLSessionCacheSize(String cacheSize) 
    Sets the number of SSL sessions that may be cached
 public  void setSSLSessionTimeout(String timeout) 
    Sets the number of seconds after which SSL sessions expire and are removed from the SSL sessions cache.
 public  void setScheme(String scheme) 
    Set the scheme that will be assigned to requests received through this connector.
 public  void setSecure(boolean secure) 
    Set the secure connection flag that will be assigned to requests received through this connector.
 public  void setSelectorThreadImpl(String selectorThreadImpl) 
    Set the underlying SelectorThread implementation
 public  void setServerSocketTimeout(int serverSocketTimeout) 
    Set the server socket timeout for this Connector.
 public  void setService(Service service) 
    Set the Service with which we are associated (if any).
 public  void setSslProtocol(String sslProtocol) 
    Sets the SSL protocol variant to be used.
 public  void setSslProtocols(String sslProtocols) 
    Sets the SSL protocol variants to be enabled.
 public  void setTcpNoDelay(boolean tcpNoDelay) 
    Set the TCP no delay flag which will be set on the socket after accepting a connection.
 public  void setTomcatAuthentication(boolean tomcatAuthentication) 
 public  void setURIEncoding(String uriEncoding) 
    Set the URI encoding to be used for the URI.
 public  void setXpoweredBy(boolean xpoweredBy) 
    Enables or disables the generation of an X-Powered-By header (with value Servlet/2.4) for all servlet-generated responses returned by this Connector.
 public  void start() throws LifecycleException 
    Begin processing requests via this Connector.
 public  void stop() throws LifecycleException 
    Terminate processing requests via this Connector.