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.activemq.web.config;
018    
019    import java.util.Collection;
020    
021    import javax.jms.ConnectionFactory;
022    import javax.management.remote.JMXServiceURL;
023    
024    /**
025     * The configuration used for the web console.
026     * 
027     * 
028     */
029    public interface WebConsoleConfiguration {
030    
031            /**
032             * The connection factory to use for sending/receiving messages.
033             * 
034             * @return not <code>null</code>
035             */
036            ConnectionFactory getConnectionFactory();
037    
038            /**
039             * The URL to the JMX connectors of the broker. The names of any failover
040             * (master-slave configuration) must also be specified.
041             * 
042             * @return not <code>null</code>, must contain at least one entry
043             */
044            Collection<JMXServiceURL> getJmxUrls();
045    
046            /**
047             * The user that is used in case of authenticated JMX connections. The user
048             * must be the same for all the brokers.
049             * 
050             * @return <code>null</code> if no authentication should be used.
051             */
052            String getJmxUser();
053    
054            /**
055             * Password for the JMX-user.
056             * 
057             * @see #getJmxUser()
058             * @return <code>null</code> if no authentication
059             */
060            String getJmxPassword();
061    
062    }