org.exolab.jmscts.provider
Interface Provider

public interface Provider

This interface specifies methods for accessing a JMS provider.

Version:

$Revision: 1.2 $ $Date: 2004/02/02 03:50:09 $

Author:

Tim Anderson

See Also:

Administrator

Method Summary

void	cleanup(boolean stop) Release any resources used by the provider
Administrator	getAdministrator() Returns the administration interface
void	initialise(boolean start) Perform any initialisation required prior to using the JMS provider

Method Detail

initialise

public void initialise(boolean start)
                throws javax.jms.JMSException

Perform any initialisation required prior to using the JMS provider

Parameters:

start - if true start the provider. This argument may be ignored by implementors.

Throws:

javax.jms.JMSException - if the initialisation cannot be performed

getAdministrator

public Administrator getAdministrator()
                               throws javax.jms.JMSException

Returns the administration interface

Returns:

the administration interface

Throws:

javax.jms.JMSException - for any internal provider error

cleanup

public void cleanup(boolean stop)
             throws javax.jms.JMSException

Release any resources used by the provider

Parameters:

stop - if true stop the provider. This argument may be ignored by implementors.

Throws:

javax.jms.JMSException - for any internal provider error