J F W

HOW TO : WEBAPP

jfw.properties

The login configuration for the administration console:

admin_user=1 admin_password=1

Remember that if these two parameters are not configured, it will be not possible to use the administration console.

The locale configuration:

default_language=en

This is the default locale of the application. The value is used in class JFWLocale.

The configuration of the logger:

isdebug=true isinfo=true iswarning=true isprofile=true iserror=true log_category=file

The value of log_category is defined in the file log4j.xml.

The configuration of the authentication and authorization:

simulate_authentication=true simulate_authorization=true

Setting authentication in false will also disable the authorization process. You can use these values in the project's main action (see an example here).

The configuration of the database:

db_resources_names=db1,jdbc/db2,db3 default_db=db1 db_resources_types=cp,ds,pcm

In the db_resources_names , we define the logical names of the database resources. The names of the resources must be separated by a comma. For example, we can declare three resources, for three different databases like this: db_resources_names=db1,jdbc/db2,db3

The db_resources_types can take these values:

1. cp : for setting a connection pool.
2. ds : for setting a datasource.
3. pcm : for proprietary connection management.

For example, if the database resource with name db1 is a connection pool, the database resource with name jdbc/db2 is a datasource, and the database resource db3 is a proprietary connection management, the configuration will be: db_resources_types=cp,ds,pcm.
We can use any logical name for a connection pool. For a data source, we have to use the one set in the application server or program used to configure the data source. A possible name will be something like this: jdbc/mydb.

In the default_db is defined the logical name of the default database. For example, a possible value is db1.

These are the additional parameters for the proprietary connection management:

pcm_class_db3=com.my.MyPcm

The pcm_class_db3 is created by adding the common prefix pcm_class_ and the name of the database resource (db3 in this example). In that parameter is defined the complete name of the class to use for get and release database connections (see proprietary connection management).

These are the additional parameters for the connection pools:

connection_test_sql=select 1 from dual cp_driver_db1=oracle.jdbc.driver.OracleDriver cp_url_db1=jdbc:oracle:thin:@server:1521:name cp_username_db1=system cp_password_db1=system cp_isdebug_db1=true cp_auto_commit_db1=false cp_max_connections_db1=1 cp_dbclean_maxtime_db1=60 cp_dbclean_freq_db1=0

In the connection_test_sql we define the sql command that will be used for verifying if a connection is open. The sql command is the same for all the connection pools.

The syntax of the parameters names are the same for all of them: the name of the parameter plus underscore plus the logical name of the database resource. So, for set the driver for db1 we have to write cp_driver_db1. If we have another database resource of connection pool type, for example db3, then for setting the driver we have to write cp_driver_db3.

The values of parameters cp_driver_ and cp_url_ depends on the database we use. You can find examples of some of them in the jfw.properties found in the example webapp.

The values of parameters cp_username_ and cp_password_ are the ones defined during the database installation.

If you want to see in the JFW web console more information about every single connection, then the cp_isdebug_ parameter must be set to true.

In cp_max_connections_ are defined the number of database connections to keep in pool. The right value of this parameter depends on your database installation. Remember that if the application needs more contemporary connections than the one defined by this parameters, the connection pool will try to open more connections. The temporary connections will be closed when the application releases them.

In cp_auto_commit_ we define the auto commit behavior for all the connections managed by this connection pool.

In cp_dbclean_maxtime_ we define the time in minutes, before a connection used by the application must be defined blocked and must be closed. Before a blocked connection is closed is rolled back.

In cp_dbclean_freq_ is set the period, in minutes, of execution of the thread which verifies the status of the connections. If the value is 0 then the verification process is inactive.

The configuration of the scheduler:

scheduled_objects=com.jfw.examples.StartupSCH#Startup/0#testing#1 schedule_objects_path=/jfw/scheduler/ schedule_thread_admins_email=name@domain.it,name@domain.it schedule_thread_email_object=Scheduling error schedule_thread_sender_email=system@domain.com

In the scheduled_objects are defined the class to execute and the scheduling type. The class StartupSCH declared previously is available in the example webapp. Let's take a closer look at the possible values for this parameter.

1. com.jfw.examples.StartupSCH : the class to execute. Must extend the class ScheduleBean.
2. Startup/0 : the type of scheduling and relative parameters. In this case the schedule is of type startup (the class will be execute only once) and will be executed 0 ms after the startup of the scheduler.
   Other types of scheduling are:
   1. Period/number : the class will be executed every number of ms after the startup of the scheduler.
   2. Daily/HH:MM : the class will execute every day. The execution will be at time HH:MM.
   3. Weekly/DAY/HH:MM : the class will be executed every week. The execution will be at the day DAY and at the time HH:MM. The DAY parameter can take one of these values: MO,TU,WE,TH,FR,SA,SU
   4. Monthly/DAY/HH:MM : the class will execute at day of the month DAY; this is a number from 1 to 31 or the string lastday if we want to declare the last day of the month. The execution will be at time HH:MM.
3. testing : a small description of the class.
4. 1 : the unique id of the scheduled class. You have to add this number if the same class is added more times in the scheduler (for example, with different schedule types).

If we want to schedule another class then we have to add at the end of the first the char @. For example, if we want to add the class TestSCH, of type period we have to write:

scheduled_objects=com.jfw.examples.StartupSCH#Startup/0#testing @ \ TestSCH#Period/60000#testing2

The schedule_objects_path must be declared if at least one schedule class has been set. The directory defined in this parameter will be used for saving information of schedule execution.

The schedule_thread_admins_email, schedule_thread_email_object and schedule_thread_sender_email are used if an error occurs during a schedule class execution. If not set, then no error mail will be sent.

You can configure a file cleaner. The cleaner will delete old files in one or more directories that have not been modified for a certain amount of days. You have to set the parameters file_cleaner, file_cleaner_paths, file_name and file_cleaner_age_days:

file_cleaner=true file_cleaner_paths=/jfw/ file_name=log file_cleaner_age_days=2

Also, you have to add the class that performs the cleanup in the scheduler:

scheduled_objects=com.jfw.scheduler.util.CleanOldFiles#Daily/13:30#File cleaner#1

Some other parameters are also exist but are facultative. You can find more info for this parameters looking in the jfw.properties.

Here is an example of a complete jfw.properties:

# #administration console # #the username for the administration console #if not defined will not be possible to use the console admin_user=status_admin #the password for the administration console #if not defined will not be possible to use the console admin_password=status_admin # #locale parameters # #language to use #values: the name of default language as defined in # http://www.loc.gov/standards/iso639-2/php/English_list.php (ISO 639-1) #default value: en default_language=en # #logger parameters # #set debug level #values: true: debug on # false: debug off #default value: false isdebug=true #set info level #values: true: info on # false: info off #default value: false isinfo=true #set warn level #values: true: warn on # false: warn off #default value: false iswarning=true #set profile level #values: true: profile on # false: profile off #default value: false isprofile=true #set error level #values: true: error on # false: error off #default value: true iserror=true #the name of the logger to use #values: the value of property name in <logger>...</logger> tags in the file log4j.xml. #default value: root log_category=fileandconsole # #authentication and authorization parameters # #set authentication simulation #values: true: simulation on # false: simulation off #default value: false simulate_authentication=true #set authorization simulation #values: true: authorization on # false: authorization off #default value: false simulate_authorization=true # #database parameters # #a csv values of database resources names (connection pools and data sources) #the names of connection pools will be used after for set the parameters db_resources_names=db1,jdbc/db2,db3 #the defualt databasre resource name #this is a value of db_resources_names default_db=db1 #a csv values of database resources types #for every value defined in parameter db_resources_names must be given the type #values: ds: if the relative resource name is for a data source # cp: if the relative resource name is for a connection pool # pcm: if the relative resource name is for proprietary connection management db_resources_types=cp,ds,pcm #the data source has no aditional parameters ########################################################### # the parameters of the proprietary connection management # ########################################################### #the name of the class that act as the manager of the connections #examle: pcm_class_db3=com.my.MyPcm ########################################## # the parameters of the connection pools # ########################################## #sql to use for test a connection of a connection pool #is the same for all the connection pools #default value: select 1 from dual connection_test_sql=select 1 from dual #connection driver #examples: oracle: oracle.jdbc.driver.OracleDriver # sqlserver: com.microsoft.jdbc.sqlserver.SQLServerDriver # mysql: com.mysql.jdbc.Driver cp_driver_db1=com.mysql.jdbc.Driver #database url #examples: oracle: jdbc:oracle:thin:@database_ip_or_name:database_port:database_name # sqlserver: jdbc:microsoft:sqlserver://database_ip_or_name:database_port;databaseName=database_name;selectMethod=cursor # mysql: jdbc:mysql://database_ip_or_name:database_port/database_name?useUnicode=false&characterEncoding=utf8 cp_url_db1=jdbc:mysql://localhost:3306/jfw?useUnicode=false&characterEncoding=utf8 #datatabase user username cp_username_db1=root #datatabase user password cp_password_db1=root #save debug info for the connections #values: true: debug info on # false: debug info off #default value: true cp_isdebug_db1=true #set autocommit of connections #values: true: autocommit on # false: autocommit off #default value: false cp_auto_commit_db1=false #max number of permanent connectionts to open #default value: 1 cp_max_connections_db1=1 #max time in minutes before a blocked (not released) connection is closed #default value: 60 cp_dbclean_maxtime_db1=60 #execute database cleaner every x minutes #if value is 0 then the cleaner is not executed #default value: 0 cp_dbclean_freq_db1=0 # #scheduler parameters # #set classes to be execute by the scheduler #frequence of execute must be defined as: #- Startup/number -> the class will be execute at the startup of the webapp # waiting for number ms before executing #- Period/number -> the class will be execute every "number" ms #- Daily/HH:MM -> the class will be execute every day at time "HH:MM" #- Weekly/DAY/HH:MM -> the class will be execute every day defined in "DAY" at time "HH:MM" # "DAY" can take one of this values: MO,TU,WE,TH,FR,SA,SU #- Monthly/DAY/HH:MM -> the class will be execute the day defined in "DAY" at time "HH:MM" # "DAY" can take one of this values: 1,2,...,31,lastday #the classes to execute are tokenized at char @ #the id parameter is used in Daily, Weekly and Monthly and permits to distinguish #different schedules of the same class. #example: scheduled_objects=package.class#frequence#description#id @ package.class#frequence#description#id scheduled_objects=com.jfw.examples.StartupSCH#Startup/0#testing @\ com.jfw.examples.MyProbe#Period/300000#probe @\ com.jfw.scheduler.util.CleanOldFiles#Daily/00:30#File cleaner#1 #the path where the scheduler save the files with scheduling executions #default value: / #example: schedule_objects_path=/jfw/scheduler/ #in case of error a mail is send to that addresses #example: schedule_thread_admins_email=name@domain.it,name@domain.it #the subject for the error mail #example: schedule_thread_email_object=Scheduling error #the mail address of sender #example: schedule_thread_sender_email=system@domain.com # #mail server parameters # #the name of the mail server to use for send the emails #it must me set if we want to send mails #example: host_email=my_company_mail_server #the username for mail server authentication #is not an obligatory parameter #example: host_email_username=my_username #the password for mail server authentication #is not an obligatory parameter #example: host_email_password=my_password #set the secure send of the mail #values: true: SSL mode # false: not SSL mode #default value: false #example: host_email_secure=false #the port of mail server #is not an obligatory parameter #example: host_email_port=25 # #file cleaner parameters # #set files cleaner #values: true: cleaning on # false: cleaning off #default value: false file_cleaner=true #the paths of files to clean #a comma separated values, every value is a absolute path to check file_cleaner_paths=/jfw/ #the name of files to clean #only the files containg this string will be delete #default value: blank string (=all files) file_name=log #the age of files to delete #this is the age in days of last modified time #default value: 7 file_cleaner_age_days=7 # #update module parameters # #the path where the update file are saved #update_src_path= #the path of the webapp to update #update_web_target_path= #the name of the webapp to update #update_web_app= #the path of the work/Catalina directory #update_web_work= #the root path of the generic file update #update_generic_file_path= #the url to execute for update infos #update_url= # #parameters of class com.jfw.web.utils.ExecuteUrl # #encode to use when set post parameters #default value: UTF-8 url_encode=UTF-8