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







Udbrsc

print

Action : tom.udbrsc   (Category : tom, Name : udbrsc, By : kikonf)
Complete Name : tom.udbrsc.by.kikonf
Version : 5.5        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 udbrsc plugin : This Action configures a Tomcat User Database Resource.

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

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

<udbrsc

    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 ='{\
        *required:True,\
        *help:%lang/action.tom.en/udbrsc.resource.name.help,\
        *help:%lang/action.tom.en/udbrsc.resource.name.lhelp,\
    }'
    
    __wk__='{\
        *help:%lang/action.tom.en/udbrsc.help,\
        *lhelp:%lang/action.tom.en/udbrsc.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}'
        resources.global = '{*checkIn:(true,false),*value:false}'

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

    <resource

        auth = '{\
            *value:true,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/auth.help,\
            *lhelp:%lang/action.tom.en/auth.lhelp,\
        }'
        
        description=''
        
        factory = '{\
            *value:org.apache.catalina.users.MemoryUserDatabaseFactory,\
            *required:True,\
            *help:%lang/action.tom.en/udbrsc.resource.factory.help,\
            *lhelp:%lang/action.tom.en/udbrsc.resource.factory.lhelp,\
        }'
        pathname = '{\
            *value:conf/tomcat-users.xml,\
            *required:True,\
            *help:%lang/action.tom.en/udbrsc.resource.pathname.help,\
            *lhelp:%lang/action.tom.en/udbrsc.resource.pathname.lhelp,\
        }'
        readonly = '{\
            *value:true,\
            *checkIn:(true,false),\
            *help:%lang/action.tom.en/udbrsc.resource.readonly.help,\
            *lhelp:%lang/action.tom.en/udbrsc.resource.readonly.lhelp,\
        }'

        __wk__ = '{\
            *le:1,\
            *help:%lang/action.tom.en/udbrsc.resource.help,\
        }'

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

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

/udbrsc>   This Action configures a Tomcat User Database Resource.
Name Default Type Required Denied Help
name     True   %lang/action.tom.en/udbrsc.resource.name.lhelp

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

/udbrsc/resource>   The User Database resource.
Name Default Type Required Denied Help
auth true (true, false)     Authentification Type.
description   str      
factory org.apache.catalina.users.MemoryUserDatabaseFactory   True   The User Database resource Factory.
pathname conf/tomcat-users.xml   True   The path to the xml file.
readonly true (true, false)     Is the xml readonly ?

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



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