Apache Tomcat 6.0.43

org.apache.catalina.connector
Class Connector

java.lang.Object
  extended by org.apache.catalina.connector.Connector
All Implemented Interfaces:
javax.management.MBeanRegistration, Lifecycle

public class Connector
extends java.lang.Object
implements Lifecycle, javax.management.MBeanRegistration

Implementation of a Coyote connector.

Author:
Craig R. McClanahan, Remy Maucherat

Field Summary
protected  Adapter adapter
          Coyote adapter.
protected  boolean allowTrace
          Do we allow TRACE ?
protected  Container container
          The Container used for processing requests received by this Connector.
protected  java.lang.String domain
           
protected  boolean emptySessionPath
          Use "/" as path for session cookies ?
protected  boolean enableLookups
          The "enable DNS lookups" flag for this Connector.
protected static java.lang.String info
          Descriptive information about this Connector implementation.
protected  boolean initialized
          Has this component been initialized yet?
protected  LifecycleSupport lifecycle
          The lifecycle event support for this component.
protected  Mapper mapper
          Mapper.
protected  MapperListener mapperListener
          Mapper listener.
protected  int maxParameterCount
          The maximum number of parameters (GET plus POST) which will be automatically parsed by the container. 10000 by default.
protected  int maxPostSize
          Maximum size of a POST which will be automatically parsed by the container. 2MB by default.
protected  int maxSavePostSize
          Maximum size of a POST which will be saved by the container during authentication. 4kB by default
protected  javax.management.MBeanServer mserver
           
protected  javax.management.ObjectName oname
           
protected  java.lang.String parseBodyMethods
          Comma-separated list of HTTP methods that will be parsed according to POST-style rules for application/x-www-form-urlencoded request bodies.
protected  java.util.Set<java.lang.String> parseBodyMethodsSet
          A Set of methods determined by parseBodyMethods.
protected  int port
          The port number on which we listen for requests.
protected  ProtocolHandler protocolHandler
          Coyote protocol handler.
protected  java.lang.String protocolHandlerClassName
          Coyote Protocol handler class name.
protected  java.lang.String proxyName
          The server name to which we should pretend requests to this Connector were directed.
protected  int proxyPort
          The server port to which we should pretent requests to this Connector were directed.
static boolean RECYCLE_FACADES
          Alternate flag to enable recycling of facades.
protected  int redirectPort
          The redirect port for non-SSL to SSL redirects.
protected static java.util.HashMap replacements
           
protected  java.lang.String scheme
          The request scheme that will be set on all requests received through this connector.
protected  boolean secure
          The secure connection flag that will be set on all requests received through this connector.
protected  Service service
          The Service we are associated with (if any).
protected  StringManager sm
          The string manager for this package.
protected  boolean started
          Has this component been started yet?
protected  boolean stopped
          The shutdown signal to our background thread
protected  java.lang.Thread thread
          The background thread.
protected  java.lang.String URIEncoding
          URI encoding.
protected  boolean useBodyEncodingForURI
          URI encoding as body.
protected  boolean useIPVHosts
          Flag to use IP-based virtual hosting.
protected  boolean xpoweredBy
           
 
Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
 
Constructor Summary
Connector()
           
Connector(java.lang.String protocol)
           
 
Method Summary
 void addLifecycleListener(LifecycleListener listener)
          Add a lifecycle event listener to this component.
protected  javax.management.ObjectName createObjectName(java.lang.String domain, java.lang.String type)
           
 Request createRequest()
          Create (or allocate) and return a Request object suitable for specifying the contents of a Request to the responsible Container.
 Response createResponse()
          Create (or allocate) and return a Response object suitable for receiving the contents of a Response from the responsible Container.
 void destroy()
           
protected  void findContainer()
           
 LifecycleListener[] findLifecycleListeners()
          Get the lifecycle listeners associated with this lifecycle.
 boolean getAllowTrace()
          True if the TRACE method is allowed.
 java.lang.Object getAttribute(java.lang.String name)
          Return a configured property.
 int getBufferSize()
          Deprecated.  
 Container getContainer()
          Return the Container used for processing requests received by this Connector.
 javax.management.ObjectName getController()
           
 java.lang.String getDomain()
           
 boolean getEmptySessionPath()
          Return the "empty session path" flag.
 boolean getEnableLookups()
          Return the "enable DNS lookups" flag.
 java.lang.String getExecutorName()
           
 java.lang.String getInfo()
          Return descriptive information about this Connector implementation.
 Mapper getMapper()
          Return the mapper.
 int getMaxHeaderCount()
          Return the maximum number of headers that are allowed by the container.
 int getMaxParameterCount()
          Return the maximum number of parameters (GET plus POST) that will be automatically parsed by the container.
 int getMaxPostSize()
          Return the maximum size of a POST which will be automatically parsed by the container.
 int getMaxSavePostSize()
          Return the maximum size of a POST which will be saved by the container during authentication.
 javax.management.ObjectName getObjectName()
           
 java.lang.String getParseBodyMethods()
           
 int getPort()
          Return the port number on which we listen for requests.
 java.lang.Object getProperty(java.lang.String name)
          Return a configured property.
 java.lang.String getProtocol()
          Return the Coyote protocol handler in use.
 ProtocolHandler getProtocolHandler()
          Return the protocol handler associated with the connector.
 java.lang.String getProtocolHandlerClassName()
          Return the class name of the Coyote protocol handler in use.
 java.lang.String getProxyName()
          Return the proxy server name for this Connector.
 int getProxyPort()
          Return the proxy server port for this Connector.
 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.
 java.lang.String getScheme()
          Return the scheme that will be assigned to requests received through this connector.
 boolean getSecure()
          Return the secure connection flag that will be assigned to requests received through this connector.
 Service getService()
          Return the Service with which we are associated (if any).
 java.lang.String getURIEncoding()
          Return the character encoding to be used for the URI.
 boolean getUseBodyEncodingForURI()
          Return the true if the entity body encoding should be used for the URI.
 boolean getUseIPVHosts()
          Test if IP-based virtual hosting is enabled.
 boolean getXpoweredBy()
          Indicates whether the generation of an X-Powered-By response header for servlet-generated responses is enabled or disabled for this Connector.
 void init()
           
 void initialize()
          Initialize this connector (create ServerSocket here!)
 boolean isAvailable()
          Is this connector available for processing requests?
protected  boolean isParseBodyMethod(java.lang.String method)
           
 void pause()
          Pause the connector.
 void postDeregister()
           
 void postRegister(java.lang.Boolean registrationDone)
           
 void preDeregister()
           
 javax.management.ObjectName preRegister(javax.management.MBeanServer server, javax.management.ObjectName name)
           
 void removeLifecycleListener(LifecycleListener listener)
          Remove a lifecycle event listener from this component.
 void removeProperty(java.lang.String name)
          remove a configured property.
 void resume()
          Pause the connector.
 void setAllowTrace(boolean allowTrace)
          Set the allowTrace flag, to disable or enable the TRACE HTTP method.
 void setAttribute(java.lang.String name, java.lang.Object value)
          Set a configured property.
 void setBufferSize(int bufferSize)
          Deprecated.  
 void setContainer(Container container)
          Set the Container used for processing requests received by this Connector.
 void setController(javax.management.ObjectName controller)
           
 void setEmptySessionPath(boolean emptySessionPath)
          Set the "empty session path" flag.
 void setEnableLookups(boolean enableLookups)
          Set the "enable DNS lookups" flag.
 void setMaxHeaderCount(int maxHeaderCount)
          Set the maximum number of headers in a request that are allowed by the container.
 void setMaxParameterCount(int maxParameterCount)
          Set the maximum number of parameters (GET plus POST) that will be automatically parsed by the container.
 void setMaxPostSize(int maxPostSize)
          Set the maximum size of a POST which will be automatically parsed by the container.
 void setMaxSavePostSize(int maxSavePostSize)
          Set the maximum size of a POST which will be saved by the container during authentication.
 void setParseBodyMethods(java.lang.String methods)
           
 void setPort(int port)
          Set the port number on which we listen for requests.
 boolean setProperty(java.lang.String name, java.lang.String value)
          Set a configured property.
 void setProtocol(java.lang.String protocol)
          Set the Coyote protocol which will be used by the connector.
 void setProtocolHandlerClassName(java.lang.String protocolHandlerClassName)
          Set the class name of the Coyote protocol handler which will be used by the connector.
 void setProxyName(java.lang.String proxyName)
          Set the proxy server name for this Connector.
 void setProxyPort(int proxyPort)
          Set the proxy server port for this Connector.
 void setRedirectPort(int redirectPort)
          Set the redirect port number.
 void setScheme(java.lang.String scheme)
          Set the scheme that will be assigned to requests received through this connector.
 void setSecure(boolean secure)
          Set the secure connection flag that will be assigned to requests received through this connector.
 void setService(Service service)
          Set the Service with which we are associated (if any).
 void setURIEncoding(java.lang.String URIEncoding)
          Set the URI encoding to be used for the URI.
 void setUseBodyEncodingForURI(boolean useBodyEncodingForURI)
          Set if the entity body encoding should be used for the URI.
 void setUseIPVHosts(boolean useIPVHosts)
          Enable the use of IP-based virtual hosting.
 void setXpoweredBy(boolean xpoweredBy)
          Enables or disables the generation of an X-Powered-By header (with value Servlet/2.5) for all servlet-generated responses returned by this Connector.
 void start()
          Begin processing requests via this Connector.
 void stop()
          Terminate processing requests via this Connector.
 java.lang.String toString()
          Provide a useful toString() implementation as it may be used when logging Lifecycle errors to identify the component.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RECYCLE_FACADES

public static final boolean RECYCLE_FACADES
Alternate flag to enable recycling of facades.


service

protected Service service
The Service we are associated with (if any).


allowTrace

protected boolean allowTrace
Do we allow TRACE ?


container

protected Container container
The Container used for processing requests received by this Connector.


emptySessionPath

protected boolean emptySessionPath
Use "/" as path for session cookies ?


enableLookups

protected boolean enableLookups
The "enable DNS lookups" flag for this Connector.


xpoweredBy

protected boolean xpoweredBy

info

protected static final java.lang.String info
Descriptive information about this Connector implementation.

See Also:
Constant Field Values

lifecycle

protected LifecycleSupport lifecycle
The lifecycle event support for this component.


port

protected int port
The port number on which we listen for requests.


proxyName

protected java.lang.String proxyName
The server name to which we should pretend requests to this Connector were directed. This is useful when operating Tomcat behind a proxy server, so that redirects get constructed accurately. If not specified, the server name included in the Host header is used.


proxyPort

protected int proxyPort
The server port to which we should pretent requests to this Connector were directed. This is useful when operating Tomcat behind a proxy server, so that redirects get constructed accurately. If not specified, the port number specified by the port property is used.


redirectPort

protected int redirectPort
The redirect port for non-SSL to SSL redirects.


scheme

protected java.lang.String scheme
The request scheme that will be set on all requests received through this connector.


secure

protected boolean secure
The secure connection flag that will be set on all requests received through this connector.


sm

protected StringManager sm
The string manager for this package.


maxParameterCount

protected int maxParameterCount
The maximum number of parameters (GET plus POST) which will be automatically parsed by the container. 10000 by default. A value of less than 0 means no limit.


maxPostSize

protected int maxPostSize
Maximum size of a POST which will be automatically parsed by the container. 2MB by default.


maxSavePostSize

protected int maxSavePostSize
Maximum size of a POST which will be saved by the container during authentication. 4kB by default


parseBodyMethods

protected java.lang.String parseBodyMethods
Comma-separated list of HTTP methods that will be parsed according to POST-style rules for application/x-www-form-urlencoded request bodies.


parseBodyMethodsSet

protected java.util.Set<java.lang.String> parseBodyMethodsSet
A Set of methods determined by parseBodyMethods.


initialized

protected boolean initialized
Has this component been initialized yet?


started

protected boolean started
Has this component been started yet?


stopped

protected boolean stopped
The shutdown signal to our background thread


useIPVHosts

protected boolean useIPVHosts
Flag to use IP-based virtual hosting.


thread

protected java.lang.Thread thread
The background thread.


protocolHandlerClassName

protected java.lang.String protocolHandlerClassName
Coyote Protocol handler class name. Defaults to the Coyote HTTP/1.1 protocolHandler.


protocolHandler

protected ProtocolHandler protocolHandler
Coyote protocol handler.


adapter

protected Adapter adapter
Coyote adapter.


mapper

protected Mapper mapper
Mapper.


mapperListener

protected MapperListener mapperListener
Mapper listener.


URIEncoding

protected java.lang.String URIEncoding
URI encoding.


useBodyEncodingForURI

protected boolean useBodyEncodingForURI
URI encoding as body.


replacements

protected static java.util.HashMap replacements

domain

protected java.lang.String domain

oname

protected javax.management.ObjectName oname

mserver

protected javax.management.MBeanServer mserver
Constructor Detail

Connector

public Connector()
          throws java.lang.Exception
Throws:
java.lang.Exception

Connector

public Connector(java.lang.String protocol)
          throws java.lang.Exception
Throws:
java.lang.Exception
Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String name)
Return a configured property.


setProperty

public boolean setProperty(java.lang.String name,
                           java.lang.String value)
Set a configured property.


getAttribute

public java.lang.Object getAttribute(java.lang.String name)
Return a configured property.


setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)
Set a configured property.


removeProperty

public void removeProperty(java.lang.String name)
remove a configured property.


getService

public Service getService()
Return the Service with which we are associated (if any).


setService

public void setService(Service service)
Set the Service with which we are associated (if any).

Parameters:
service - The service that owns this Engine

getAllowTrace

public boolean getAllowTrace()
True if the TRACE method is allowed. Default value is "false".


setAllowTrace

public void setAllowTrace(boolean allowTrace)
Set the allowTrace flag, to disable or enable the TRACE HTTP method.

Parameters:
allowTrace - The new allowTrace flag

isAvailable

public boolean isAvailable()
Is this connector available for processing requests?


getBufferSize

public int getBufferSize()
Deprecated. 

Return the input buffer size for this Connector.


setBufferSize

public void setBufferSize(int bufferSize)
Deprecated. 

Set the input buffer size for this Connector.

Parameters:
bufferSize - The new input buffer size.

getContainer

public Container getContainer()
Return the Container used for processing requests received by this Connector.


setContainer

public void setContainer(Container container)
Set the Container used for processing requests received by this Connector.

Parameters:
container - The new Container to use

getEmptySessionPath

public boolean getEmptySessionPath()
Return the "empty session path" flag.


setEmptySessionPath

public void setEmptySessionPath(boolean emptySessionPath)
Set the "empty session path" flag.

Parameters:
emptySessionPath - The new "empty session path" flag value

getEnableLookups

public boolean getEnableLookups()
Return the "enable DNS lookups" flag.


setEnableLookups

public void setEnableLookups(boolean enableLookups)
Set the "enable DNS lookups" flag.

Parameters:
enableLookups - The new "enable DNS lookups" flag value

getInfo

public java.lang.String getInfo()
Return descriptive information about this Connector implementation.


getMapper

public Mapper getMapper()
Return the mapper.


getMaxHeaderCount

public int getMaxHeaderCount()
Return the maximum number of headers that are allowed by the container. A value of less than 0 means no limit.


setMaxHeaderCount

public void setMaxHeaderCount(int maxHeaderCount)
Set the maximum number of headers in a request that are allowed by the container. A value of less than 0 means no limit.

Parameters:
maxHeaderCount - The new setting

getMaxParameterCount

public int getMaxParameterCount()
Return the maximum number of parameters (GET plus POST) that will be automatically parsed by the container. A value of less than 0 means no limit.


setMaxParameterCount

public void setMaxParameterCount(int maxParameterCount)
Set the maximum number of parameters (GET plus POST) that will be automatically parsed by the container. A value of less than 0 means no limit.

Parameters:
maxParameterCount - The new setting

getMaxPostSize

public int getMaxPostSize()
Return the maximum size of a POST which will be automatically parsed by the container.


setMaxPostSize

public void setMaxPostSize(int maxPostSize)
Set the maximum size of a POST which will be automatically parsed by the container.

Parameters:
maxPostSize - The new maximum size in bytes of a POST which will be automatically parsed by the container

getMaxSavePostSize

public int getMaxSavePostSize()
Return the maximum size of a POST which will be saved by the container during authentication.


setMaxSavePostSize

public void setMaxSavePostSize(int maxSavePostSize)
Set the maximum size of a POST which will be saved by the container during authentication.

Parameters:
maxSavePostSize - The new maximum size in bytes of a POST which will be saved by the container during authentication.

getParseBodyMethods

public java.lang.String getParseBodyMethods()

setParseBodyMethods

public void setParseBodyMethods(java.lang.String methods)

isParseBodyMethod

protected boolean isParseBodyMethod(java.lang.String method)

getPort

public int getPort()
Return the port number on which we listen for requests.


setPort

public void setPort(int port)
Set the port number on which we listen for requests.

Parameters:
port - The new port number

getProtocol

public java.lang.String getProtocol()
Return the Coyote protocol handler in use.


setProtocol

public void setProtocol(java.lang.String protocol)
Set the Coyote protocol which will be used by the connector.

Parameters:
protocol - The Coyote protocol name

getProtocolHandlerClassName

public java.lang.String getProtocolHandlerClassName()
Return the class name of the Coyote protocol handler in use.


setProtocolHandlerClassName

public void setProtocolHandlerClassName(java.lang.String protocolHandlerClassName)
Set the class name of the Coyote protocol handler which will be used by the connector.

Parameters:
protocolHandlerClassName - The new class name

getProtocolHandler

public ProtocolHandler getProtocolHandler()
Return the protocol handler associated with the connector.


getProxyName

public java.lang.String getProxyName()
Return the proxy server name for this Connector.


setProxyName

public void setProxyName(java.lang.String proxyName)
Set the proxy server name for this Connector.

Parameters:
proxyName - The new proxy server name

getProxyPort

public int getProxyPort()
Return the proxy server port for this Connector.


setProxyPort

public void setProxyPort(int proxyPort)
Set the proxy server port for this Connector.

Parameters:
proxyPort - The new proxy server port

getRedirectPort

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.


setRedirectPort

public void setRedirectPort(int redirectPort)
Set the redirect port number.

Parameters:
redirectPort - The redirect port number (non-SSL to SSL)

getScheme

public java.lang.String getScheme()
Return the scheme that will be assigned to requests received through this connector. Default value is "http".


setScheme

public void setScheme(java.lang.String scheme)
Set the scheme that will be assigned to requests received through this connector.

Parameters:
scheme - The new scheme

getSecure

public boolean getSecure()
Return the secure connection flag that will be assigned to requests received through this connector. Default value is "false".


setSecure

public void setSecure(boolean secure)
Set the secure connection flag that will be assigned to requests received through this connector.

Parameters:
secure - The new secure connection flag

getURIEncoding

public java.lang.String getURIEncoding()
Return the character encoding to be used for the URI.


setURIEncoding

public void setURIEncoding(java.lang.String URIEncoding)
Set the URI encoding to be used for the URI.

Parameters:
URIEncoding - The new URI character encoding.

getUseBodyEncodingForURI

public boolean getUseBodyEncodingForURI()
Return the true if the entity body encoding should be used for the URI.


setUseBodyEncodingForURI

public void setUseBodyEncodingForURI(boolean useBodyEncodingForURI)
Set if the entity body encoding should be used for the URI.

Parameters:
useBodyEncodingForURI - The new value for the flag.

getXpoweredBy

public boolean getXpoweredBy()
Indicates whether the generation of an X-Powered-By response header for servlet-generated responses is enabled or disabled for this Connector.

Returns:
true if generation of X-Powered-By response header is enabled, false otherwise

setXpoweredBy

public void setXpoweredBy(boolean xpoweredBy)
Enables or disables the generation of an X-Powered-By header (with value Servlet/2.5) for all servlet-generated responses returned by this Connector.

Parameters:
xpoweredBy - true if generation of X-Powered-By response header is to be enabled, false otherwise

setUseIPVHosts

public void setUseIPVHosts(boolean useIPVHosts)
Enable the use of IP-based virtual hosting.

Parameters:
useIPVHosts - true if Hosts are identified by IP, false/code> if Hosts are identified by name.

getUseIPVHosts

public boolean getUseIPVHosts()
Test if IP-based virtual hosting is enabled.


getExecutorName

public java.lang.String getExecutorName()

createRequest

public Request createRequest()
Create (or allocate) and return a Request object suitable for specifying the contents of a Request to the responsible Container.


createResponse

public Response createResponse()
Create (or allocate) and return a Response object suitable for receiving the contents of a Response from the responsible Container.


addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component.

Specified by:
addLifecycleListener in interface Lifecycle
Parameters:
listener - The listener to add

findLifecycleListeners

public LifecycleListener[] findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.

Specified by:
findLifecycleListeners in interface Lifecycle

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component.

Specified by:
removeLifecycleListener in interface Lifecycle
Parameters:
listener - The listener to add

createObjectName

protected javax.management.ObjectName createObjectName(java.lang.String domain,
                                                       java.lang.String type)
                                                throws javax.management.MalformedObjectNameException
Throws:
javax.management.MalformedObjectNameException

initialize

public void initialize()
                throws LifecycleException
Initialize this connector (create ServerSocket here!)

Throws:
LifecycleException

pause

public void pause()
           throws LifecycleException
Pause the connector.

Throws:
LifecycleException

resume

public void resume()
            throws LifecycleException
Pause the connector.

Throws:
LifecycleException

start

public void start()
           throws LifecycleException
Begin processing requests via this Connector.

Specified by:
start in interface Lifecycle
Throws:
LifecycleException - if a fatal startup error occurs

stop

public void stop()
          throws LifecycleException
Terminate processing requests via this Connector.

Specified by:
stop in interface Lifecycle
Throws:
LifecycleException - if a fatal shutdown error occurs

getController

public javax.management.ObjectName getController()

setController

public void setController(javax.management.ObjectName controller)

getObjectName

public javax.management.ObjectName getObjectName()

getDomain

public java.lang.String getDomain()

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.Exception
Specified by:
preRegister in interface javax.management.MBeanRegistration
Throws:
java.lang.Exception

postRegister

public void postRegister(java.lang.Boolean registrationDone)
Specified by:
postRegister in interface javax.management.MBeanRegistration

preDeregister

public void preDeregister()
                   throws java.lang.Exception
Specified by:
preDeregister in interface javax.management.MBeanRegistration
Throws:
java.lang.Exception

postDeregister

public void postDeregister()
Specified by:
postDeregister in interface javax.management.MBeanRegistration

findContainer

protected void findContainer()

init

public void init()
          throws java.lang.Exception
Throws:
java.lang.Exception

destroy

public void destroy()
             throws java.lang.Exception
Throws:
java.lang.Exception

toString

public java.lang.String toString()
Provide a useful toString() implementation as it may be used when logging Lifecycle errors to identify the component.

Overrides:
toString in class java.lang.Object

Apache Tomcat 6.0.43

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.