Field Detail

• sm

  protected static final StringManager sm

• running

  protected volatile boolean running

  Running state of the endpoint.

• paused

  protected volatile boolean paused

  Will be set to true whenever the endpoint is paused.

• internalExecutor

  protected volatile boolean internalExecutor

  Are we using an internal executor

• socketProperties

  protected SocketProperties socketProperties

  Socket properties

• acceptors

  protected AbstractEndpoint.Acceptor[] acceptors

  Threads used to accept new connections and pass them to worker threads.

• acceptorThreadCount

  protected int acceptorThreadCount

  Acceptor thread count.

• acceptorThreadPriority

  protected int acceptorThreadPriority

  Priority of the acceptor threads.

• threadPriority

  protected int threadPriority

  Priority of the worker threads.

• attributes

  protected java.util.HashMap<java.lang.String,java.lang.Object> attributes

  Attributes provide a way for configuration to be passed to sub-components without the ProtocolHandler being aware of the properties available on those sub-components. One example of such a sub-component is the ServerSocketFactory.

Constructor Detail

• AbstractEndpoint

  public AbstractEndpoint()

Method Detail

• getSocketProperties

  public SocketProperties getSocketProperties()

• getExecutorTerminationTimeoutMillis

  public long getExecutorTerminationTimeoutMillis()

• setExecutorTerminationTimeoutMillis

  public void setExecutorTerminationTimeoutMillis(long executorTerminationTimeoutMillis)

• setAcceptorThreadCount

  public void setAcceptorThreadCount(int acceptorThreadCount)

• getAcceptorThreadCount

  public int getAcceptorThreadCount()

• setAcceptorThreadPriority

  public void setAcceptorThreadPriority(int acceptorThreadPriority)

• getAcceptorThreadPriority

  public int getAcceptorThreadPriority()

• setMaxConnections

  public void setMaxConnections(int maxCon)

• getMaxConnections

  public int getMaxConnections()

• getConnectionCount

  public long getConnectionCount()

  Return the current count of connections handled by this endpoint, if the connections are counted (which happens when the maximum count of connections is limited), or -1 if they are not. This property is added here so that this value can be inspected through JMX. It is visible on "ThreadPool" MBean.

  The count is incremented by the Acceptor before it tries to accept a new connection. Until the limit is reached and thus the count cannot be incremented, this value is more by 1 (the count of acceptors) than the actual count of connections that are being served.

  Returns:

  The count

• setExecutor

  public void setExecutor(java.util.concurrent.Executor executor)

• getExecutor

  public java.util.concurrent.Executor getExecutor()

• getPort

  public int getPort()

• setPort

  public void setPort(int port)

• getLocalPort

  public abstract int getLocalPort()

• getAddress

  public java.net.InetAddress getAddress()

• setAddress

  public void setAddress(java.net.InetAddress address)

• setBacklog

  public void setBacklog(int backlog)

• getBacklog

  public int getBacklog()

• getBindOnInit

  public boolean getBindOnInit()

• setBindOnInit

  public void setBindOnInit(boolean b)

• getKeepAliveTimeout

  public int getKeepAliveTimeout()

• setKeepAliveTimeout

  public void setKeepAliveTimeout(int keepAliveTimeout)

• getTcpNoDelay

  public boolean getTcpNoDelay()

  Socket TCP no delay.

• setTcpNoDelay

  public void setTcpNoDelay(boolean tcpNoDelay)

• getSoLinger

  public int getSoLinger()

  Socket linger.

• setSoLinger

  public void setSoLinger(int soLinger)

• getSoTimeout

  public int getSoTimeout()

  Socket timeout.

• setSoTimeout

  public void setSoTimeout(int soTimeout)

• isSSLEnabled

  public boolean isSSLEnabled()

• setSSLEnabled

  public void setSSLEnabled(boolean SSLEnabled)

• getMinSpareThreads

  public int getMinSpareThreads()

• setMinSpareThreads

  public void setMinSpareThreads(int minSpareThreads)

• setMaxThreads

  public void setMaxThreads(int maxThreads)

• getMaxThreads

  public int getMaxThreads()

• getMaxThreadsExecutor

  protected int getMaxThreadsExecutor(boolean useExecutor)

• getMaxKeepAliveRequests

  public int getMaxKeepAliveRequests()

• setMaxKeepAliveRequests

  public void setMaxKeepAliveRequests(int maxKeepAliveRequests)

• getMaxHeaderCount

  public int getMaxHeaderCount()

• setMaxHeaderCount

  public void setMaxHeaderCount(int maxHeaderCount)

• setName

  public void setName(java.lang.String name)

• getName

  public java.lang.String getName()

• setDaemon

  public void setDaemon(boolean b)

• getDaemon

  public boolean getDaemon()

• setThreadPriority

  public void setThreadPriority(int threadPriority)

• getThreadPriority

  public int getThreadPriority()

• getDeferAccept

  protected abstract boolean getDeferAccept()

• setAttribute

  public void setAttribute(java.lang.String name,
                  java.lang.Object value)

  Generic property setter called when a property for which a specific setter already exists within the ProtocolHandler needs to be made available to sub-components. The specific setter will call this method to populate the attributes.

• getAttribute

  public java.lang.Object getAttribute(java.lang.String key)

  Used by sub-components to retrieve configuration information.

• setProperty

  public boolean setProperty(java.lang.String name,
                    java.lang.String value)

• getProperty

  public java.lang.String getProperty(java.lang.String name)

• getCurrentThreadCount

  public int getCurrentThreadCount()

  Return the amount of threads that are managed by the pool.

  Returns:

  the amount of threads that are managed by the pool

• getCurrentThreadsBusy

  public int getCurrentThreadsBusy()

  Return the amount of threads that are in use

  Returns:

  the amount of threads that are in use

• isRunning

  public boolean isRunning()

• isPaused

  public boolean isPaused()

• createExecutor

  public void createExecutor()

• shutdownExecutor

  public void shutdownExecutor()

• unlockAccept

  protected void unlockAccept()

  Unlock the server socket accept using a bogus connection.

• processSocketAsync

  public abstract void processSocketAsync(SocketWrapper<S> socketWrapper,
                        SocketStatus socketStatus)

• removeWaitingRequest

  public abstract void removeWaitingRequest(SocketWrapper<S> socketWrapper)

• bind

  public abstract void bind()
                     throws java.lang.Exception

  Throws:

  java.lang.Exception

• unbind

  public abstract void unbind()
                       throws java.lang.Exception

  Throws:

  java.lang.Exception

• startInternal

  public abstract void startInternal()
                              throws java.lang.Exception

  Throws:

  java.lang.Exception

• stopInternal

  public abstract void stopInternal()
                             throws java.lang.Exception

  Throws:

  java.lang.Exception

• init

  public final void init()
                  throws java.lang.Exception

  Throws:

  java.lang.Exception

• start

  public final void start()
                   throws java.lang.Exception

  Throws:

  java.lang.Exception

• startAcceptorThreads

  protected final void startAcceptorThreads()

• createAcceptor

  protected abstract AbstractEndpoint.Acceptor createAcceptor()

  Hook to allow Endpoints to provide a specific Acceptor implementation.

• pause

  public void pause()

  Pause the endpoint, which will stop it accepting new connections.

• resume

  public void resume()

  Resume the endpoint, which will make it start accepting new connections again.

• stop

  public final void stop()
                  throws java.lang.Exception

  Throws:

  java.lang.Exception

• destroy

  public final void destroy()
                     throws java.lang.Exception

  Throws:

  java.lang.Exception

• getLog

  protected abstract Log getLog()

• getUseSendfile

  public abstract boolean getUseSendfile()

• getUseComet

  public abstract boolean getUseComet()

• getUseCometTimeout

  public abstract boolean getUseCometTimeout()

• getUsePolling

  public abstract boolean getUsePolling()

• initializeConnectionLatch

  protected LimitLatch initializeConnectionLatch()

• releaseConnectionLatch

  protected void releaseConnectionLatch()

• countUpOrAwaitConnection

  protected void countUpOrAwaitConnection()
                                   throws java.lang.InterruptedException

  Throws:

  java.lang.InterruptedException

• countDownConnection

  protected long countDownConnection()

• handleExceptionWithDelay

  protected int handleExceptionWithDelay(int currentErrorDelay)

  Provides a common approach for sub-classes to handle exceptions where a delay is required to prevent a Thread from entering a tight loop which will consume CPU and may also trigger large amounts of logging. For example, this can happen with the Acceptor thread if the ulimit for open files is reached.

  Parameters:

  currentErrorDelay - The current delay being applied on failure

  Returns:

  The delay to apply on the next failure

• getAlgorithm

  public java.lang.String getAlgorithm()

• setAlgorithm

  public void setAlgorithm(java.lang.String s)

• getClientAuth

  public java.lang.String getClientAuth()

• setClientAuth

  public void setClientAuth(java.lang.String s)

• getKeystoreFile

  public java.lang.String getKeystoreFile()

• setKeystoreFile

  public void setKeystoreFile(java.lang.String s)

• getKeystorePass

  public java.lang.String getKeystorePass()

• setKeystorePass

  public void setKeystorePass(java.lang.String s)

• getKeystoreType

  public java.lang.String getKeystoreType()

• setKeystoreType

  public void setKeystoreType(java.lang.String s)

• getKeystoreProvider

  public java.lang.String getKeystoreProvider()

• setKeystoreProvider

  public void setKeystoreProvider(java.lang.String s)

• getSslProtocol

  public java.lang.String getSslProtocol()

• setSslProtocol

  public void setSslProtocol(java.lang.String s)

• getCiphers

  public java.lang.String getCiphers()

• setCiphers

  public void setCiphers(java.lang.String s)

• getUseServerCipherSuitesOrder

  public java.lang.String getUseServerCipherSuitesOrder()

• setUseServerCipherSuitesOrder

  public void setUseServerCipherSuitesOrder(java.lang.String s)

• getKeyAlias

  public java.lang.String getKeyAlias()

• setKeyAlias

  public void setKeyAlias(java.lang.String s)

• getKeyPass

  public java.lang.String getKeyPass()

• setKeyPass

  public void setKeyPass(java.lang.String s)

• getTruststoreFile

  public java.lang.String getTruststoreFile()

• setTruststoreFile

  public void setTruststoreFile(java.lang.String s)

• getTruststorePass

  public java.lang.String getTruststorePass()

• setTruststorePass

  public void setTruststorePass(java.lang.String truststorePass)

• getTruststoreType

  public java.lang.String getTruststoreType()

• setTruststoreType

  public void setTruststoreType(java.lang.String truststoreType)

• getTruststoreProvider

  public java.lang.String getTruststoreProvider()

• setTruststoreProvider

  public void setTruststoreProvider(java.lang.String truststoreProvider)

• getTruststoreAlgorithm

  public java.lang.String getTruststoreAlgorithm()

• setTruststoreAlgorithm

  public void setTruststoreAlgorithm(java.lang.String truststoreAlgorithm)

• getTrustManagerClassName

  public java.lang.String getTrustManagerClassName()

• setTrustManagerClassName

  public void setTrustManagerClassName(java.lang.String trustManagerClassName)

• getCrlFile

  public java.lang.String getCrlFile()

• setCrlFile

  public void setCrlFile(java.lang.String crlFile)

• getTrustMaxCertLength

  public java.lang.String getTrustMaxCertLength()

• setTrustMaxCertLength

  public void setTrustMaxCertLength(java.lang.String trustMaxCertLength)

• getSessionCacheSize

  public java.lang.String getSessionCacheSize()

• setSessionCacheSize

  public void setSessionCacheSize(java.lang.String s)

• getSessionTimeout

  public java.lang.String getSessionTimeout()

• setSessionTimeout

  public void setSessionTimeout(java.lang.String s)

• getAllowUnsafeLegacyRenegotiation

  public java.lang.String getAllowUnsafeLegacyRenegotiation()

• setAllowUnsafeLegacyRenegotiation

  public void setAllowUnsafeLegacyRenegotiation(java.lang.String s)

• getSslEnabledProtocolsArray

  public java.lang.String[] getSslEnabledProtocolsArray()

• setSslEnabledProtocols

  public void setSslEnabledProtocols(java.lang.String s)

• configureUseServerCipherSuitesOrder

  protected void configureUseServerCipherSuitesOrder(javax.net.ssl.SSLEngine engine)

  Configures SSLEngine to honor cipher suites ordering based upon endpoint configuration.

  Throws:

  InvalidAlgorithmParameterException - If the runtime JVM doesn't support this setting.