1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact tma@netspace.net.au.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2001-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: Provider.java,v 1.2 2004/02/02 03:50:09 tanderson Exp $
44 */
45 package org.exolab.jmscts.provider;
46
47 import javax.jms.JMSException;
48
49
50 /***
51 * This interface specifies methods for accessing a JMS provider.
52 *
53 * @version $Revision: 1.2 $ $Date: 2004/02/02 03:50:09 $
54 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
55 * @see Administrator
56 */
57 public interface Provider {
58
59 /***
60 * Perform any initialisation required prior to using the JMS provider
61 *
62 * @param start if true start the provider. This argument may be ignored
63 * by implementors.
64 * @throws JMSException if the initialisation cannot be performed
65 */
66 void initialise(boolean start) throws JMSException;
67
68 /***
69 * Returns the administration interface
70 *
71 * @return the administration interface
72 * @throws JMSException for any internal provider error
73 */
74 Administrator getAdministrator() throws JMSException;
75
76 /***
77 * Release any resources used by the provider
78 *
79 * @param stop if true stop the provider. This argument may be ignored by
80 * implementors.
81 * @throws JMSException for any internal provider error
82 */
83 void cleanup(boolean stop) throws JMSException;
84
85 }
This page was automatically generated by Maven