org.exolab.jms.config
Class Configuration

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

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

This top level element defines the structure of the OpenJMS configuration file. A minimum configuration must provide details for the DatabaseConfiguration and AdminConfiguration elements - default values will be provided for all other elements.

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

Constructor Summary
Configuration()
           
 
Method Summary
 AdminConfiguration getAdminConfiguration()
          Returns the value of field 'adminConfiguration'.
 AdministeredDestinations getAdministeredDestinations()
          Returns the value of field 'administeredDestinations'.
 ConnectorResources getConnectorResources()
          Returns the value of field 'connectorResources'.
 Connectors getConnectors()
          Returns the value of field 'connectors'.
 DatabaseConfiguration getDatabaseConfiguration()
          Returns the value of field 'databaseConfiguration'.
 GarbageCollectionConfiguration getGarbageCollectionConfiguration()
          Returns the value of field 'garbageCollectionConfiguration'.
 HttpConfiguration getHttpConfiguration()
          Returns the value of field 'httpConfiguration'.
 HttpsConfiguration getHttpsConfiguration()
          Returns the value of field 'httpsConfiguration'.
 JndiConfiguration getJndiConfiguration()
          Returns the value of field 'jndiConfiguration'.
 LoggerConfiguration getLoggerConfiguration()
          Returns the value of field 'loggerConfiguration'.
 MessageManagerConfiguration getMessageManagerConfiguration()
          Returns the value of field 'messageManagerConfiguration'.
 RmiConfiguration getRmiConfiguration()
          Returns the value of field 'rmiConfiguration'.
 SchedulerConfiguration getSchedulerConfiguration()
          Returns the value of field 'schedulerConfiguration'.
 SecurityConfiguration getSecurityConfiguration()
          Returns the value of field 'securityConfiguration'.
 ServerConfiguration getServerConfiguration()
          Returns the value of field 'serverConfiguration'.
 TcpConfiguration getTcpConfiguration()
          Returns the value of field 'tcpConfiguration'.
 TcpsConfiguration getTcpsConfiguration()
          Returns the value of field 'tcpsConfiguration'.
 Users getUsers()
          Returns the value of field 'users'.
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void setAdminConfiguration(AdminConfiguration adminConfiguration)
          Sets the value of field 'adminConfiguration'.
 void setAdministeredDestinations(AdministeredDestinations administeredDestinations)
          Sets the value of field 'administeredDestinations'.
 void setConnectorResources(ConnectorResources connectorResources)
          Sets the value of field 'connectorResources'.
 void setConnectors(Connectors connectors)
          Sets the value of field 'connectors'.
 void setDatabaseConfiguration(DatabaseConfiguration databaseConfiguration)
          Sets the value of field 'databaseConfiguration'.
 void setGarbageCollectionConfiguration(GarbageCollectionConfiguration garbageCollectionConfiguration)
          Sets the value of field 'garbageCollectionConfiguration'.
 void setHttpConfiguration(HttpConfiguration httpConfiguration)
          Sets the value of field 'httpConfiguration'.
 void setHttpsConfiguration(HttpsConfiguration httpsConfiguration)
          Sets the value of field 'httpsConfiguration'.
 void setJndiConfiguration(JndiConfiguration jndiConfiguration)
          Sets the value of field 'jndiConfiguration'.
 void setLoggerConfiguration(LoggerConfiguration loggerConfiguration)
          Sets the value of field 'loggerConfiguration'.
 void setMessageManagerConfiguration(MessageManagerConfiguration messageManagerConfiguration)
          Sets the value of field 'messageManagerConfiguration'.
 void setRmiConfiguration(RmiConfiguration rmiConfiguration)
          Sets the value of field 'rmiConfiguration'.
 void setSchedulerConfiguration(SchedulerConfiguration schedulerConfiguration)
          Sets the value of field 'schedulerConfiguration'.
 void setSecurityConfiguration(SecurityConfiguration securityConfiguration)
          Sets the value of field 'securityConfiguration'.
 void setServerConfiguration(ServerConfiguration serverConfiguration)
          Sets the value of field 'serverConfiguration'.
 void setTcpConfiguration(TcpConfiguration tcpConfiguration)
          Sets the value of field 'tcpConfiguration'.
 void setTcpsConfiguration(TcpsConfiguration tcpsConfiguration)
          Sets the value of field 'tcpsConfiguration'.
 void setUsers(Users users)
          Sets the value of field 'users'.
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

Configuration

public Configuration()
Method Detail

getAdminConfiguration

public AdminConfiguration getAdminConfiguration()
Returns the value of field 'adminConfiguration'. The field 'adminConfiguration' has the following description: This element defines items specific to OpenJMS administration.

Returns:
AdminConfiguration

getAdministeredDestinations

public AdministeredDestinations getAdministeredDestinations()
Returns the value of field 'administeredDestinations'. The field 'administeredDestinations' has the following description: This element is used to bootstrap the creation of administered topics and queues. It also allows the client to register durable subscribers for administered topics. OpenJMS also supports topic hierarchy and wildcard subscriptions. A topic hierarchy is defined as a sequence of names separated by a '.' (i.e a.b.c). Users can subscribe to multiple topics using '*' and the '**'. A '*' will wildcard one level in the hierarchy and a '**' will wildcard all subsequent levels (i.e a.*, a.b.** or **).

Returns:
AdministeredDestinations

getConnectorResources

public ConnectorResources getConnectorResources()
Returns the value of field 'connectorResources'. The field 'connectorResources' has the following description: The connectorResources element is the root element of all connector resource documents.

Returns:
ConnectorResources

getConnectors

public Connectors getConnectors()
Returns the value of field 'connectors'.

Returns:
Connectors

getDatabaseConfiguration

public DatabaseConfiguration getDatabaseConfiguration()
Returns the value of field 'databaseConfiguration'.

Returns:
DatabaseConfiguration

getGarbageCollectionConfiguration

public GarbageCollectionConfiguration getGarbageCollectionConfiguration()
Returns the value of field 'garbageCollectionConfiguration'. The field 'garbageCollectionConfiguration' has the following description: This element defines items specific to the garbage collection service.

Returns:
GarbageCollectionConfiguration

getHttpConfiguration

public HttpConfiguration getHttpConfiguration()
Returns the value of field 'httpConfiguration'. The field 'httpConfiguration' has the following description: This element defines items specific to the HTTP configuration. It defines the host and port of the web server that a client can use to start the OpenJMS servlet required for HTTP connections. The OpenJMS HTTP connector will use this information to build a URL of the form: http://host:port/openjms/OpenJMSServer

Returns:
HttpConfiguration

getHttpsConfiguration

public HttpsConfiguration getHttpsConfiguration()
Returns the value of field 'httpsConfiguration'. The field 'httpsConfiguration' has the following description: This element defines items specific to the HTTPS configuration. It defines the host and port of the web server that a client can use to start the OpenJMS servlet required for HTTPS connections.

Returns:
HttpsConfiguration

getJndiConfiguration

public JndiConfiguration getJndiConfiguration()
Returns the value of field 'jndiConfiguration'. The field 'jndiConfiguration' has the following description: This element defines the properties used when constructing an InitialContext. Users only need to specify this if an external JNDI provider is being used. Typically the java.naming.factory.initial property must be supplied, with the fully qualified name of the factory class that will create an initial context.

Returns:
JndiConfiguration

getLoggerConfiguration

public LoggerConfiguration getLoggerConfiguration()
Returns the value of field 'loggerConfiguration'. The field 'loggerConfiguration' has the following description: This element specifies the file to initialise logging with. OpenJMS uses Apache log4j (http://jakarta.apache.org/log4j/docs/index.html) for logging.

Returns:
LoggerConfiguration

getMessageManagerConfiguration

public MessageManagerConfiguration getMessageManagerConfiguration()
Returns the value of field 'messageManagerConfiguration'. The field 'messageManagerConfiguration' has the following description: This element defines items specific to the message manager.

Returns:
MessageManagerConfiguration

getRmiConfiguration

public RmiConfiguration getRmiConfiguration()
Returns the value of field 'rmiConfiguration'. The field 'rmiConfiguration' has the following description: This element defines items specific to the RMI connector.

Returns:
RmiConfiguration

getSchedulerConfiguration

public SchedulerConfiguration getSchedulerConfiguration()
Returns the value of field 'schedulerConfiguration'. The field 'schedulerConfiguration' has the following description: This element defines items specific to the scheduler.

Returns:
SchedulerConfiguration

getSecurityConfiguration

public SecurityConfiguration getSecurityConfiguration()
Returns the value of field 'securityConfiguration'. The field 'securityConfiguration' has the following description: This element defines items specific to the OpenJMS server. By default, OpenJMS uses no security.

Returns:
SecurityConfiguration

getServerConfiguration

public ServerConfiguration getServerConfiguration()
Returns the value of field 'serverConfiguration'. The field 'serverConfiguration' has the following description: This element defines items specific to the OpenJMS server. By default, OpenJMS uses an embedded JNDI server.

Returns:
ServerConfiguration

getTcpConfiguration

public TcpConfiguration getTcpConfiguration()
Returns the value of field 'tcpConfiguration'. The field 'tcpConfiguration' has the following description: This element defines items specific to the TCP connector.

Returns:
TcpConfiguration

getTcpsConfiguration

public TcpsConfiguration getTcpsConfiguration()
Returns the value of field 'tcpsConfiguration'. The field 'tcpsConfiguration' has the following description: This element defines items specific to the TCP connector.

Returns:
TcpsConfiguration

getUsers

public Users getUsers()
Returns the value of field 'users'. The field 'users' has the following description: This element is used to bootstrap the creation of users.

Returns:
Users

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

setAdminConfiguration

public void setAdminConfiguration(AdminConfiguration adminConfiguration)
Sets the value of field 'adminConfiguration'. The field 'adminConfiguration' has the following description: This element defines items specific to OpenJMS administration.

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

setAdministeredDestinations

public void setAdministeredDestinations(AdministeredDestinations administeredDestinations)
Sets the value of field 'administeredDestinations'. The field 'administeredDestinations' has the following description: This element is used to bootstrap the creation of administered topics and queues. It also allows the client to register durable subscribers for administered topics. OpenJMS also supports topic hierarchy and wildcard subscriptions. A topic hierarchy is defined as a sequence of names separated by a '.' (i.e a.b.c). Users can subscribe to multiple topics using '*' and the '**'. A '*' will wildcard one level in the hierarchy and a '**' will wildcard all subsequent levels (i.e a.*, a.b.** or **).

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

setConnectorResources

public void setConnectorResources(ConnectorResources connectorResources)
Sets the value of field 'connectorResources'. The field 'connectorResources' has the following description: The connectorResources element is the root element of all connector resource documents.

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

setConnectors

public void setConnectors(Connectors connectors)
Sets the value of field 'connectors'.

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

setDatabaseConfiguration

public void setDatabaseConfiguration(DatabaseConfiguration databaseConfiguration)
Sets the value of field 'databaseConfiguration'.

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

setGarbageCollectionConfiguration

public void setGarbageCollectionConfiguration(GarbageCollectionConfiguration garbageCollectionConfiguration)
Sets the value of field 'garbageCollectionConfiguration'. The field 'garbageCollectionConfiguration' has the following description: This element defines items specific to the garbage collection service.

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

setHttpConfiguration

public void setHttpConfiguration(HttpConfiguration httpConfiguration)
Sets the value of field 'httpConfiguration'. The field 'httpConfiguration' has the following description: This element defines items specific to the HTTP configuration. It defines the host and port of the web server that a client can use to start the OpenJMS servlet required for HTTP connections. The OpenJMS HTTP connector will use this information to build a URL of the form: http://host:port/openjms/OpenJMSServer

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

setHttpsConfiguration

public void setHttpsConfiguration(HttpsConfiguration httpsConfiguration)
Sets the value of field 'httpsConfiguration'. The field 'httpsConfiguration' has the following description: This element defines items specific to the HTTPS configuration. It defines the host and port of the web server that a client can use to start the OpenJMS servlet required for HTTPS connections.

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

setJndiConfiguration

public void setJndiConfiguration(JndiConfiguration jndiConfiguration)
Sets the value of field 'jndiConfiguration'. The field 'jndiConfiguration' has the following description: This element defines the properties used when constructing an InitialContext. Users only need to specify this if an external JNDI provider is being used. Typically the java.naming.factory.initial property must be supplied, with the fully qualified name of the factory class that will create an initial context.

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

setLoggerConfiguration

public void setLoggerConfiguration(LoggerConfiguration loggerConfiguration)
Sets the value of field 'loggerConfiguration'. The field 'loggerConfiguration' has the following description: This element specifies the file to initialise logging with. OpenJMS uses Apache log4j (http://jakarta.apache.org/log4j/docs/index.html) for logging.

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

setMessageManagerConfiguration

public void setMessageManagerConfiguration(MessageManagerConfiguration messageManagerConfiguration)
Sets the value of field 'messageManagerConfiguration'. The field 'messageManagerConfiguration' has the following description: This element defines items specific to the message manager.

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

setRmiConfiguration

public void setRmiConfiguration(RmiConfiguration rmiConfiguration)
Sets the value of field 'rmiConfiguration'. The field 'rmiConfiguration' has the following description: This element defines items specific to the RMI connector.

Parameters:
rmiConfiguration - the value of field 'rmiConfiguration'

setSchedulerConfiguration

public void setSchedulerConfiguration(SchedulerConfiguration schedulerConfiguration)
Sets the value of field 'schedulerConfiguration'. The field 'schedulerConfiguration' has the following description: This element defines items specific to the scheduler.

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

setSecurityConfiguration

public void setSecurityConfiguration(SecurityConfiguration securityConfiguration)
Sets the value of field 'securityConfiguration'. The field 'securityConfiguration' has the following description: This element defines items specific to the OpenJMS server. By default, OpenJMS uses no security.

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

setServerConfiguration

public void setServerConfiguration(ServerConfiguration serverConfiguration)
Sets the value of field 'serverConfiguration'. The field 'serverConfiguration' has the following description: This element defines items specific to the OpenJMS server. By default, OpenJMS uses an embedded JNDI server.

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

setTcpConfiguration

public void setTcpConfiguration(TcpConfiguration tcpConfiguration)
Sets the value of field 'tcpConfiguration'. The field 'tcpConfiguration' has the following description: This element defines items specific to the TCP connector.

Parameters:
tcpConfiguration - the value of field 'tcpConfiguration'

setTcpsConfiguration

public void setTcpsConfiguration(TcpsConfiguration tcpsConfiguration)
Sets the value of field 'tcpsConfiguration'. The field 'tcpsConfiguration' has the following description: This element defines items specific to the TCP connector.

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

setUsers

public void setUsers(Users users)
Sets the value of field 'users'. The field 'users' has the following description: This element is used to bootstrap the creation of users.

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

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.