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







Ajpconn

print

Action : tom.ajpconn   (Category : tom, Name : ajpconn, By : kikonf)
Complete Name : tom.ajpconn.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 ajpconn plugin : Configure an AJP connector.

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

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                         -->
<!-- ====================================================================== -->
<!--            |              |          |                                 -->
<!--                                                                        -->
<!--                                                                        -->
<!-- ====================================================================== -->


<ajpconn

    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/ajpconn.address.help,\
        *lhelp:%lang/action.tom.en/ajpconn.address.lhelp,\
    }'
    port = '{\
        *value:8009,\
        *type:int,\
        *required:True,\
        *help:%lang/action.tom.en/ajpconn.port.help,\
        *lhelp:%lang/action.tom.en/ajpconn.port.lhelp,\
    }'
    redirectPort = '{\
        *value:8443,\
        *type:int,\
        *help:%lang/action.tom.en/ajpconn.redirectPort.help,\
        *lhelp:%lang/action.tom.en/ajpconn.redirectPort.lhelp,\
    }'
    __wk__ = '{\
        *help:%lang/action.tom.en/ajpconn.help,\
        *lhelp:%lang/action.tom.en/ajpconn.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,\
        }'
    />

    <sizes
        bufferSize = '{\
            *value:-1,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.sizes.bufferSize.help,\
            *lhelp:%lang/action.tom.en/ajpconn.sizes.bufferSize.lhelp\
        }'
        packetSize = '{\
            *value:8192,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.sizes.packetSize.help,\
            *lhelp:%lang/action.tom.en/ajpconn.sizes.packetSize.lhelp\
        }'
        maxPostSize = '{\
            *value:2097152,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.sizes.maxPostSize.help,\
            *lhelp:%lang/action.tom.en/ajpconn.sizes.maxPostSize.lhelp\
        }'
        maxSavePostSize = '{\
            *value:4096,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.sizes.maxSavePostSize.help,\
            *lhelp:%lang/action.tom.en/ajpconn.sizes.maxSavePostSize.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/ajpconn.sizes.help,\
            *lhelp:%lang/action.tom.en/ajpconn.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/ajpconn.methods.enableLookups.help,\
            *lhelp:%lang/action.tom.en/ajpconn.methods.enableLookups.lhelp\
        }'
        useIPVHosts = '{\
            *value:false,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/ajpconn.methods.useIPVHosts.help,\
            *lhelp:%lang/action.tom.en/ajpconn.methods.useIPVHosts.lhelp\
        }'
        proxyName = '{\
            *help:%lang/action.tom.en/ajpconn.methods.proxyName.help,\
            *lhelp:%lang/action.tom.en/ajpconn.methods.proxyName.lhelp\
        }'
        proxyPort = '{\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.methods.proxyPort.help,\
            *lhelp:%lang/action.tom.en/ajpconn.methods.proxyPort.lhelp\
        }'
        scheme = '{\
            *value:http,\
            *checkIn:(None,http,https),\
            *help:%lang/action.tom.en/ajpconn.methods.scheme.help,\
            *lhelp:%lang/action.tom.en/ajpconn.methods.scheme.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/ajpconn.methods.help,\
            *lhelp:%lang/action.tom.en/ajpconn.methods.lhelp\
        }'
    />


    <!--    pollTime: (APR library must be installed)
            8192: (APR library must be installed) -->
    <pools
        acceptCount = '{\
            *value:100,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.pools.acceptCount.help,\
            *lhelp:%lang/action.tom.en/ajpconn.pools.acceptCount.lhelp\
        }'
        connectionTimeout = '{\
            *value:0,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.timeouts.connectionTimeout.help,\
            *lhelp:%lang/action.tom.en/ajpconn.timeouts.connectionTimeout.lhelp\
        }'
        maxSpareThreads = '{\
            *value:50,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.pools.maxSpareThreads.help,\
            *lhelp:%lang/action.tom.en/ajpconn.pools.maxSpareThreads.lhelp\
        }'
        minSpareThreads = '{\
            *value:4,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.pools.minSpareThreads.help,\
            *lhelp:%lang/action.tom.en/ajpconn.pools.minSpareThreads.lhelp\
        }'
        maxThreads = '{\
            *value:200,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.pools.maxThreads.help,\
            *lhelp:%lang/action.tom.en/ajpconn.pools.maxThreads.lhelp\
        }'
        pollTime. = '{\
            *value:2000,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.pools.pollTime..help,\
            *lhelp:%lang/action.tom.en/ajpconn.pools.pollTime..lhelp\
        }'
        pollerSize = '{\
            *value:8192,\
            *type:int,\
            *help:%lang/action.tom.en/ajpconn.pools.pollerSize.help,\
            *lhelp:%lang/action.tom.en/ajpconn.pools.pollerSize.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/ajpconn.pools.help,\
            *lhelp:%lang/action.tom.en/ajpconn.pools.lhelp\
        }'
    />

    <extended
        registerRequest = '{\
            *value:enable,\
            *help:%lang/action.tom.en/ajpconn.extended.encoding.URIEncoding.help,\
            *lhelp:%lang/action.tom.en/ajpconn.extended.encoding.URIEncoding.lhelp\
        }'
        __wk__ = '{\
            *le:1,\
            *display:False,\
            *help:%lang/action.tom.en/ajpconn.extended.help,\
            *lhelp:%lang/action.tom.en/ajpconn.extended.lhelp\
        }'
    >

        <!--
            pass --> request.secret
            shutdownEnabled --> request.shutdownEnabled
            generate --> request.useSecret
        -->
        <secret
            pass = '{\
                *value:ISO-8859-1,\
                *help:%lang/action.tom.en/ajpconn.extended.encoding.pass.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.secret.pass.lhelp\
            }'
            shutdownEnabled = '{\
                *value:ISO-8859-1,\
                *help:%lang/action.tom.en/ajpconn.extended.encoding.shutdownEnabled.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.secret.shutdownEnabled.lhelp\
            }'
            useSecret = '{\
                *value:ISO-8859-1,\
                *help:%lang/action.tom.en/ajpconn.extended.encoding.useSecret.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.secret.useSecret.lhelp\
            }'
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/ajpconn.extended.secret.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.secret.lhelp\
            }'
        />
    
        <encoding
            URIEncoding = '{\
                *value:ISO-8859-1,\
                *help:%lang/action.tom.en/ajpconn.extended.encoding.URIEncoding.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.encoding.URIEncoding.lhelp\
            }'
            useBodyEncodingForURI = '{\
                *help:%lang/action.tom.en/ajpconn.extended.encoding.useBodyEncodingForURI.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.encoding.useBodyEncodingForURI.lhelp\
            }'
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/ajpconn.extended.encoding.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.encoding.lhelp\
            }'
        />
        
        <headers
            emptySessionPath = '{\
                *value:false,\
                *checkIn:(true,false),\
                *help:%lang/action.tom.en/ajpconn.extended.headers.emptySessionPath.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.headers.emptySessionPath.lhelp\
            }'
            xpoweredBy = '{\
                *value:false,\
                *checkIn:(true,false),\
                *help:%lang/action.tom.en/ajpconn.extended.headers.xpoweredBy.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.headers.xpoweredBy.lhelp\
            }'
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/ajpconn.extended.headers.help,\
                *lhelp:%lang/action.tom.en/ajpconn.extended.headers.lhelp\
            }'
        />

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

</ajpconn>
							
(Source: <KIKONF_INSTALLATION_DIR>/plugins/actions/tom/ajpconn/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.ajpconn Descriptor File :

/ajpconn>   Configure an AJP connector.
Name Default Type Required Denied Help
address         Which address to bind on ?
port 8009 int True   Which Port to listen to ?
redirectPort 8443 int     Port to redirect with secured transport.

/ajpconn/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)      

/ajpconn/sizes>   %lang/action.tom.en/ajpconn.sizes.help
Name Default Type Required Denied Help
bufferSize -1 int     %lang/action.tom.en/ajpconn.sizes.bufferSize.help
packetSize 8192 int     %lang/action.tom.en/ajpconn.sizes.packetSize.help
maxPostSize 2097152 int     %lang/action.tom.en/ajpconn.sizes.maxPostSize.help
maxSavePostSize 4096 int     %lang/action.tom.en/ajpconn.sizes.maxSavePostSize.help

/ajpconn/methods>   %lang/action.tom.en/ajpconn.methods.help
Name Default Type Required Denied Help
enableLookups true (true, false)     what return to getRemoteHost() ?
useIPVHosts false (true, false)     Do the IP from the request for Host ?
proxyName         What name to return at getServerName().
proxyPort   int     What name to return at getServerPort() ?
scheme http (None, http, https)     What Protocol return to getScheme() ?

/ajpconn/pools>   %lang/action.tom.en/ajpconn.pools.help
Name Default Type Required Denied Help
acceptCount 100 int     %lang/action.tom.en/ajpconn.pools.acceptCount.help
connectionTimeout 0 int     %lang/action.tom.en/ajpconn.timeouts.connectionTimeout.help
maxSpareThreads 50 int     %lang/action.tom.en/ajpconn.pools.maxSpareThreads.help
minSpareThreads 4 int     %lang/action.tom.en/ajpconn.pools.minSpareThreads.help
maxThreads 200 int     %lang/action.tom.en/ajpconn.pools.maxThreads.help
pollTime. 2000 int     %lang/action.tom.en/ajpconn.pools.pollTime..help
pollerSize 8192 int     %lang/action.tom.en/ajpconn.pools.pollerSize.help



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