Clarens logo
Home
Installation Guide
Build Instructions
User Guide
JClarens Installations
JClarens Javadoc
Clarens Home Page
Developers' Guide
Documentation
Development Team
      
      

JClarens Configuration

There are two main files that can be used to configure JClarens.

The first is in jclarens/log4j.properties. This file contains the logging settings for JClarens. The last line can be used to change the log level. Simply change DEBUG to WARN, ERROR, FATAL, INFO, or OFF. The other log settings can be customized according to the log4j configuration rules. See http://jakarta.apache.org/log4j/docs/documentation.html for information on configuring log4j.

The second file is in jclarens/xmlrpc_handlers.properties. This file contains the configuration settings for the individual service handlers and for JClarens in general. This file can also be used to set up the settings for your database. Sample settings for HSQLDB, ODBC, MySQL and SQL Server database are included in the file already. To do your own settings, comment the pre-existing settings, and add your own database settings. The properties you can set here include:

jclarens.db.dbDriver: The full name of the class that acts as the driver of the database.

jclarens.db.dbURL: The URL of the database.

jclarens.db.dbUser: The name of the database’s user

jclarens.db.dbPassword: The password of the user specified in dbUser.

The xmlrpc_handlers.properties file also contains the XML-RPC handlers and configuration settings for the handlers. Handlers take the form:

service.<methodName>.handler=full.class.name

Configuration settings for a handler take the form:

service.<methodName>.<property>=value

For example, to register a new "mp3" handler with the setting "ogg=supported", you would use:

service.mp3.handler=my.mp3.handler.class

service.mp3.ogg=supported

In order to set a particular configuration setting applicable for all handlers, add a property of the form:

service.handlers.<property>=value

The aclchecker property is an example of such a property:

service.handlers.aclchecker= The full name of the class that will manage authorization for a service, e.g "pk.edu.niit.clarens.AuthorizationChecker"

The tomcat server must be restarted after making any configuration change before the change will take effect.

List of Required Handler Properties:

interface
The full name of the class that encapsulates the methods exposed by a service, e.g. "pk.edu.niit.clarens.services.system.System"

handler
The full name of the class that will act as the XML-RPC or SOAP wrapper or handler for a service

impl
The full name of the class that implements the methods of the interface mentioned in the "interface" property value

major_version
The service's major version number

minor_version
The service's minor version number

Besides these necessary properties, any other properties required by a service for its particular functionality can also be included in the xmlrpc_handlers.properties file.

Two of the most important such properties are the paths to the host certificate and key to be used by JClarens. These must be specified in the service.system.hostCertFile and service.system.hostKeyFile properties. For further details on service adapter configuration, see Service Adapter Configuration in the Developers Guide.

Plugging in MySQL (or other database servers):

1. You can set up an alternate database (such as MySQL) for the access control lists (ACLs) as follows:

a. Install MySQL (http://www.mysql.com) and create a user with the priveleges to perform all operations on the ClarensDB database. Usually the default passwordless root login suffices. However, in case of problems, log into mysql and issue the following command:

GRANT ALL PRIVILEGES ON *.* TO 'the_username'@'your_machine_name' IDENTIFIED BY 'the_users_password' WITH GRANT OPTION;

b. Log into mysql and issue the following commands:

create database ClarensDB
use ClarensDB;

c. If you decide not to use theMySQL database with a passwordless root login, modify the properties jclarens.db.user and jclarens.db.password in the $TOMCAT_HOME/webapps/jclarens/xmlrpc_handlers.properties file according to your own database settings.

d. Start JClarens' Tomcat servlet container. JClarens will automatically create all the tables it requires.

2. To manually add users to the authorization table, use a query like:

insert into METHODACLS VALUES ('system', NULL, '/O=Globus/O=Grid/OU=niit.edu.pk /CN=ashiq.anjum', 1, 'allow');

In addition, you can easily use the web browser interface to modify and manage the JClarens ACLs, instead of entering them directly in the database. For more information, see Adding Access Control Lists