org.exolab.jms.config
Class RmiConfiguration

java.lang.Object
  extended by org.exolab.jms.config.RmiConfiguration
All Implemented Interfaces:
java.io.Serializable

public class RmiConfiguration
extends java.lang.Object
implements java.io.Serializable

This element defines items specific to the RMI connector.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
RmiConfiguration()
           
 
Method Summary
 void deleteClientPingInterval()
          Method deleteClientPingInterval
 void deleteEmbeddedRegistry()
          Method deleteEmbeddedRegistry
 void deleteRegistryPort()
          Method deleteRegistryPort
 java.lang.String getAdminName()
          Returns the value of field 'adminName'.
 int getClientPingInterval()
          Returns the value of field 'clientPingInterval'.
 boolean getEmbeddedRegistry()
          Returns the value of field 'embeddedRegistry'.
 java.lang.String getJndiName()
          Returns the value of field 'jndiName'.
 java.lang.String getRegistryHost()
          Returns the value of field 'registryHost'.
 int getRegistryPort()
          Returns the value of field 'registryPort'.
 java.lang.String getServerName()
          Returns the value of field 'serverName'.
 boolean hasClientPingInterval()
          Method hasClientPingInterval
 boolean hasEmbeddedRegistry()
          Method hasEmbeddedRegistry
 boolean hasRegistryPort()
          Method hasRegistryPort
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void setAdminName(java.lang.String adminName)
          Sets the value of field 'adminName'.
 void setClientPingInterval(int clientPingInterval)
          Sets the value of field 'clientPingInterval'.
 void setEmbeddedRegistry(boolean embeddedRegistry)
          Sets the value of field 'embeddedRegistry'.
 void setJndiName(java.lang.String jndiName)
          Sets the value of field 'jndiName'.
 void setRegistryHost(java.lang.String registryHost)
          Sets the value of field 'registryHost'.
 void setRegistryPort(int registryPort)
          Sets the value of field 'registryPort'.
 void setServerName(java.lang.String serverName)
          Sets the value of field 'serverName'.
static java.lang.Object unmarshal(java.io.Reader reader)
          Method unmarshal
 void validate()
          Method validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RmiConfiguration

public RmiConfiguration()
Method Detail

deleteClientPingInterval

public void deleteClientPingInterval()
Method deleteClientPingInterval


deleteEmbeddedRegistry

public void deleteEmbeddedRegistry()
Method deleteEmbeddedRegistry


deleteRegistryPort

public void deleteRegistryPort()
Method deleteRegistryPort


getAdminName

public java.lang.String getAdminName()
Returns the value of field 'adminName'. The field 'adminName' has the following description: The name of the Administration server. This must be unique within the RMI registry being used.

Returns:
String

getClientPingInterval

public int getClientPingInterval()
Returns the value of field 'clientPingInterval'. The field 'clientPingInterval' has the following description: The client ping interval, specified in seconds. If set to 0, the ping is disabled.

Returns:
int

getEmbeddedRegistry

public boolean getEmbeddedRegistry()
Returns the value of field 'embeddedRegistry'. The field 'embeddedRegistry' has the following description: This specifies whether to use an embedded (or internal) RMI registry, or an external one.

Returns:
boolean

getJndiName

public java.lang.String getJndiName()
Returns the value of field 'jndiName'. The field 'jndiName' has the following description: The name of the JNDI server. This must be unique within the RMI registry being used.

Returns:
String

getRegistryHost

public java.lang.String getRegistryHost()
Returns the value of field 'registryHost'. The field 'registryHost' has the following description: The RMI registry host. This is only applicable if an external RMI registry is being used, i.e., embeddedRegistry is false.

Returns:
String

getRegistryPort

public int getRegistryPort()
Returns the value of field 'registryPort'. The field 'registryPort' has the following description: The RMI registry port.

Returns:
int

getServerName

public java.lang.String getServerName()
Returns the value of field 'serverName'. The field 'serverName' has the following description: The name of the OpenJMS server. This must be unique within the RMI registry being used.

Returns:
String

hasClientPingInterval

public boolean hasClientPingInterval()
Method hasClientPingInterval

Returns:
boolean

hasEmbeddedRegistry

public boolean hasEmbeddedRegistry()
Method hasEmbeddedRegistry

Returns:
boolean

hasRegistryPort

public boolean hasRegistryPort()
Method hasRegistryPort

Returns:
boolean

isValid

public boolean isValid()
Method isValid

Returns:
boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
handler -
Throws:
java.io.IOException
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

setAdminName

public void setAdminName(java.lang.String adminName)
Sets the value of field 'adminName'. The field 'adminName' has the following description: The name of the Administration server. This must be unique within the RMI registry being used.

Parameters:
adminName - the value of field 'adminName'.

setClientPingInterval

public void setClientPingInterval(int clientPingInterval)
Sets the value of field 'clientPingInterval'. The field 'clientPingInterval' has the following description: The client ping interval, specified in seconds. If set to 0, the ping is disabled.

Parameters:
clientPingInterval - the value of field 'clientPingInterval'.

setEmbeddedRegistry

public void setEmbeddedRegistry(boolean embeddedRegistry)
Sets the value of field 'embeddedRegistry'. The field 'embeddedRegistry' has the following description: This specifies whether to use an embedded (or internal) RMI registry, or an external one.

Parameters:
embeddedRegistry - the value of field 'embeddedRegistry'

setJndiName

public void setJndiName(java.lang.String jndiName)
Sets the value of field 'jndiName'. The field 'jndiName' has the following description: The name of the JNDI server. This must be unique within the RMI registry being used.

Parameters:
jndiName - the value of field 'jndiName'.

setRegistryHost

public void setRegistryHost(java.lang.String registryHost)
Sets the value of field 'registryHost'. The field 'registryHost' has the following description: The RMI registry host. This is only applicable if an external RMI registry is being used, i.e., embeddedRegistry is false.

Parameters:
registryHost - the value of field 'registryHost'.

setRegistryPort

public void setRegistryPort(int registryPort)
Sets the value of field 'registryPort'. The field 'registryPort' has the following description: The RMI registry port.

Parameters:
registryPort - the value of field 'registryPort'.

setServerName

public void setServerName(java.lang.String serverName)
Sets the value of field 'serverName'. The field 'serverName' has the following description: The name of the OpenJMS server. This must be unique within the RMI registry being used.

Parameters:
serverName - the value of field 'serverName'.

unmarshal

public static java.lang.Object unmarshal(java.io.Reader reader)
                                  throws org.exolab.castor.xml.MarshalException,
                                         org.exolab.castor.xml.ValidationException
Method unmarshal

Parameters:
reader -
Returns:
Object
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Method validate

Throws:
org.exolab.castor.xml.ValidationException


Copyright © 1999-2005 The OpenJMS Group. All Rights Reserved.