cle_clock
Home > wikikonf >  wls/actions/by kikonf > jvm







Jvm

print

Action : wls.jvm   (Category : wls, Name : jvm, By : kikonf)
Complete Name : wls.jvm.by.kikonf
Version : 4.0        License : Modified BSD License

Purpose of the wls category :
Easy to customize. This category use in background the wlst command in jython mode, to drive WebLogic Server ® configuration.
You can use it to manage the whole WebLogic ® architecture.

Purpose of this jvm plugin : Tunes a JVM

The following shows the Descriptor File for the Action : wls.jvm

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

<!-- 
    -----------------------------------
    | General descriptor file syntax: |
    -----------------------------------

    *value : stands for default value.
    Any attribute that has a default value do not need to be set (even if it is required) !
    Attributes : type, software, version are reserved and must not be set.
    Attributes : version is set by the Parser engine.
    If the Attribute value starts by { and end by }, its content will be CoolTyped.

    Attributes and texts values between {} are evaluated using the wk formalism.
    Here is a snapshot of the wk formalism:
    ...
    The wk formalism can be writen using too syntaxes:
    Either the python syntax:
       version = "{\
           '*value': 7.0,\
           '*ge': 6.1,\
           '*le': 7.9,\
           '*required': True\
       }"
       equivalente to (skipping no line):
       version = "{'*value': 7.0, '*ge': 6.1, '*le':7.9, '*required': 'True'}"
    Or the CoolTyping syntax:
       version = '{\
           *value:7.0,\
           *ge:6.1,\
           *le:7.9,\
           *required:True\
       }'
       This is the same shape but without ' nor ".
       Easiest to write as long as we dont bother anymore about ' nor ".
       The CoolTyping engine will deduct for us the python inner types
       They deducted from what they obviously seems like.
       Ex: *value becomes a python string.
           7.0 becomes a python float.
           True becomes a python bool.
       Be aware that this syntax supports no space between special character like : {}, (), : and ,.
    If the expression contain at least one ', it's assume to be using the python syntax.
-->


<!-- temp_dir: If temp_dir is set all WAS temporary files go there (dervlet scratch dir, this jvm workspace dir, java.io.temp, ...).            -->
<!--    Some time you may not want to flood your regular Application server logs (stdout) with HA (DCS protocol) messages or free your network. -->
<!--    In this case you may want to disable WAS HA Manager.                                                                                    -->
<!-- shared_classes: refers to shared classes loaded and shared at the system levelat the extension classloader level. -->
<jvm
    type = '{\
        *eq:action,\
        *required:True\
    }'
    bal = ''
    sub_type = '{\
        *value:configuration,\
        *eq:configuration,\
        *required:True\
    }'
    softwares = "{\
        '*type':'dict',\
        '*dtype':\
            {\
                'wls':\
                {\
                    '*ge':'10',\
                    '*required':True\
                }\
            }\
    }"

    xms = '{\
        *value:256,\
        *type:int,\
        *required:True\
    }' 
    xmx = '{\
        *value:512,\
        *type:int,\
        *required:True\
    }' 

    user=''
    password=''
    root_dir='' 
    temp_dir=''
    java_home=''
    dft_context=''

    startup_mode='{\
            *value:RUNNING,\
            *checkIn:(RUNNING,ADMINISTRATION,STANDBY),\
            *required:True\
    }' 
    shared_classes='{\
        *value:off,\
        *checkIn:(off,auto,on),\
        *required:True\
    }' 
    run_hprof = '{\
        *value:false,\
        *checkIn:(false,true),\
        *required:True\
    }' 

    enable_ssl='{*value:false,*checkIn:(false,true),*required:True}'
    ssl_client_cert='{*value:false,*checkIn:(false,true),*required:True}'
    enable_keep_alive='{*value:true,*checkIn:(false,true),*required:True}'
    enable_plugin='{*value:true,*checkIn:(false,true),*required:True}'    
    admin_port='{*value:9002,*type:int,*required:True}'
    __wk__='{*help:%lang/action.wls.en/jvm.help}'
    >

    <scope 
        cluster=''
        server = '{*required:True}'
        __wk__='{\
            *eq:1,\
            *help:%lang/action.wls.en/scope.help,\
            *lhelp:%lang/action.wls.en/scope.lhelp,\
        }'
    />

    <!-- 
        frontend_host: Redirect instead of Host header.
        frontend_htttp_port: Redirect instead of Host header.
        frontend_htttps_port: Redirect instead of Host header.
        client_ip_header: Remote Address Override, Returned by getRemoteAddr() using LB.
    -->
    <redirects 
        frontend_host=''
        frontend_htttp_port='{*value:0,*type:int}'
        frontend_htttps_port='{*value:0,*type:int}'
        client_ip_header=''
        __wk__='{*le:1}'
    />
    
    <verbose
        clas='{\
            *value:false,\
            *checkIn:(false,true),\
            *required:True\
        }' 
        gc='{\
            *value:false,\
            *checkIn:(false,true),\
            *required:True\
        }' 
        jni='{\
            *value:false,\
            *checkIn:(false,true),\
            *required:True\
        }' 
        __wk__='{*le:1}'
    />

    <!--
    disable: disable class garbage collection
    enable_inc: enable incremental garbage collection
    log_file: log GC status to a file with time stamps    
    -->
    <gc
        disable='{*value:false,*checkIn:(false,true),*required:True}'
        enable_inc='{*value:false,*checkIn:(false,true),*required:True}'
        log_file=''
        __wk__='{*le:1}'
    />

    <classpath __wk__='{*le:1}'>
        {*type:str}
    </classpath>

    <boot_classpath __wk__='{*le:1}'>
        {*type:str}
    </boot_classpath>

    <prepend_classpath __wk__='{*le:1}'>
        {*type:str}
    </prepend_classpath>
    
    <append_classpath __wk__='{*le:1}'>
        {*type:str}
    </append_classpath>

    <!-- extlibs: refers to shared classes loaded at the extension classloader level. -->
    <extlibs __wk__='{*le:1}'>
        {*type:str}
    </extlibs>
    
    <generic_jvm_args __wk__='{*le:1}'>
        {*type:str}
    </generic_jvm_args>

</jvm>


<!-- Trademarks:                                                                     -->
<!-- ___________                                                                     -->
<!-- Oracle and Java are registred trademarks of Oracle and/or its affiliates.       -->
<!--                                                                                 -->
<!-- Other names may be trademarks of their respective owners.                       -->
							
(Source: <KIKONF_INSTALLATION_DIR>/plugins/actions/wls/jvm/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 wls.jvm Descriptor File :

/jvm>   Tunes a JVM
Name Default Type Required Denied Help
type     True    
bal   str      
sub_type configuration   True    
softwares   dict      
xms 256 int True    
xmx 512 int True    
user   str      
password   str      
root_dir   str      
temp_dir   str      
java_home   str      
dft_context   str      
startup_mode RUNNING (RUNNING, ADMINISTRATION, STANDBY) True    
shared_classes off (off, auto, on) True    
run_hprof false (false, true) True    
enable_ssl false (false, true) True    
ssl_client_cert false (false, true) True    
enable_keep_alive true (false, true) True    
enable_plugin true (false, true) True    
admin_port 9002 int True    

/jvm/scope>   A scope refers to a Name Space where to create the resource
Required:True
Name Default Type Required Denied Help
cluster   str      
server     True    

/jvm/redirects>  
Name Default Type Required Denied Help
frontend_host   str      
frontend_htttp_port 0 int      
frontend_htttps_port 0 int      
client_ip_header   str      

/jvm/verbose>  
Name Default Type Required Denied Help
clas false (false, true) True    
gc false (false, true) True    
jni false (false, true) True    

/jvm/gc>  
Name Default Type Required Denied Help
disable false (false, true) True    
enable_inc false (false, true) True    
log_file   str      

/jvm/classpath>  

/jvm/boot_classpath>  

/jvm/prepend_classpath>  

/jvm/append_classpath>  

/jvm/extlibs>  

/jvm/generic_jvm_args>  



Trademarks :
  • "oracle", "Weblogic", "Weblogic Server", "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