org.exolab.jms.config
Class AdministeredDestinations

java.lang.Object
  |
  +--org.exolab.jms.config.AdministeredDestinations

All Implemented Interfaces:

java.io.Serializable

public class AdministeredDestinations

extends java.lang.Object

implements java.io.Serializable

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 **).

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

AdministeredDestinations()

Method Summary

void	addAdministeredQueue(AdministeredQueue vAdministeredQueue) Method addAdministeredQueue
void	addAdministeredQueue(int index, AdministeredQueue vAdministeredQueue) Method addAdministeredQueue
void	addAdministeredTopic(AdministeredTopic vAdministeredTopic) Method addAdministeredTopic
void	addAdministeredTopic(int index, AdministeredTopic vAdministeredTopic) Method addAdministeredTopic
void	clearAdministeredQueue() Method clearAdministeredQueue
void	clearAdministeredTopic() Method clearAdministeredTopic
java.util.Enumeration	enumerateAdministeredQueue() Method enumerateAdministeredQueue
java.util.Enumeration	enumerateAdministeredTopic() Method enumerateAdministeredTopic
AdministeredQueue[]	getAdministeredQueue() Method getAdministeredQueue
AdministeredQueue	getAdministeredQueue(int index) Method getAdministeredQueue
int	getAdministeredQueueCount() Method getAdministeredQueueCount
AdministeredTopic[]	getAdministeredTopic() Method getAdministeredTopic
AdministeredTopic	getAdministeredTopic(int index) Method getAdministeredTopic
int	getAdministeredTopicCount() Method getAdministeredTopicCount
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
boolean	removeAdministeredQueue(AdministeredQueue vAdministeredQueue) Method removeAdministeredQueue
boolean	removeAdministeredTopic(AdministeredTopic vAdministeredTopic) Method removeAdministeredTopic
void	setAdministeredQueue(AdministeredQueue[] administeredQueueArray) Method setAdministeredQueue
void	setAdministeredQueue(int index, AdministeredQueue vAdministeredQueue) Method setAdministeredQueue
void	setAdministeredTopic(AdministeredTopic[] administeredTopicArray) Method setAdministeredTopic
void	setAdministeredTopic(int index, AdministeredTopic vAdministeredTopic) Method setAdministeredTopic
static AdministeredDestinations	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

AdministeredDestinations

public AdministeredDestinations()

Method Detail

addAdministeredQueue

public void addAdministeredQueue(AdministeredQueue vAdministeredQueue)
                          throws java.lang.IndexOutOfBoundsException

Method addAdministeredQueue

Parameters:

vAdministeredQueue -

addAdministeredQueue

public void addAdministeredQueue(int index,
                                 AdministeredQueue vAdministeredQueue)
                          throws java.lang.IndexOutOfBoundsException

Method addAdministeredQueue

Parameters:

index -

vAdministeredQueue -

addAdministeredTopic

public void addAdministeredTopic(AdministeredTopic vAdministeredTopic)
                          throws java.lang.IndexOutOfBoundsException

Method addAdministeredTopic

Parameters:

vAdministeredTopic -

addAdministeredTopic

public void addAdministeredTopic(int index,
                                 AdministeredTopic vAdministeredTopic)
                          throws java.lang.IndexOutOfBoundsException

Method addAdministeredTopic

Parameters:

index -

vAdministeredTopic -

clearAdministeredQueue

public void clearAdministeredQueue()

Method clearAdministeredQueue

clearAdministeredTopic

public void clearAdministeredTopic()

Method clearAdministeredTopic

enumerateAdministeredQueue

public java.util.Enumeration enumerateAdministeredQueue()

Method enumerateAdministeredQueue

enumerateAdministeredTopic

public java.util.Enumeration enumerateAdministeredTopic()

Method enumerateAdministeredTopic

getAdministeredQueue

public AdministeredQueue getAdministeredQueue(int index)
                                       throws java.lang.IndexOutOfBoundsException

Method getAdministeredQueue

Parameters:

index -

getAdministeredQueue

public AdministeredQueue[] getAdministeredQueue()

Method getAdministeredQueue

getAdministeredQueueCount

public int getAdministeredQueueCount()

Method getAdministeredQueueCount

getAdministeredTopic

public AdministeredTopic getAdministeredTopic(int index)
                                       throws java.lang.IndexOutOfBoundsException

Method getAdministeredTopic

Parameters:

index -

getAdministeredTopic

public AdministeredTopic[] getAdministeredTopic()

Method getAdministeredTopic

getAdministeredTopicCount

public int getAdministeredTopicCount()

Method getAdministeredTopicCount

isValid

public boolean isValid()

Method isValid

marshal

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

Method marshal

Parameters:

out -

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 -

removeAdministeredQueue

public boolean removeAdministeredQueue(AdministeredQueue vAdministeredQueue)

Method removeAdministeredQueue

Parameters:

vAdministeredQueue -

removeAdministeredTopic

public boolean removeAdministeredTopic(AdministeredTopic vAdministeredTopic)

Method removeAdministeredTopic

Parameters:

vAdministeredTopic -

setAdministeredQueue

public void setAdministeredQueue(int index,
                                 AdministeredQueue vAdministeredQueue)
                          throws java.lang.IndexOutOfBoundsException

Method setAdministeredQueue

Parameters:

index -

vAdministeredQueue -

setAdministeredQueue

public void setAdministeredQueue(AdministeredQueue[] administeredQueueArray)

Method setAdministeredQueue

Parameters:

administeredQueueArray -

setAdministeredTopic

public void setAdministeredTopic(int index,
                                 AdministeredTopic vAdministeredTopic)
                          throws java.lang.IndexOutOfBoundsException

Method setAdministeredTopic

Parameters:

index -

vAdministeredTopic -

setAdministeredTopic

public void setAdministeredTopic(AdministeredTopic[] administeredTopicArray)

Method setAdministeredTopic

Parameters:

administeredTopicArray -

unmarshal

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

Method unmarshal

Parameters:

reader -

validate

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

Method validate