|
|
Env
Action : tom.env (Category : tom, Name : env, By : kikonf)
Complete Name : tom.env.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 env plugin : This Action configures a Tomcat Environmen entry.
The following shows the Descriptor File for the Action : tom.env
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 -->
<!-- ====================================================================== -->
<!-- | | | -->
<!-- -->
<!-- -->
<!-- ====================================================================== -->
<env
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/env.name.help,\
*lhelp:%lang/action.tom.en/env.name.lhelp,\
}'
etype = '{\
*value:java.lang.String,\
*checkIn:(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),\
*required:True,\
*help:%lang/action.tom.en/env.etype.help,\
*lhelp:%lang/action.tom.en/env.etype.lhelp,\
}'
desc=''
__wk__='{\
*help:%lang/action.tom.en/env.help,\
*lhelp:%lang/action.tom.en/env.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,\
}'
/>
<envrsc
value = '{\
*required:True,\
*help:%lang/action.tom.en/env.envrsc.value.help,\
*lhelp:%lang/action.tom.en/env.envrsc.value.lhelp,\
}'
override = '{\
*checkIn:(true,false),\
*help:%lang/action.tom.en/env.envrsc.override.help,\
*lhelp:%lang/action.tom.en/env.envrsc.override.lhelp,\
}'
>
__wk__ = '{\
*le:1,\
*help:%lang/action.tom.en/env.envrsc.help,\
*lhelp:%lang/action.tom.en/env.envrsc.lhelp\
}'
</envrsc>
<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\
}'
/>
</env>
<!-- 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 -->
<!-- ====================================================================== -->
<!-- | | | -->
<!-- -->
<!-- -->
<!-- ====================================================================== -->
<env
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/env.name.help,\
*lhelp:%lang/action.tom.en/env.name.lhelp,\
}'
etype = '{\
*value:java.lang.String,\
*checkIn:(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),\
*required:True,\
*help:%lang/action.tom.en/env.etype.help,\
*lhelp:%lang/action.tom.en/env.etype.lhelp,\
}'
desc=''
__wk__='{\
*help:%lang/action.tom.en/env.help,\
*lhelp:%lang/action.tom.en/env.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,\
}'
/>
<envrsc
value = '{\
*required:True,\
*help:%lang/action.tom.en/env.envrsc.value.help,\
*lhelp:%lang/action.tom.en/env.envrsc.value.lhelp,\
}'
override = '{\
*checkIn:(true,false),\
*help:%lang/action.tom.en/env.envrsc.override.help,\
*lhelp:%lang/action.tom.en/env.envrsc.override.lhelp,\
}'
>
__wk__ = '{\
*le:1,\
*help:%lang/action.tom.en/env.envrsc.help,\
*lhelp:%lang/action.tom.en/env.envrsc.lhelp\
}'
</envrsc>
<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\
}'
/>
</env>
(Source: <KIKONF_INSTALLATION_DIR>/plugins/actions/tom/env/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.env 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.
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.
|