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 java.util.Map;
020    
021    /**
022     * Specialization of NetworkManager for web containers.
023     *
024     * @version $Rev: 487175 $ $Date: 2006-12-14 03:10:31 -0800 (Thu, 14 Dec 2006) $
025     */
026    public interface WebManager extends NetworkManager {
027        public final static String PROTOCOL_HTTP = "HTTP";
028        public final static String PROTOCOL_HTTPS = "HTTPS";
029        public final static String PROTOCOL_AJP = "AJP";
030    
031        /**
032         * Creates and returns a new web connector.  Note that the connector may
033         * well require further customization before being fully functional (e.g.
034         * SSL settings for a secure connector).  This may need to be done before
035         * starting the resulting connector.
036         *
037         * @param container    The container to add the connector to
038         * @param uniqueName   A name fragment that's unique to this connector
039         * @param protocol     The protocol that the connector should use
040         * @param host         The host name or IP that the connector should listen on
041         * @param port         The port that the connector should listen on
042         *
043         * @return The ObjectName of the new connector.
044         */
045        public WebConnector addConnector(WebContainer container, String uniqueName, String protocol, String host, int port);
046    
047        /**
048         * Gets the WebAccessLog implementation for a web container.
049         * May be null if the access log cannot be managed.
050         *
051         * @param container The container whose access log is interesting
052         *
053         */
054        public WebAccessLog getAccessLog(WebContainer container);
055    }