001    /**
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    package org.apache.geronimo.management.geronimo;
018    
019    import org.apache.geronimo.gbean.AbstractName;
020    
021    /**
022     * Main entry point for managing a particular JMS implementation.  The manager
023     * has features to access JMS brokers (aka servers or containers) as well as
024     * JMS connectors (aka network listeners).  Each manager should handle all
025     * the brokers and connectors for a single JMS implementation; if the Geronimo
026     * server has multiple JMS implementations available then there should be one
027     * JMSManager instance for each.
028     *
029     * @version $Rev: 706640 $ $Date: 2008-10-21 14:44:05 +0000 (Tue, 21 Oct 2008) $
030     */
031    public interface JMSManager extends NetworkManager {
032        /**
033         * Creates a new connector, and returns the ObjectName for it.  Note that
034         * the connector may well require further customization before being fully
035         * functional (e.g. SSL settings for a secure connector).
036         *
037         * @param broker      The broker to add the connector for
038         * @param uniqueName  A name fragment that's unique to this connector
039         * @param protocol    The protocol the connector should be configured for
040         * @param host        The listen host/IP for the connector
041         * @param port        The listen port for the connector
042         *
043         * @return The newly added connector.  It will be valid (loaded) but not
044         *         started.
045         */
046        public JMSConnector addConnector(JMSBroker broker, String uniqueName, String protocol, String host, int port);
047    }