View Javadoc

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 info@exolab.org.
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 2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: Services.java,v 1.1 2005/08/30 04:56:14 tanderson Exp $
44   */
45  
46  package org.exolab.jms.service;
47  
48  /***
49   * A <code>Serviceable</code> which manages a collection of services.
50   * <p/>
51   * A service may be any object. If it implements the {@link Serviceable}
52   * interface, then its lifecycle will be managed by this.
53   * <p/>
54   * Services may be registered using their class types, or instances.
55   * Only a single instance of a particular service may exist at any time.
56   * <p/>
57   * Services that are registered using their class types will be created
58   * when first accessed via {@link #getService}. This will recursively resolve
59   * any other services that the service is dependent on.
60   *
61   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
62   * @version $Revision: 1.1 $ $Date: 2005/08/30 04:56:14 $
63   */
64  public interface Services extends Serviceable {
65  
66      /***
67       * Add a service of the specified type.
68       * <p/>
69       * The service will be constructed when it is first accessed via
70       * {@link #getService}.
71       *
72       * @param type the type of the service
73       * @throws ServiceAlreadyExistsException if the service already exists
74       * @throws ServiceException for any service error
75       */
76      void addService(Class type) throws ServiceException;
77  
78      /***
79       * Add a service instance.
80       *
81       * @param service the service instance
82       * @throws ServiceAlreadyExistsException if the service already exists
83       * @throws ServiceException for any service error
84       */
85      void addService(Object service) throws ServiceException;
86  
87      /***
88       * Returns a service given its type.
89       * <p/>
90       * If the service has been registered but not constructed, it will be
91       * created and any setters populated.
92       *
93       * @param type the type of the service
94       * @return an instance of <code>type</code>
95       * @throws ServiceDoesNotExistException if the service doesn't exist, or
96       * is dependent on a service which doesn't exist
97       * @throws ServiceException for any service error
98       */
99      Object getService(Class type) throws ServiceException;
100 
101 }