com.arjuna.orbportability.common
Class OrbPortabilityEnvironmentBean

java.lang.Object
  extended by com.arjuna.orbportability.common.OrbPortabilityEnvironmentBean
All Implemented Interfaces:
OrbPortabilityEnvironmentBeanMBean

public class OrbPortabilityEnvironmentBean
extends java.lang.Object
implements OrbPortabilityEnvironmentBeanMBean

A JavaBean containing assorted configuration properties for the Orb Portability layer.

Author:
Jonathan Halliday (jonathan.halliday@redhat.com)

Constructor Summary
OrbPortabilityEnvironmentBean()
           
 
Method Summary
 java.lang.String getBindMechanism()
          Returns the symbolic name of the configuration mechanism used for service bindings.
 java.util.List<java.lang.String> getEventHandlers()
          Returns the classnames for the ORB object connect/disconnect event handlers.
 java.lang.String getFileDir()
          Returns the name of the directory to store reference files in.
 java.lang.String getInitialReferencesFile()
          Returns the relative name of the file in which initial references are stored.
 java.lang.String getInitialReferencesRoot()
          Returns the name of the directory in which the initial reference file is stored.
 java.lang.String getOaImplementation()
          Returns the classname of the POAImple implementation.
 java.lang.String getOrbImplementation()
          Returns the classname of the ORBImple implementation.
 java.util.Map<java.lang.String,java.lang.String> getOrbInitializationProperties()
          Returns the Map used for the orb initialization parameters.
 java.lang.String getResolveService()
          Returns the symbolic name of the configuration mechanism for resolving service references.
 void setBindMechanism(java.lang.String bindMechanism)
          Sets the symbolic name of the configuration mechanism used for service bindings.
 void setEventHandlers(java.util.List<java.lang.String> eventHandlers)
          Sets the classnames of the ORB object connect/disconnect event handlers.
 void setFileDir(java.lang.String fileDir)
          Sets the name of the direcory to store reference files in.
 void setInitialReferencesFile(java.lang.String initialReferencesFile)
          Sets the name of the initial references file.
 void setInitialReferencesRoot(java.lang.String initialReferencesRoot)
          Sets the name of the directory in which the initial reference file is stored.
 void setOaImplementation(java.lang.String oaImplementation)
          Sets the classname of the POAImple implementation.
 void setOrbImplementation(java.lang.String orbImplementation)
          Sets the classname of the ORBImple implementation.
 void setOrbInitializationProperties(java.util.Map<java.lang.String,java.lang.String> orbInitializationProperties)
          Sets the Map of properties used for ORB initialization.
 void setResolveService(java.lang.String resolveService)
          Sets the symbolic name of the configuration mechanism for resolving service references.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OrbPortabilityEnvironmentBean

public OrbPortabilityEnvironmentBean()
Method Detail

getInitialReferencesRoot

public java.lang.String getInitialReferencesRoot()
Returns the name of the directory in which the initial reference file is stored. Default: value of System.getProperty("user.dir") Equivalent deprecated property: com.arjuna.orbportability.initialReferencesRoot

Specified by:
getInitialReferencesRoot in interface OrbPortabilityEnvironmentBeanMBean
Returns:
the path to the directory in which initial references are stored.

setInitialReferencesRoot

public void setInitialReferencesRoot(java.lang.String initialReferencesRoot)
Sets the name of the directory in which the initial reference file is stored.

Specified by:
setInitialReferencesRoot in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
initialReferencesRoot - the path to the directory.

getInitialReferencesFile

public java.lang.String getInitialReferencesFile()
Returns the relative name of the file in which initial references are stored. Default: "CosServices.cfg" Equivalent deprecated property: com.arjuna.orbportability.initialReferencesFile

Specified by:
getInitialReferencesFile in interface OrbPortabilityEnvironmentBeanMBean
Returns:
the name of the initial references file.

setInitialReferencesFile

public void setInitialReferencesFile(java.lang.String initialReferencesFile)
Sets the name of the initial references file.

Specified by:
setInitialReferencesFile in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
initialReferencesFile - the file name, without directory path.

getFileDir

public java.lang.String getFileDir()
Returns the name of the directory to store reference files in. Default: null Equivalent deprecated property: com.arjuna.orbportability.fileDir

Specified by:
getFileDir in interface OrbPortabilityEnvironmentBeanMBean
Returns:
the path to the reference file directory.

setFileDir

public void setFileDir(java.lang.String fileDir)
Sets the name of the direcory to store reference files in.

Specified by:
setFileDir in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
fileDir - the path to the reference file directory.

getResolveService

public java.lang.String getResolveService()
Returns the symbolic name of the configuration mechanism for resolving service references. Default: "CONFIGURATION_FILE" Equivalent deprecated property: com.arjuna.orbportability.resolveService

Specified by:
getResolveService in interface OrbPortabilityEnvironmentBeanMBean
Returns:
the name of the configuration mechanism for service references.

setResolveService

public void setResolveService(java.lang.String resolveService)
Sets the symbolic name of the configuration mechanism for resolving service references.

Specified by:
setResolveService in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
resolveService - the name of the service resolution configuration mechanism.

getEventHandlers

public java.util.List<java.lang.String> getEventHandlers()
Returns the classnames for the ORB object connect/disconnect event handlers. The returned list is a copy. May return an empty list, will not return null. Default: empty list. Equivalent deprecated property prefix: com.arjuna.orbportability.eventHandler

Specified by:
getEventHandlers in interface OrbPortabilityEnvironmentBeanMBean
Returns:
a list of names of classes, being implementations of the EventHandler interface.

setEventHandlers

public void setEventHandlers(java.util.List<java.lang.String> eventHandlers)
Sets the classnames of the ORB object connect/disconnect event handlers. List elements should be names of classes that implement EventHandler. The provided list will be copied, not retained.

Specified by:
setEventHandlers in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
eventHandlers - a list of EventHandler implementation classnames.

getOrbImplementation

public java.lang.String getOrbImplementation()
Returns the classname of the ORBImple implementation. Default: null (i.e. use classpath based selection) Equivalent deprecated property: com.arjuna.orbportability.orbImplementation

Specified by:
getOrbImplementation in interface OrbPortabilityEnvironmentBeanMBean
Returns:
the name of the class implementing ORBImple.

setOrbImplementation

public void setOrbImplementation(java.lang.String orbImplementation)
Sets the classname of the ORBImple implementation.

Specified by:
setOrbImplementation in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
orbImplementation - the name of the class implementing ORBImple.

getOaImplementation

public java.lang.String getOaImplementation()
Returns the classname of the POAImple implementation. Default: null (i.e. user classpath based selection) Equivalent deprecated property: com.arjuna.orbportability.oaImplementation

Specified by:
getOaImplementation in interface OrbPortabilityEnvironmentBeanMBean
Returns:
the name of the class implementing POAImple.

setOaImplementation

public void setOaImplementation(java.lang.String oaImplementation)
Sets the classname of the POAImple implementation.

Specified by:
setOaImplementation in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
oaImplementation - the name of the class implementing POAImple.

getBindMechanism

public java.lang.String getBindMechanism()
Returns the symbolic name of the configuration mechanism used for service bindings. Default: "CONFIGURATION_FILE" Equivalent deprecated property: com.arjuna.orbportability.bindMechanism

Specified by:
getBindMechanism in interface OrbPortabilityEnvironmentBeanMBean
Returns:
the name of the service binding mechanism.

setBindMechanism

public void setBindMechanism(java.lang.String bindMechanism)
Sets the symbolic name of the configuration mechanism used for service bindings.

Specified by:
setBindMechanism in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
bindMechanism - the name of the service binding mechanism.

getOrbInitializationProperties

public java.util.Map<java.lang.String,java.lang.String> getOrbInitializationProperties()
Returns the Map used for the orb initialization parameters. As there are potentially an arbitrary number of ORBs, each with an arbitrary set of initialization classes, it's not well suited to bean based properties :-( The returned object is a clone. May return an empty Map, will not return null. Default: empty Map.

Specified by:
getOrbInitializationProperties in interface OrbPortabilityEnvironmentBeanMBean
Returns:
a Map containing ORB initialization information.

setOrbInitializationProperties

public void setOrbInitializationProperties(java.util.Map<java.lang.String,java.lang.String> orbInitializationProperties)
Sets the Map of properties used for ORB initialization. The provided Map will be copied, not retained.

Specified by:
setOrbInitializationProperties in interface OrbPortabilityEnvironmentBeanMBean
Parameters:
orbInitializationProperties - a Map containing ORB initialization information.