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







Alog

print

Action : tom.alog   (Category : tom, Name : alog, By : kikonf)
Complete Name : tom.alog.by.kikonf
Version : 4.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 alog plugin : This Action describes a Tomcat Access Log Valve

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

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

<alog
    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
    }"
    
    name = '{\
        *value:access_log,\
        *eq:access_log,\
        *required:True,\
        *deny:True,\
    }'
    
    fast = '{*value:false,*checkIn:(false,true),*required:True,\
        *help:%lang/action.tom.en/alog.fast.help,\
        *lhelp:%lang/action.tom.en/alog.fast.lhelp\
    }'

    directory = "{
            '*value': '${catalina.home}/logs/',
            '*force_str': True,
            '*help': '%lang/action.tom.en/alog.directory.help',
            '*lhelp': '%lang/action.tom.en/alog.directory.lhelp'
    }"
    pattern = '{*value:common,*force_str:True,\
        *help:%lang/action.tom.en/alog.pattern.help,\
        *lhelp:%lang/action.tom.en/alog.pattern.lhelp\
    }'
    resolveHosts = '{*value:false,*checkIn:(false,true),*required:True,\
        *help:%lang/action.tom.en/alog.resolveHosts.help,\
        *lhelp:%lang/action.tom.en/alog.resolveHosts.lhelp\
    }'
    prefix = '{*value:access_log,\
        *help:%lang/action.tom.en/alog.prefix.help,\
        *lhelp:%lang/action.tom.en/alog.prefix.lhelp\
    }'
    suffix = '{*value:.log,\
        *help:%lang/action.tom.en/alog.prefix.help,\
        *lhelp:%lang/action.tom.en/alog.prefix.lhelp\
    }'
    rotatable = '{*value:true,*checkIn:(false,true),*required:True,\
        *help:%lang/action.tom.en/alog.rotatable.help,\
        *lhelp:%lang/action.tom.en/alog.rotatable.lhelp\
    }'
    condition = '{\
        *help:%lang/action.tom.en/alog.condition.help,\
        *lhelp:%lang/action.tom.en/alog.condition.lhelp\
    }'
    fileDateFormat = '{*value:yyyy-MM-dd.HH,\
        *help:%lang/action.tom.en/alog.fileDateFormat.help,\
        *lhelp:%lang/action.tom.en/alog.fileDateFormat.lhelp\
    }'

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

</alog>













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

/alog>   This Action describes a Tomcat Access Log Valve
Name Default Type Required Denied Help
name access_log   True True  
fast false (false, true) True   If true, will switch to the fast class implementation.
directory ${catalina.home}/logs/       A directory where to store the log files.
pattern common       The log format.
resolveHosts false (false, true) True   If true performs a DNS lookup to resolve the remote host address.
prefix access_log       A prefix to prepend at the start of the log file name.
suffix .log       A prefix to prepend at the start of the log file name.
rotatable true (false, true) True   Enable/Disable log rotation.
condition         When to log ?
fileDateFormat yyyy-MM-dd.HH       When rotation should occures ?

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



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