cle_clock
Home > wikikonf >  tom/actions/by kikonf > httpconn







Httpconn

print

Action : tom.httpconn   (Category : tom, Name : httpconn, By : kikonf)
Complete Name : tom.httpconn.by.kikonf
Version : 1.0        License : Modified BSD License

Purpose of the tom category :
Easy to customize. This category use in background the Kikonf Repoz tools to create and configure Apache Tomcat root installs and Catalina bases at any level (server.xml, hosts or defaults).
You can use it to manage the whole Tomcat Architecture.

Purpose of this httpconn plugin : Configure an HTTP connector.

The following shows the Descriptor File for the Action : tom.httpconn

Toggle lines
<!-- Copyright (c) 2008, Patrick Germain Placidoux                          -->
<!-- All rights reserved.                                                   -->
<!--                                                                        -->
<!-- This file is part of Kikonf Public Software.                           -->
<!--                                                                        -->
<!-- Kikonf Public Software is released under the modified BSD License,     -->
<!-- which should accompany it or any part of it in the file "COPYING".     -->
<!-- If you do not have this file you can access the license                -->
<!-- through the WWW at http://www.kikonf.org/license/bsd/license.txt.      -->
<!--                                                                        -->
<!-- Home page: http://www.kikonf.org                                       -->
<!-- Contact: kikonf@gmx.com                                                -->
<!-- ====================================================================== -->
<!--                                                                        -->
<!--                                                                        -->
<!--                                                                        -->
<!-- ====================================================================== -->
<!-- UPDATE     |     DATE     |   CODE   |  REASON                         -->
<!-- ====================================================================== -->
<!--            |              |          |                                 -->
<!--                                                                        -->
<!--                                                                        -->
<!-- ====================================================================== -->


<httpconn

    type = '{\
        *eq:action,\
        *required:True,\
        *display:False\
    }'
    bal = '{*display:False}'
    sub_type = '{\
        *value:configuration,\
        *eq:configuration,\
        *required:True,\
        *deny:True,\
        *display:False\
    }'
    softwares = "{
        '*type':'dict',
        '*dtype':
            {
                'tom':
                {
                    '*ge':'5.5',
                    '*le':'7',
                    '*required':True
                }
            },
        '*deny':True, 
        '*display':False
    }"
    
    address = '{\
        *help:%lang/action.tom.en/hconn.address.help,\
        *lhelp:%lang/action.tom.en/hconn.address.lhelp,\
    }'
    port = '{\
        *value:8080,\
        *type:int,\
        *required:True,\
        *help:%lang/action.tom.en/hconn.port.help,\
        *lhelp:%lang/action.tom.en/hconn.port.lhelp,\
    }'
    redirectPort = '{\
        *value:8443,\
        *type:int,\
        *help:%lang/action.tom.en/hconn.redirectPort.help,\
        *lhelp:%lang/action.tom.en/hconn.redirectPort.lhelp,\
    }'
    __wk__ = '{\
        *help:%lang/action.tom.en/httpconn.help,\
        *lhelp:%lang/action.tom.en/httpconn.lhelp\
    }'    
>

    <scope 
        cbase = "{'*value':'$[software_tom_catalina_base]'}"
        service = ''
        engine = ''
        host = ''
        context.global = '{*checkIn:(true,false),*value:false}'
        context = ''
        context.default.global = '{*checkIn:(true,false),*value:false}'
        context.default = '{*checkIn:(true,false),*value:false}'

        __wk__ = '{\
            *eq:1,\
            *help:%lang/action.tom.en/scope.help,\
            *lhelp:%lang/action.tom.en/scope.lhelp,\
        }'
    />

    <timeouts
        connectionLinger = '{\
            *value:-1,\
            *type:int,\
            *help:%lang/action.tom.en/hconn.timeouts.connectionLinger.help,\
            *lhelp:%lang/action.tom.en/hconn.timeouts.connectionLinger.lhelp\
        }'
        connectionTimeout = '{\
            *value:60000,\
            *type:int,\
            *help:%lang/action.tom.en/hconn.timeouts.connectionTimeout.help,\
            *lhelp:%lang/action.tom.en/hconn.timeouts.connectionTimeout.lhelp\
        }'
        disableUploadTimeout = '{\
            *value:true,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/hconn.timeouts.disableUploadTimeout.help,\
            *lhelp:%lang/action.tom.en/hconn.timeouts.disableUploadTimeout.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/httpconn.timeouts.help,\
            *lhelp:%lang/action.tom.en/httpconn.timeouts.lhelp\
        }'
    />

    <sizes
        socketBuffer = '{\
            *value:9000,\
            *type:int,\
            *help:%lang/action.tom.en/hconn.sizes.socketBuffer.help,\
            *lhelp:%lang/action.tom.en/hconn.sizes.socketBuffer.lhelp\
        }'
        bufferSize = '{\
            *value:2048,\
            *type:int,\
            *help:%lang/action.tom.en/hconn.sizes.bufferSize.help,\
            *lhelp:%lang/action.tom.en/hconn.sizes.bufferSize.lhelp\
        }'
        maxHttpHeaderSize = '{\
            *value:4096,\
            *type:int,\
            *help:%lang/action.tom.en/hconn.sizes.maxHttpHeaderSize.help,\
            *lhelp:%lang/action.tom.en/hconn.sizes.maxHttpHeaderSize.lhelp\
        }'
        maxPostSize = '{\
            *value:2097152,\
            *type:int,\
            *help:%lang/action.tom.en/hconn.sizes.maxPostSize.help,\
            *lhelp:%lang/action.tom.en/hconn.sizes.maxPostSize.lhelp\
        }'
        maxSavePostSize = '{\
            *value:4096,\
            *type:int,\
            *help:%lang/action.tom.en/hconn.sizes.maxSavePostSize.help,\
            *lhelp:%lang/action.tom.en/hconn.sizes.maxSavePostSize.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/httpconn.sizes.help,\
            *lhelp:%lang/action.tom.en/httpconn.sizes.lhelp\
        }'
    />    

    <!-- scheme: Accepter None pour scheme, Switche a https si tag ssl (1)
         secure: Accepter None pour secure, Switche a true si tag ssl (1) -->
    <methods
        enableLookups = '{\
            *value:true,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/hconn.methods.enableLookups.help,\
            *lhelp:%lang/action.tom.en/hconn.methods.enableLookups.lhelp\
        }'
        useIPVHosts = '{\
            *value:false,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/hconn.methods.useIPVHosts.help,\
            *lhelp:%lang/action.tom.en/hconn.methods.useIPVHosts.lhelp\
        }'
        proxyName = '{\
            *help:%lang/action.tom.en/hconn.methods.proxyName.help,\
            *lhelp:%lang/action.tom.en/hconn.methods.proxyName.lhelp\
        }'
        proxyPort = '{\
            *type:int,\
            *help:%lang/action.tom.en/hconn.methods.proxyPort.help,\
            *lhelp:%lang/action.tom.en/hconn.methods.proxyPort.lhelp\
        }'
        scheme = '{\
            *value:http,\
            *checkIn:(http,https),\
            *help:%lang/action.tom.en/hconn.methods.scheme.help,\
            *lhelp:%lang/action.tom.en/hconn.methods.scheme.lhelp\
        }'
        secure = '{\
            *value:false,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/hconn.methods.secure.help,\
            *lhelp:%lang/action.tom.en/hconn.methods.secure.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/httpconn.methods.help,\
            *lhelp:%lang/action.tom.en/httpconn.methods.lhelp\
        }'
    />

    <pools
        acceptCount = '{\
            *value:100,\
            *type:int,\
            *help:%lang/action.tom.en/httpconn.pools.acceptCount.help,\
            *lhelp:%lang/action.tom.en/httpconn.pools.acceptCount.lhelp\
        }'
        maxKeepAliveRequests = '{\
            *value:100,\
            *type:int,\
            *help:%lang/action.tom.en/httpconn.pools.maxKeepAliveRequests.help,\
            *lhelp:%lang/action.tom.en/httpconn.pools.maxKeepAliveRequests.lhelp\
        }'
        maxSpareThreads = '{\
            *value:50,\
            *type:int,\
            *help:%lang/action.tom.en/httpconn.pools.maxSpareThreads.help,\
            *lhelp:%lang/action.tom.en/httpconn.pools.maxSpareThreads.lhelp\
        }'
        minSpareThreads = '{\
            *value:4,\
            *type:int,\
            *help:%lang/action.tom.en/httpconn.pools.minSpareThreads.help,\
            *lhelp:%lang/action.tom.en/httpconn.pools.minSpareThreads.lhelp\
        }'
        maxThreads = '{\
            *value:200,\
            *type:int,\
            *help:%lang/action.tom.en/httpconn.pools.maxThreads.help,\
            *lhelp:%lang/action.tom.en/httpconn.pools.maxThreads.lhelp\
        }'
        strategy = '{\
            *value:lf,\
            *checkIn:(lf,ms),\
            *help:%lang/action.tom.en/httpconn.pools.strategy.help,\
            *lhelp:%lang/action.tom.en/httpconn.pools.strategy.lhelp\
        }'
        threadPriority = '{\
            *value:java.lang.Thread#NORM_PRIORITY,\
            *help:%lang/action.tom.en/httpconn.pools.threadPriority.help,\
            *lhelp:%lang/action.tom.en/httpconn.pools.threadPriority.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/httpconn.pools.help,\
            *lhelp:%lang/action.tom.en/httpconn.pools.lhelp\
        }'
    />

    <extended
            __wk__ = '{\
            *le:1,\
            *display:False,\
            *help:%lang/action.tom.en/httpconn.extended.help,\
            *lhelp:%lang/action.tom.en/httpconn.extended.lhelp\
        }'
    >
        <encoding
            URIEncoding = '{\
                *value:ISO-8859-1,\
                *help:%lang/action.tom.en/httpconn.extended.encoding.URIEncoding.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.encoding.URIEncoding.lhelp\
            }'
            useBodyEncodingForURI = '{\
                *help:%lang/action.tom.en/httpconn.extended.encoding.useBodyEncodingForURI.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.encoding.useBodyEncodingForURI.lhelp\
            }'
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/httpconn.extended.encoding.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.encoding.lhelp\
            }'
        />
        
        <!-- noCompressionUserAgents: TEXT list -->
        <!-- restrictedUserAgents: TEXT list -->
        <agent
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/aprconn.extended.agent.help,\
                *lhelp:%lang/action.tom.en/aprconn.extended.agent.lhelp\
            }'
        >
            <noCompressionUserAgents>
                __wk__ = '{\
                    *le:1,\
                    *help:%lang/action.tom.en/aprconn.extended.agent.noCompressionUserAgents.help,\
                    *lhelp:%lang/action.tom.en/aprconn.extended.agent.noCompressionUserAgents.lhelp\
                }'
            >
            </noCompressionUserAgents>
            <restrictedUserAgents>
                __wk__ = '{\
                    *le:1,\
                    *help:%lang/action.tom.en/aprconn.extended.agent.restrictedUserAgents.help,\
                    *lhelp:%lang/action.tom.en/aprconn.extended.agent.restrictedUserAgents.lhelp\
                }'
            >
            </restrictedUserAgents>
        </agent>

        <headers
            emptySessionPath = '{\
                *value:false,\
                *checkIn:(true,false),\
                *help:%lang/action.tom.en/httpconn.extended.headers.emptySessionPath.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.headers.emptySessionPath.lhelp\
            }'
            xpoweredBy = '{\
                *value:false,\
                *checkIn:(true,false),\
                *help:%lang/action.tom.en/httpconn.extended.headers.xpoweredBy.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.headers.xpoweredBy.lhelp\
            }'
            Server = '{\
                *value:Apache-Coyote/1.1,\
                *help:%lang/action.tom.en/httpconn.extended.headers.Server.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.headers.Server.lhelp\
            }'
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/httpconn.extended.headers.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.headers.lhelp\
            }'
        />
        
        <!--
        Default off\
        on : allows\
        force : force compression for all MIMES TYPES.\
        int: <=> on + mimimum Datas length befor compression.
        -->
        <compression
            enable = '{\
                *value:off,\
                *help:%lang/action.tom.en/httpconn.extended.compression.enable.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.compression.enable.lhelp\
            }'
            compressableMimeType = "{\
                '*value': 'text/html,text/xml,text/plain',\
                '*help': '%lang/action.tom.en/httpconn.extended.compression.compressableMimeType.help',\
                '*lhelp': '%lang/action.tom.en/httpconn.extended.compression.compressableMimeType.lhelp'\
            }"
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/httpconn.extended.compression.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.compression.lhelp\
            }'
        />

        <tcp
            allowTrace = '{\
                *value:false,\
                *checkIn:(true,false),\
                *help:%lang/action.tom.en/httpconn.extended.tcp.allowTrace.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.tcp.allowTrace.lhelp\
            }'
            tcpNoDelay = '{\
                *value:true,\
                *checkIn:(true,false),\
                *help:%lang/action.tom.en/httpconn.extended.tcp.tcpNoDelay.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.tcp.tcpNoDelay.lhelp\
            }'
            __wk__ = '{\
                *le:1,\
                *display:False,\
                *help:%lang/action.tom.en/httpconn.extended.tcp.help,\
                *lhelp:%lang/action.tom.en/httpconn.extended.tcp.lhelp\
            }'
        />
    </extended>


    <!--
    => Accepter None pour scheme, Switche a https si tag ssl !!! (1)
                           secure, Switche a on si tag ssl !!! (1)
    => Ajouter un tag (voir AFAIRE.txt) __display_activate__ = '{*value:true,*checkIn(true,false)}'
    Note ceci <ssl/>
    Provoque cela ds Server.xml :
    Connector : + scheme="https" +secure="true" +clientAuth="false" + sslProtocol="TLS"
    -->
    
    <!-- ciphers: est un TEXT:list -->
    <ssl
        sslProtocol = '{\
            *value:TLS,\
            *help:%lang/action.tom.en/httpconn.ssl.sslProtocol.help,\
            *lhelp:%lang/action.tom.en/httpconn.ssl.sslProtocol.lhelp\
        }'
        clientAuth = '{\
            *value:false,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/httpconn.ssl.clientAuth.help,\
            *lhelp:%lang/action.tom.en/httpconn.ssl.clientAuth.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/httpconn.ssl.help,\
            *lhelp:%lang/action.tom.en/httpconn.ssl.lhelp\
        }'
    >
        
        <keystore
            keystoreFile = '{\
                *help:%lang/action.tom.en/httpconn.ssl.keystore.keystoreFile.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.keystore.keystoreFile.lhelp\
            }'
            keystorePass = '{\
                *help:%lang/action.tom.en/httpconn.ssl.keystore.keystorePass.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.keystore.keystorePass.lhelp\
            }'
            keystoreType = '{\
                *value:JKS,\
                *help:%lang/action.tom.en/httpconn.ssl.keystore.keystoreType.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.keystore.keystoreType.lhelp\
            }'
            keyAlias = '{\
                *value:JKS,\
                *help:%lang/action.tom.en/httpconn.ssl.keystore.keyAlias.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.keystore.keyAlias.lhelp\
            }'
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/httpconn.ssl.keystore.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.keystore.lhelp\
            }'
        />
        
        <truststore
            truststoreFile = '{\
                *le:1,\
                *help:%lang/action.tom.en/httpconn.ssl.truststore.truststoreFile.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.truststore.truststoreFile.lhelp\
            }'
            truststorePass = '{\
                *le:1,\
                *help:%lang/action.tom.en/httpconn.ssl.truststore.truststorePass.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.truststore.truststorePass.lhelp\
            }'
            truststoreType = '{\
                *le:1,\
                *help:%lang/action.tom.en/httpconn.ssl.truststore.truststoreType.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.truststore.truststoreType.lhelp\
            }'
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/httpconn.ssl.truststore.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.truststore.lhelp\
            }'
        />
        
        <extended
            algorithm = '{\
                *help:%lang/action.tom.en/httpconn.ssl.extended.algorithm.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.extended.algorithm.lhelp\
            }'
            allowUnsafeLegacyRenegotiation = '{\
                *help:%lang/action.tom.en/httpconn.ssl.extended.allowUnsafeLegacyRenegotiation.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.extended.allowUnsafeLegacyRenegotiation.lhelp\
            }'

            __wk__ = '{\
                *le:1,\
                *display:False,\
                *help:%lang/action.tom.en/httpconn.ssl.extended.help,\
                *lhelp:%lang/action.tom.en/httpconn.ssl.extended.lhelp\
            }'
        >
            <ciphers
                __wk__ = '{\
                    *le:1,\
                    *display:False,\
                    *help:%lang/action.tom.en/httpconn.ssl.extended.ciphers.help,\
                    *lhelp:%lang/action.tom.en/httpconn.ssl.extended.ciphers.lhelp\
                }'
            >
            </ciphers>
        </extended>
        
        
    </ssl>
    
</httpconn>
							
(Source: <KIKONF_INSTALLATION_DIR>/plugins/actions/tom/httpconn/by/kikonf/ACT_INF/action.xml)


A descriptor file is a WYSISWYG xsd like schema, wich describes what are the supported Tags, Attributes and Attributes values for one Action.
The special Attributes : type, sub_type, bal, softwares, __wk__ are reserved by Kikonf.

The table below summarizes the informations provided by the tom.httpconn Descriptor File :

/httpconn>   Configure an HTTP connector.
Name Default Type Required Denied Help
address         %lang/action.tom.en/hconn.address.help
port 8080 int True   %lang/action.tom.en/hconn.port.help
redirectPort 8443 int     %lang/action.tom.en/hconn.redirectPort.help

/httpconn/scope>   A scope refers to configuration Level within the Tomcat scheme.
Required:True
Name Default Type Required Denied Help
cbase $[software_tom_catalina_base]        
service   str      
engine   str      
host   str      
context.global false (true, false)      
context   str      
context.default.global false (true, false)      
context.default false (true, false)      

/httpconn/timeouts>   %lang/action.tom.en/httpconn.timeouts.help
Name Default Type Required Denied Help
connectionLinger -1 int     %lang/action.tom.en/hconn.timeouts.connectionLinger.help
connectionTimeout 60000 int     %lang/action.tom.en/hconn.timeouts.connectionTimeout.help
disableUploadTimeout true (true, false)     %lang/action.tom.en/hconn.timeouts.disableUploadTimeout.help

/httpconn/sizes>   %lang/action.tom.en/httpconn.sizes.help
Name Default Type Required Denied Help
socketBuffer 9000 int     %lang/action.tom.en/hconn.sizes.socketBuffer.help
bufferSize 2048 int     %lang/action.tom.en/hconn.sizes.bufferSize.help
maxHttpHeaderSize 4096 int     %lang/action.tom.en/hconn.sizes.maxHttpHeaderSize.help
maxPostSize 2097152 int     %lang/action.tom.en/hconn.sizes.maxPostSize.help
maxSavePostSize 4096 int     %lang/action.tom.en/hconn.sizes.maxSavePostSize.help

/httpconn/methods>   %lang/action.tom.en/httpconn.methods.help
Name Default Type Required Denied Help
enableLookups true (true, false)     %lang/action.tom.en/hconn.methods.enableLookups.help
useIPVHosts false (true, false)     %lang/action.tom.en/hconn.methods.useIPVHosts.help
proxyName         %lang/action.tom.en/hconn.methods.proxyName.help
proxyPort   int     %lang/action.tom.en/hconn.methods.proxyPort.help
scheme http (http, https)     %lang/action.tom.en/hconn.methods.scheme.help
secure false (true, false)     %lang/action.tom.en/hconn.methods.secure.help

/httpconn/pools>   %lang/action.tom.en/httpconn.pools.help
Name Default Type Required Denied Help
acceptCount 100 int     Max Connection Queue lentgth ?
maxKeepAliveRequests 100 int     Max Keep-alive requests.
maxSpareThreads 50 int     Max unprocessing Threads ?
minSpareThreads 4 int     Min Threads created at startup ?
maxThreads 200 int     Max simultaneous Threads creatable by this connecxtor ?
strategy lf (lf, ms)     The thread pooling strategy.
threadPriority java.lang.Thread#NORM_PRIORITY       The priority of the request processing thread.

/httpconn/ssl>   Configure the Tomcat SSL support for JSSE.
Name Default Type Required Denied Help
sslProtocol TLS       The Ssl protocol to use.
clientAuth false (true, false)     Do require a Certificate from the client ?

/httpconn/ssl/keystore>   %lang/action.tom.en/httpconn.ssl.keystore.help
Name Default Type Required Denied Help
keystoreFile         The keystore file path.
keystorePass         The keystore file password.
keystoreType JKS       The keystore file type.
keyAlias JKS       The Server Certificate Alias into the keystore file.

/httpconn/ssl/truststore>   %lang/action.tom.en/httpconn.ssl.truststore.help
Name Default Type Required Denied Help
truststoreFile         The trust store file path.
truststorePass         The trust store file password.
truststoreType         The trust store file type.



Trademarks :
  • "Apache", "Apache Tomcat" and "Tomcat" are trademarks of the Apache Software Foundation.
  • "Java" and "JVM" are a registred trademarks of Oracle and/or its affiliates.
  • Other names may be trademarks of their respective owners.

Copyright © 2011 - Patrick Placidoux, Hélène Malamoud