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







Host

print

Action : tom.host   (Category : tom, Name : host, By : kikonf)
Complete Name : tom.host.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 host plugin : Configure A Tomcat Virtual Host. A Tomcat Virtual Host is the association between a literal host name and a DNS entry e.g.:my.company.intra.net. The Sub Catalina instances running for this Host will accept this Host name. The Engine container can contains n Host, but one of them must match the defaultHost Attribute of its Engine Continer.

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

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


<host

    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
    }"
     
    appBase = '{\
        *value:$CATALINA_BASE/webapps,\
        *help:%lang/action.tom.en/ajpconn.appBase.help,\
        *lhelp:%lang/action.tom.en/ajpconn.appBase.lhelp\
    }'    
    unpackWAR = '{\
        *value:true,\
        *checkIn:(true,false),\
        *help:%lang/action.tom.en/ajpconn.unpackWAR.help,\
        *lhelp:%lang/action.tom.en/ajpconn.unpackWAR.lhelp\
    }'    
    deployXML = '{\
        *value:true,\
        *checkIn:(true,false),\
        *help:%lang/action.tom.en/ajpconn.deployXML.help,\
        *lhelp:%lang/action.tom.en/ajpconn.deployXML.lhelp\
    }'    
    autoDeploy = '{\
        *value:true,\
        *checkIn:(true,false),\
        *help:%lang/action.tom.en/ajpconn.autoDeploy.help,\
        *lhelp:%lang/action.tom.en/ajpconn.autoDeploy.lhelp\
    }'    
    deployOnStartup = '{\
        *value:true,\
        *checkIn:(true,false),\
        *help:%lang/action.tom.en/ajpconn.deployOnStartup.help,\
        *lhelp:%lang/action.tom.en/ajpconn.deployOnStartup.lhelp\
    }'    
    workDir = '{\
        *help:%lang/action.tom.en/ajpconn.workDir.help,\
        *lhelp:%lang/action.tom.en/ajpconn.workDir.lhelp\
    }'    

    __wk__='{\
        *help:%lang/action.tom.en/host.help,\
        *lhelp:%lang/action.tom.en/host.lhelp\
    }'    

>

    <scope 
        cbase = "{'*value':'$[software_tom_catalina_base]'}"
        service = ''
        engine = ''
        host = ''

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

    <extended
        className = '{\
            *value:false,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/ajpconn.extended.className.help,\
            *lhelp:%lang/action.tom.en/ajpconn.extended.className.lhelp\
        }'
        errorReportValveClass = '{\
            *value:false,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/ajpconn.extended.errorReportValveClass.help,\
            *lhelp:%lang/action.tom.en/ajpconn.extended.errorReportValveClass.lhelp\
        }'
        backgroundProcessorDelay = '{\
            *value:false,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/ajpconn.extended.backgroundProcessorDelay.help,\
            *lhelp:%lang/action.tom.en/ajpconn.extended.backgroundProcessorDelay.lhelp\
        }'

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

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

/host>   Configure A Tomcat Virtual Host. A Tomcat Virtual Host is the association between a literal host name and a DNS entry e.g.:my.company.intra.net. The Sub Catalina instances running for this Host will accept this Host name. The Engine container can contains n Host, but one of them must match the defaultHost Attribute of its Engine Continer.
Name Default Type Required Denied Help
appBase $CATALINA_BASE/webapps       %lang/action.tom.en/ajpconn.appBase.help
unpackWAR true (true, false)     %lang/action.tom.en/ajpconn.unpackWAR.help
deployXML true (true, false)     %lang/action.tom.en/ajpconn.deployXML.help
autoDeploy true (true, false)     %lang/action.tom.en/ajpconn.autoDeploy.help
deployOnStartup true (true, false)     %lang/action.tom.en/ajpconn.deployOnStartup.help
workDir         %lang/action.tom.en/ajpconn.workDir.help

/host/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      

/host/extended>   Todo
Name Default Type Required Denied Help
className false (true, false)     %lang/action.tom.en/ajpconn.extended.className.help
errorReportValveClass false (true, false)     %lang/action.tom.en/ajpconn.extended.errorReportValveClass.help
backgroundProcessorDelay false (true, false)     %lang/action.tom.en/ajpconn.extended.backgroundProcessorDelay.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