001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.mq.sm;
023:
024: import java.util.Collection;
025: import javax.jms.JMSException;
026: import org.jboss.mq.SpyTopic;
027: import org.jboss.mq.DurableSubscriptionID;
028: import org.jboss.mq.server.JMSDestinationManager;
029:
030: /**
031: * Interface for StateManager.
032: *
033: * A StateManager is a manager that manages states that has to do with clients/
034: * users and durable subscription.
035: *
036: * A state manager most know how to persist information regarding durable
037: * subscriptions.
038: *
039: * It should also hold all current clientID's that are connected to the server.
040: *
041: * It may also support basic autentication, which is what the old
042: * default StateManager did.
043: *
044: * @author <a href="pra@tim.se">Peter Antman</a>
045: * @author <a href="Norbert.Lataille@m4x.org">Norbert Lataille</a>
046: * @author <a href="hiram.chirino@jboss.org">Hiram Chirino</a>
047: * @version $Revision: 57198 $
048: */
049:
050: public interface StateManager {
051:
052: /**
053: * Ad, change or delete a durable subsciption.
054: *
055: * The contract is that the StateManager, must physically create the durable
056: * subscription. And when the method returns the information must be persisted.
057: *
058: *
059: * @param server The JMSServer
060: * @param sub The id of the durable subscription
061: * @param topic The topic to subscribe durable on, if null
062: * the subscription will be removed.
063: * @exception JMSException Description of Exception
064: */
065: public void setDurableSubscription(JMSDestinationManager server,
066: DurableSubscriptionID sub, SpyTopic topic)
067: throws JMSException;
068:
069: /**
070: * Get the destination a subscription is for.
071: */
072: public SpyTopic getDurableTopic(DurableSubscriptionID sub)
073: throws JMSException;
074:
075: /**
076: * Check if a user has a preconfigured clientID and return it.
077: *
078: * If the user has a preconfigured clienID it will be added to the current
079: * logged in clientID's and returned.
080: *
081: * The state manager may also use this method to authenticate a user.
082: * If a SecurityManager is installed this is not necesarry.
083: *
084: * @param login user name
085: * @param passwd password
086: * @return a preconfigured clientID.
087: * @exception JMSException if the user
088: * @exception JMSSecurityException if the clientID is already loged in.
089: */
090: public String checkUser(String login, String passwd)
091: throws JMSException;
092:
093: /**
094: * Ad a logged in clientID to the statemanager.
095: *
096: * The clientID must not be active.
097: *
098: * The StateManager should somehow assure that a clientID that is
099: * preconfigured for a user is not allowed to be added this way.
100: *
101: * @param ID a clientID
102: * @exception JMSException Description of Exception
103: * @exception InvalidClientIDException if the clientID wass already logged in.
104: */
105: public void addLoggedOnClientId(String ID) throws JMSException;
106:
107: /**
108: * Remove the logged in clientID.
109: *
110: * @param ID clientID.
111: */
112: public void removeLoggedOnClientId(String ID);
113:
114: /**
115: * Get all configured durable subscriptions for a particular topic.
116: *
117: * @param topic the topic.
118: * @return a collection of DurableSubscriptionID
119: * @exception JMSException Description of Exception
120: */
121: public Collection getDurableSubscriptionIdsForTopic(SpyTopic topic)
122: throws JMSException;
123: } // StateManager
|