CAROL configuration is based on three properties files. The carol-defaults.properties file, the carol.properties file and the jndi.properties file. The carol-defaults.properties file is mandatory to configure CAROL. This file is embedded in the carol jar file and the CAROL standard user is not suppose to modify those defaults properties. Carol load first this default file properties and erase all configuration property with the properties find in the jndi file configuration and (after) with the properties find in the carol file configuration. So, the only important file for the CAROL standard user is the carol.properties. We are going to describe, in the next section, only the content of this file.
Note: If there is an (rpc-)URL property in the jndi.properties, the RMI name of the url is use instead of the carol-defaults.properties configured one (jrmp). By default, in the carol.properties, no configuration is needed.
The configuration described below only use the carol.properties file. Do not forget that the JNDI configuration (of one of the activated protocols) can be set inside the jndi.properties file.
The carol.properties file is a standard Java properties file. All properties, in this file, follow the rules below (we suppose that XXX is the RMI name like 'jrmp', 'iiop','jeremie', 'cmi', or 'irmi'. For all those defaults provided RMI protocol, please use those names.
Table 3-1. Carol general properties
| Property name | Property value | Description | Required |
|---|---|---|---|
| carol.protocols | 'XXX protocol-name', 'YYY protocol-name' | Activated protocols names. The first (XXX) is the default protocol for CAROL. This default protocol is used by the server when there is no entrant protocol | No, default: jrmp |
| carol.start.ns | 'true', 'false' | CAROL will automatically start all non started and configured Name Services if this property is set to 'true' | No, default: false |
| carol.start.rmi | 'true', 'false' | The CAROL PortableRemoteObjectDelegate mechanism will be deactivated if this property is set to 'false' | No, default: true |
| carol.start.jndi | 'true', 'false' | The CAROL InitialContextFactory mechanism will be deactivated if this property is set to 'false' | No, default: true |
| carol.jvm.'property-name' | 'property-value' | All extra JVM properties for RMI (directly pass to the JVM with 'name' name and 'value' value without any verifications). This is equivalent to put -D'property-name'='property-value' in the Java JVM option | No |
| carol.jndi.'property-name' | 'property-value' | All JNDI properties for all RMI (directly pass to JNDI with 'name' name and 'value' value without any verifications). This is equivalent to put 'property-name'='property-value' in the JNDI properties file | No |
Table 3-2. Carol RMI XXX specifics properties
| Property name | Property value | Description | Required |
|---|---|---|---|
| carol.XXX .PortableRemoteObjectClass | 'XXX portable remote object class name' | The portable remote object delegate class name for this RMI (CAROL provides the implementation of this class for JRMP, JEREMIE, CMI, and IRMI. See below.) | No, There is a default for each RMI provided by carol |
| carol.XXX .NameServiceClass | 'XXX carol Name Service class name' | The Name Service class name for this RMI (CAROL provides the implementation of this class for JRMP, JEREMIE, CMI, and IRMI. See below.) | No, this property is only necessary for automatically start a Name Service for this protocol and there is a default for each RMI provided by carol |
| carol.XXX.url 'property-name' | 'property-value' | JNDI url value. This property is equivalent to the jndi java.naming. provider.url property | No, there is defaults for each RMI provided by carol |
| carol.XXX.context. factory 'property-name' | 'property-value' | JNDI initial context factory class name. This property is equivalent to the jndi java.naming. factory.initial property | No, there is defaults for each RMI provided by carol. |
| carol.XXX. interceptors | 'interceptor 1 name','interceptor 2 name' | Interceptors initializers names | No |
One of the SPI personality provided by CAROL is the standard Sun RMI JRMP. This personality can be used with all standard RMI JRMP features. CAROL allows implicit context propagation with RMI JRMP (like a transactional or a security context) via a RMI IIOP Interceptors like mechanism. The example below explains the general way for CAROL RMI JRMP configuration:
Example 3-1. RMI JRMP carol.properties file.
# activated protocols
carol.protocols=jrmp
# Example of Interceptors initializer class
carol.jrmp.interceptors=
org.objectweb.carol.jtests.conform.interceptor.jrmp.Initializer
In the file above we see a JRMP standard configuration, note that nothing is needed except custom interceptors configuration. You can customized your configuration with:
Table 3-3. Carol RMI JRMP specifics properties
| Property name | Property value | Description | Required |
|---|---|---|---|
| carol.jrmp. PortableRemoteObjectClass | 'JRMP portable remote object class name' | JRMP implementation of the Portable Remote Object class name | No, there is a default for JRMP |
| carol.jrmp. NameServiceClass | 'JRMP carol Name Service class name' | JRMP implementation of the Carol name service | No, there is a default for JRMP based on the registry |
| carol.jvm.rmi. server.port | 'rmi port number' | Set the port number for exporting object thru Jeremie, 0 means random open port number | No, there is a default for JRMP (0) |
| carol.jvm.org. objectweb. PortableInterceptor. JRMPInitializerClass. 'jrmp initializer name' | '' (empty) | Initializer for JRMP inteceptors | No, there is defaults for JRMP. If there is a multi protocol configuration, CAROL automaticaly put interceptors for multi protocol management. This property is equivalent, for jrmp, to the carol.jrmp .interceptors one |
One of the SPI personalities provided by CAROL is the standard Sun RMI IIOP. This personality can be used with all standard RMI IIOP features. CAROL allow implicit context propagation with RMI IIOP (like a transactional or a security context) via a RMI IIOP Interceptors mechanism. The example below explains the general way for CAROL RMI IIOP configuration:
Example 3-2. RMI IIOP carol.properties file.
# activated protocols
carol.protocols=iiop
# Example of Interceptors initializer class (class name with package)
carol.iiop.interceptors=
org.objectweb.carol.jtests.conform.interceptor.iiop.IIOPInitializer
In the file above we see a IIOP standard configuration, note that nothing is needed except custom interceptors configuration. You can customized your configuration with:
Table 3-4. Carol RMI IIOP specifics properties
| Property name | Property value | Description | Required |
|---|---|---|---|
| carol.iiop. PortableRemoteObjectClass | 'IIOP portable remote object class name' | IIOP implementation of the Portable Remote Object class name | No, there is a default for IIOP |
| carol.iiop. NameServiceClass | 'IIOP carol Name Service class name' | IIOP implementation of the Carol name service | No, there is a default for IIOP based on the tnameserv CosNaming |
| carol.jvm.org.objectweb. PortableInterceptor. IIOPInitializerClass. 'iiop initializer name' | '' (empty) | Initializer for IIOP inteceptors | No, there is defaults for IIOP. If there is a multi protocol configuration, CAROL automaticaly put interceptors for multi protocol management. This property is equivalent, for iiop, to the carol.iiop .interceptors one |
One of the SPI personalities available/provided by CAROL is the ObjectWeb Jonathan JEREMIE personality. This personality can be used with all standard JEREMIE features. CAROL also allow JEREMIE to propagate implicitly a context (like a transactionnal or a security context) via a JEREMIE handler mechanism. This section explains the general way for CAROL JEREMIE configuration in the two jonathan.xml and carol.properties files:
Example 3-3. JEREMIE jonathan.xml file
<?xml version="1.0"?>
<!DOCTYPE Configuration SYSTEM "configuration.dtd">
<CONFIGURATION>
<ELEM name="DavidCarolHandler">
<ATOM class="org.objectweb.carol.rmi.jonathan.david.DavidCarolHandler"/>
</ELEM>
<ELEM name="david/orbs/iiop/services_handler_context/1534">
<ALIAS name="/DavidCarolHandler" />
</ELEM>
<ELEM name="JeremieCarolHandler">
<ATOM
class="org.objectweb.carol.rmi.jonathan.jeremie.JeremieCarolHandler"/>
</ELEM>
<ELEM name="jeremie/service_handler_context/1535">
<ALIAS name="/JeremieCarolHandler" />
</ELEM>
<ELEM name="jeremie/stub_factories/std">
<CONFIGURATION>
<ELEM name="Stub name extension">
<PROPERTY type="String" value="OW"/>
</ELEM>
</CONFIGURATION>
</ELEM>
</CONFIGURATION>
Inside The above file, JEREMIE is configured to use the OW extension for stub/skeleton and to use the CAROL protocol handler.
In the file above we see a JEREMIE standard configuration, note that nothing is needed except custom interceptors configuration. You can customized your configuration with:
Table 3-5. Carol RMI JEREMIE specifics properties
| Property name | Property value | Description | Required |
|---|---|---|---|
| carol.jeremie. PortableRemoteObjectClass | 'JEREMIE portable remote object class name' | JEREMIE implementation of the Portable Remote Object class name | No, there is a default for JEREMIE |
| carol.jeremie. NameServiceClass | 'JEREMIE carol Name Service class name' | JEREMIE implementation of the Carol name service | No, there is a default for JEREMIE based on the jeremie registry |
| carol.jvm.rmi. server.port | 'rmi port number' | Set the port number for exporting object thru Jeremie, 0 means random open port number | No, there is a default for JEREMIE (0) |
The IRMI protocol is an alternative to the Sun specific JRMP protocol. It is intended as a drop in replacement for the sun specific portions of the JRMP protocol and so supports interceptor configuration through exactly the same APIs and properties as the JRMP protocol with the following exceptions. The default registry port is 1098 instead of port 1099, and the server port is configured through the "carol.irmi.server.port" property instead of "carol.jrmp.server.port".
The example below describes a general RMI configuration with 3 RMI architectures configured and 2 RMI activated (RMI IIOP and JEREMIE) and with RMI IIOP default:
Example 3-5. MULTI RMI carol.propertiess file
# carol properties
# (note that for this configuration only this
# property is needed)
carol.protocols=iiop,jeremie
# start or not all non started name services
carol.start.ns=true
# use carol rmi (Multi PORD)
carol.start.rmi=true
# use carol naming (Multi JNDI)
carol.start.jndi=true
# port number
carol.jvm.rmi.server.port=10
###################################################
# Configuration for Rmi JRMP #
###################################################
# portable remote object delegate class
carol.rmi.PortableRemoteObjectClass
=org.objectweb.carol.rmi.multi.JrmpPRODelegate
# Name service class for this protocol
carol.rmi.NameServiceClass
=org.objectweb.carol.jndi.ns.JRMPRegistry
# here, for jndi we take the jndi.properties but
# we can make some :
# configuration for rmi jrmp jndi
# java.naming.factory.initial property
carol.jrmp.context.factory
=com.sun.jndi.rmi.registry.RegistryContextFactory
# java.naming.provider.url property
carol.jrmp.url
=rmi://localhost:1099
####################################################
# Configuration for Rmi IIOP #
####################################################
# portable remote object delegate class for this protocol
carol.iiop.PortableRemoteObjectClass
=com.sun.corba.se.internal.javax.rmi.PortableRemoteObject
# Name service class for this protocol
carol.iiop.NameServiceClass
=org.objectweb.carol.jndi.ns.IIOPCosNaming
# configuration for rmi jrmp jndi
# java.naming.factory.initial property
carol.iiop.context.factory
=org.objectweb.carol.jndi.iiop.IIOPReferenceContextWrapperFactory
# java.naming.provider.url property
carol.iiop.url
=iiop://localhost:2000
####################################################
# Configuration for JEREMIE #
####################################################
# portable remote object delegate class for this protocol
carol.jeremie.PortableRemoteObjectClass
=org.objectweb.carol.rmi.multi.JeremiePRODelegate
# Name service class for this protocol
carol.jeremie.NameServiceClass
=org.objectweb.carol.jndi.ns.JeremieRegistry
# here, for jndi we take the jndi.properties but we can make some :
# configuration for rmi jrmp jndi
# java.naming.factory.initial property
carol.jeremie.context.factory
=org.objectweb.jeremie.libs.services.registry.jndi.JRMIInitialContextFactory
# java.naming.provider.url property
carol.jeremie.url
=jrmi://localhost:2001
####################################################
# Configuration for CMI #
####################################################
# portable remote object delegate class for this protocol
carol.cmi.PortableRemoteObjectClass
=org.objectweb.carol.rmi.multi.CmiPRODelegate
# Name service class for this protocol
carol.cmi.NameServiceClass
=org.objectweb.carol.jndi.ns.CmiRegistry
# here, for jndi we take the jndi.properties but we can make some :
# configuration for rmi jrmp jndi
# java.naming.factory.initial property
carol.cmi.context.factory
=org.objectweb.carol.cmi.jndi.CmiInitialContextFactory
# java.naming.provider.url property
carol.cmi.url
=cmi://localhost:2002
####################################################
# Configuration for LMI #
####################################################
# portable remote object delegate class for this protocol
carol.lmi.PortableRemoteObjectClass
=org.objectweb.carol.rmi.multi.LmiPRODelegate
# Name service class for this protocol
carol.lmi.NameServiceClass
=org.objectweb.carol.jndi.ns.LmiRegistry
# here, for jndi we take the jndi.properties but we can make some :
# configuration for rmi jrmp jndi
# java.naming.factory.initial property
carol.lmi.context.initial
=org.objectweb.carol.jndi.lmi.LmiInitialContextFactory
# java.naming.provider.url property
# (only for carol, no importance)
carol.lmi.url
=lmi://nohost:0
####################################################
# Configuration for Interceptor #
####################################################
# xtra properties for the jvm (only in use in the multi protocol case)
# Protocol Interceptors initializer class
carol.jrmp.interceptors=
org.objectweb.carol.interceptor.myJRMPInterceptorInitializer
# Protocol Interceptors initializer class
carol.iiop.interceptors=
.org.objectweb.carol.interceptor.myIIOPInterceptorInitializer
####################################################
# Configuration for Global JNDI #
####################################################
# note that all other jndi properties than
# url and context factory can be found in
# the jndi.properties file or in the jvm
# (like this one)
carol.jndi.java.naming.factory.url.pkgs
=org.objectweb.carol.naming