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: import java.util.Map;
26:
27: /**
28: * @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
29: * @version $Revision: 8784 $
30: * @since 2.6
31: */
32: public interface RegistrationPersistenceManager {
33: /**
34: * Creates a Consumer with the specified identity and name (which might be the same, depending on the policy)
35: *
36: * @param consumerId
37: * @param consumerName
38: */
39: Consumer createConsumer(String consumerId, String consumerName)
40: throws RegistrationException;
41:
42: /**
43: * Retrieves the ConsumerGroup identified by the specified name.
44: *
45: * @param name the name of the group to be retrieved
46: * @return the ConsumerGroup identified by the specified name
47: * @throws RegistrationException
48: */
49: ConsumerGroup getConsumerGroup(String name)
50: throws RegistrationException;
51:
52: /**
53: * Creates a new ConsumerGroup with the associated name.
54: *
55: * @param name the name of the ConsumerGroup to be created
56: * @return a new ConsumerGroup with the associated name
57: * @throws RegistrationException
58: */
59: ConsumerGroup createConsumerGroup(String name)
60: throws RegistrationException;
61:
62: void removeConsumerGroup(String name) throws RegistrationException;
63:
64: void removeConsumer(String consumerId) throws RegistrationException;
65:
66: void removeRegistration(String registrationId)
67: throws RegistrationException;
68:
69: /**
70: * Return an existing consumer from its id.
71: *
72: * @param consumerId the consumer id
73: * @return the consumer or null if it does not exist
74: * @throws IllegalArgumentException if the consumer id argument is null
75: * @throws RegistrationException
76: */
77: Consumer getConsumerById(String consumerId)
78: throws IllegalArgumentException, RegistrationException;
79:
80: Registration addRegistrationFor(String consumerId,
81: Map registrationProperties) throws RegistrationException;
82:
83: Collection getConsumerGroups();
84:
85: Registration getRegistration(String registrationId);
86:
87: Consumer addConsumerToGroupNamed(String consumerId, String groupName)
88: throws RegistrationException;
89:
90: Collection getConsumers();
91:
92: Collection getRegistrations();
93: }
|