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



tom/actions/by kikonfajpconnalogaprconnbeanrsccontextcrtclustercrtserverdatasrcenvhosthttpconnmailrscrealmtransudbrsc




Overview
ScreenShots
Download
Install Instructions
How to start
Documentation
License
About us
Comparison
Wikikonf
Repository

Context

print

Action : tom.context   (Category : tom, Name : context, By : kikonf)
Complete Name : tom.context.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 context plugin : Configure a Tomcat Context

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

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


<context

    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
    }"

    docBase = '{\
        *required:True,\
        *help:%lang/action.tom.en/context.docBase.help,\
        *lhelp:%lang/action.tom.en/context.docBase.lhelp,\
    }'
    workDir = '{\
        *required:True,\
        *help:%lang/action.tom.en/context.workDir.help,\
        *lhelp:%lang/action.tom.en/context.workDir.lhelp,\
    }'
    reloadable = '{\
        *value:false,\
        *checkIn:(true,false),\
        *required:True,\
        *help:%lang/action.tom.en/context.reloadable.help,\
        *lhelp:%lang/action.tom.en/context.reloadable.lhelp,\
    }'
    unpackWAR = '{\
        *value:true,\
        *checkIn:(true,false),\
        *required:True,\
        *help:%lang/action.tom.en/context.unpackWAR.help,\
        *lhelp:%lang/action.tom.en/context.unpackWAR.lhelp,\
    }'
    privileged = '{\
        *value:true,\
        *checkIn:(true,false),\
        *required:True,\
        *help:%lang/action.tom.en/context.privileged.help,\
        *lhelp:%lang/action.tom.en/context.privileged.lhelp,\
    }'
    cookies = '{\
        *value:true,\
        *checkIn:(true,false),\
        *required:True,\
        *help:%lang/action.tom.en/context.cookies.help,\
        *lhelp:%lang/action.tom.en/context.cookies.lhelp,\
    }'
    allowLinking = '{\
        *value:false,\
        *checkIn:(true,false),\
        *required:True,\
        *help:%lang/action.tom.en/context.allowLinking.help,\
        *lhelp:%lang/action.tom.en/context.allowLinking.lhelp,\
    }'
    swallowOutput = '{\
        *value:false,\
        *checkIn:(true,false),\
        *required:True,\
        *help:%lang/action.tom.en/context.swallowOutput.help,\
        *lhelp:%lang/action.tom.en/context.swallowOutput.lhelp,\
    }'
    override = '{\
        *value:false,\
        *checkIn:(true,false),\
        *required:True,\
        *help:%lang/action.tom.en/context.override.help,\
        *lhelp:%lang/action.tom.en/context.override.lhelp,\
    }'

    __wk__='{\
        *help:%lang/action.tom.en/context.help,\
        *lhelp:%lang/action.tom.en/context.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,\
        }'
    />

    <extended
        useNaming = '{\
            *value:true,\
            *checkIn:(true,false),\
            *required:True,\
            *help:%lang/action.tom.en/context.extended.useNaming.help,\
            *lhelp:%lang/action.tom.en/context.extended.useNaming.lhelp,\
        }'
        caseSensitive = '{\
            *value:false,\
            *checkIn:(true,false),\
            *required:True,\
            *help:%lang/action.tom.en/context.extended.caseSensitive.help,\
            *lhelp:%lang/action.tom.en/context.extended.caseSensitive.lhelp,\
        }'
        unloadDelay = '{\
            *value:2000,\
            *type:int,\
            *required:True,\
            *help:%lang/action.tom.en/context.extended.unloadDelay.help,\
            *lhelp:%lang/action.tom.en/context.extended.unloadDelay.lhelp,\
        }'
        useHttpOnly = '{\
            *value:false,\
            *checkIn:(true,false),\
            *required:True,\
            *help:%lang/action.tom.en/context.extended.useHttpOnly.help,\
            *lhelp:%lang/action.tom.en/context.extended.useHttpOnly.lhelp,\
        }'
        crossContext = '{\
            *value:false,\
            *checkIn:(true,false),\
            *required:True,\
            *help:%lang/action.tom.en/context.extended.crossContext.help,\
            *lhelp:%lang/action.tom.en/context.extended.crossContext.lhelp,\
        }'
        backgroundProcessorDelay = '{\
            *help:%lang/action.tom.en/context.extended.backgroundProcessorDelay.help,\
            *lhelp:%lang/action.tom.en/context.extended.backgroundProcessorDelay.lhelp,\
        }'
        className = '{\
            *value:org.apache.catalina.core.StandardContext,\
            *help:%lang/action.tom.en/context.extended.className.help,\
            *lhelp:%lang/action.tom.en/context.extended.className.lhelp,\
        }'
        wrapperClass = '{\
            *help:%lang/action.tom.en/context.extended.wrapperClass.help,\
            *lhelp:%lang/action.tom.en/context.extended.wrapperClass.lhelp,\
        }'
        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/context.extended.help,\
            *lhelp:%lang/action.tom.en/context.extended.lhelp\
        }'
    >

        <flock>
            antiJARLocking = '{\
                *value:false,\
                *checkIn:(true,false),\
                *required:True,\
                *help:%lang/action.tom.en/context.flock.antiJARLocking.help,\
                *lhelp:%lang/action.tom.en/context.flock.antiJARLocking.lhelp,\
            }' 
            antiResourceLocking = '{\
                *value:false,\
                *checkIn:(true,false),\
                *required:True,\
                *help:%lang/action.tom.en/context.flock.antiResourceLocking.help,\
                *lhelp:%lang/action.tom.en/context.flock.antiResourceLocking.lhelp,\
            }'    
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/context.extended.flock.help,\
                *lhelp:%lang/action.tom.en/context.extended.flock.lhelp\
            }'
        </flock>

        <cache>
            cacheMaxSize = '{\
                *value:10240,\
                *type:int,\
                *help:%lang/action.tom.en/context.flock.cacheMaxSize.help,\
                *lhelp:%lang/action.tom.en/context.flock.cacheMaxSize.lhelp,\
            }' 
            cacheTTL. = '{\
                *value:5000,\
                *type:int,\
                *help:%lang/action.tom.en/context.flock.cacheTTL..help,\
                *lhelp:%lang/action.tom.en/context.flock.cacheTTL..lhelp,\
            }'   
            cachingAllowed = '{\
                *value:true,\
                *checkIn:(true,false),\
                *required:True,\
                *help:%lang/action.tom.en/context.flock.cachingAllowed.help,\
                *lhelp:%lang/action.tom.en/context.flock.cachingAllowed.lhelp,\
            }'    
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/context.extended.flock.help,\
                *lhelp:%lang/action.tom.en/context.extended.flock.lhelp\
            }'
        </cache>

        <tld>
            processTlds = '{\
                *value:true,\
                *checkIn:(true,false),\
                *required:True,\
                *help:%lang/action.tom.en/context.tld.processTlds.help,\
                *lhelp:%lang/action.tom.en/context.tld.processTlds.lhelp,\
            }' 
            tldNamespaceAware = '{\
                *value:false,\
                *checkIn:(true,false),\
                *required:True,\
                *help:%lang/action.tom.en/context.tld.tldNamespaceAware.help,\
                *lhelp:%lang/action.tom.en/context.tld.tldNamespaceAware.lhelp,\
            }'   
            tldValidation = '{\
                *value:false,\
                *checkIn:(true,false),\
                *required:True,\
                *help:%lang/action.tom.en/context.tld.tldValidation.help,\
                *lhelp:%lang/action.tom.en/context.tld.tldValidation.lhelp,\
            }'    
            __wk__ = '{\
                *le:1,\
                *help:%lang/action.tom.en/context.extended.tld.help,\
                *lhelp:%lang/action.tom.en/context.extended.tld.lhelp\
            }'
        </tld>
        
    </extended>

</context>
(Source: <KIKONF_INSTALLATION_DIR>/plugins/actions/tom/context/by/kikonf/ACT_INF/action.xml)


  General Information  

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.context Descriptor File :

/env>   This Action configures a Tomcat Environmen entry.
Name Default Type Required Denied Help
name     True   The Env entry JNDI name.
etype java.lang.String (java.lang.Boolean, java.lang.Byte, java.lang.Character, java.lang.Double, java.lang.Float, java.lang.Integer, java.lang.Long, java.lang.Short, java.lang.String) True   A java.lang type.
desc   str      

/env/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)      
resources.global false (true, false)      

/env/envrsc>  
Name Default Type Required Denied Help
value     True   %lang/action.tom.en/env.envrsc.value.help
override   (true, false)     Allow override ?
*Text __wk__ = '{\
*le:1,\
*help:%lang/action.tom.en/env.envrsc.help,\
*lhelp:%lang/action.tom.en/env.envrsc.lhelp\
}'
     

/env/link>   Referencing the Global Resource.
Name Default Type Required Denied Help
name         Referencing the Global Resource.


  Comments  

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