01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.registration;
23:
24: import java.util.Collection;
25:
26: /**
27: * A business entity that is related to several consumers.
28: *
29: * @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
30: * @version $Revision: 8784 $
31: * @since 2.6
32: */
33: public interface ConsumerGroup {
34:
35: /**
36: * Return this ConsumerGroup's name (i.e. the name of the the business entity aggregating the associated consumers)
37: *
38: * @return the ConsumerGroup's name
39: */
40: String getName();
41:
42: /**
43: * Return a collection of associated consumers.
44: *
45: * @return the consumer collection
46: * @throws RegistrationException
47: */
48: Collection getConsumers() throws RegistrationException;
49:
50: /**
51: * Return the member Consumer associated with the given identifier
52: *
53: * @param consumerId
54: * @return the Consumer associated with the identity or <code>null</code> if no such Consumer is part of this
55: * ConsumerGroup
56: * @throws IllegalArgumentException if the consumer identity is null
57: * @throws RegistrationException
58: */
59: Consumer getConsumer(String consumerId)
60: throws IllegalArgumentException, RegistrationException;
61:
62: void addConsumer(Consumer consumer) throws RegistrationException;
63:
64: void removeConsumer(Consumer consumer) throws RegistrationException;
65:
66: boolean contains(Consumer consumer);
67:
68: boolean isEmpty();
69:
70: RegistrationStatus getStatus();
71:
72: void setStatus(RegistrationStatus status);
73: }
|