/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.geronimo.tomcat;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.geronimo.gbean.AbstractName;
import org.apache.geronimo.gbean.AbstractNameQuery;
import org.apache.geronimo.gbean.GBeanData;
import org.apache.geronimo.gbean.GBeanInfo;
import org.apache.geronimo.gbean.GBeanInfoBuilder;
import org.apache.geronimo.gbean.ReferencePatterns;
import org.apache.geronimo.j2ee.j2eeobjectnames.NameFactory;
import org.apache.geronimo.kernel.GBeanNotFoundException;
import org.apache.geronimo.kernel.Kernel;
import org.apache.geronimo.kernel.config.ConfigurationUtil;
import org.apache.geronimo.kernel.config.EditableConfigurationManager;
import org.apache.geronimo.kernel.config.InvalidConfigException;
import org.apache.geronimo.kernel.proxy.ProxyManager;
import org.apache.geronimo.management.geronimo.NetworkConnector;
import org.apache.geronimo.management.geronimo.WebAccessLog;
import org.apache.geronimo.management.geronimo.WebConnector;
import org.apache.geronimo.management.geronimo.WebContainer;
import org.apache.geronimo.management.geronimo.WebManager;
import org.apache.geronimo.system.serverinfo.ServerInfo;
/**
* Tomcat implementation of the WebManager management API. Knows how to
* manipulate other Tomcat objects for management purposes.
*
* @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
*/
public class TomcatManagerImpl implements WebManager {
private final static Log log = LogFactory.getLog(TomcatManagerImpl.class);
private final Kernel kernel;
public TomcatManagerImpl(Kernel kernel) {
this.kernel = kernel;
}
public String getProductName() {
return "Tomcat";
}
/**
* Creates and returns a new connector. Note that the connector may well
* require further customization before being fully functional (e.g. SSL
* settings for a secure connector). This may need to be done before
* starting the resulting connector.
*
* @param container The container to add the connector to
* @param uniqueName A name fragment that's unique to this connector
* @param protocol The protocol that the connector should use
* @param host The host name or IP that the connector should listen on
* @param port The port that the connector should listen on
*/
public WebConnector addConnector(WebContainer container, String uniqueName, String protocol, String host, int port) {
AbstractName containerName = kernel.getAbstractNameFor(container);
AbstractName name = kernel.getNaming().createSiblingName(containerName, uniqueName, NameFactory.GERONIMO_SERVICE);
GBeanData connector;
if(protocol.equals(PROTOCOL_HTTP)) {
connector = new GBeanData(name, ConnectorGBean.GBEAN_INFO);
} else if(protocol.equals(PROTOCOL_HTTPS)) {
connector = new GBeanData(name, HttpsConnectorGBean.GBEAN_INFO);
AbstractNameQuery query = new AbstractNameQuery(ServerInfo.class.getName());
Set set = kernel.listGBeans(query);
connector.setReferencePattern("ServerInfo", (AbstractName)set.iterator().next());
//todo: default HTTPS settings
} else if(protocol.equals(PROTOCOL_AJP)) {
connector = new GBeanData(name, ConnectorGBean.GBEAN_INFO);
} else {
throw new IllegalArgumentException("Invalid protocol '"+protocol+"'");
}
connector.setAttribute("protocol", protocol);
connector.setAttribute("host", host);
connector.setAttribute("port", new Integer(port));
connector.setAttribute("maxThreads", new Integer(50));
connector.setAttribute("acceptQueueSize", new Integer(100));
connector.setReferencePattern(ConnectorGBean.CONNECTOR_CONTAINER_REFERENCE, containerName);
connector.setAttribute("name", uniqueName);
EditableConfigurationManager mgr = ConfigurationUtil.getEditableConfigurationManager(kernel);
if(mgr != null) {
try {
mgr.addGBeanToConfiguration(containerName.getArtifact(), connector, false);
return (WebConnector) kernel.getProxyManager().createProxy(name, TomcatWebConnector.class.getClassLoader());
} catch (InvalidConfigException e) {
log.error("Unable to add GBean", e);
return null;
} finally {
ConfigurationUtil.releaseConfigurationManager(kernel, mgr);
}
} else {
log.warn("The ConfigurationManager in the kernel does not allow editing");
return null;
}
}
/**
* Gets the network containers.
*/
public Object[] getContainers() {
ProxyManager proxyManager = kernel.getProxyManager();
AbstractNameQuery query = new AbstractNameQuery(TomcatWebContainer.class.getName());
Set names = kernel.listGBeans(query);
TomcatWebContainer[] results = new TomcatWebContainer[names.size()];
int i=0;
for (Iterator it = names.iterator(); it.hasNext(); i++) {
AbstractName name = (AbstractName) it.next();
results[i] = (TomcatWebContainer) proxyManager.createProxy(name, TomcatWebContainer.class.getClassLoader());
}
return results;
}
/**
* Gets the protocols which this container can configure connectors for.
*/
public String[] getSupportedProtocols() {
return new String[]{PROTOCOL_HTTP, PROTOCOL_HTTPS, PROTOCOL_AJP};
}
/**
* Removes a connector. This shuts it down if necessary, and removes it from the server environment. It must be a
* connector that uses this network technology.
* @param connectorName
*/
public void removeConnector(AbstractName connectorName) {
try {
GBeanInfo info = kernel.getGBeanInfo(connectorName);
boolean found = false;
Set intfs = info.getInterfaces();
for (Iterator it = intfs.iterator(); it.hasNext();) {
String intf = (String) it.next();
if (intf.equals(TomcatWebConnector.class.getName())) {
found = true;
}
}
if (!found) {
throw new GBeanNotFoundException(connectorName);
}
EditableConfigurationManager mgr = ConfigurationUtil.getEditableConfigurationManager(kernel);
if(mgr != null) {
try {
mgr.removeGBeanFromConfiguration(connectorName.getArtifact(), connectorName);
} catch (InvalidConfigException e) {
log.error("Unable to add GBean", e);
} finally {
ConfigurationUtil.releaseConfigurationManager(kernel, mgr);
}
} else {
log.warn("The ConfigurationManager in the kernel does not allow editing");
}
} catch (GBeanNotFoundException e) {
log.warn("No such GBean '" + connectorName + "'"); //todo: what if we want to remove a failed GBean?
} catch (Exception e) {
log.error(e);
}
}
/**
* Gets the ObjectNames of any existing connectors for this network technology for the specified protocol.
*
* @param protocol A protocol as returned by getSupportedProtocols
*/
public NetworkConnector[] getConnectors(String protocol) {
if(protocol == null) {
return getConnectors();
}
List result = new ArrayList();
ProxyManager proxyManager = kernel.getProxyManager();
AbstractNameQuery query = new AbstractNameQuery(TomcatWebConnector.class.getName());
Set names = kernel.listGBeans(query);
for (Iterator it = names.iterator(); it.hasNext();) {
AbstractName name = (AbstractName) it.next();
try {
if (kernel.getAttribute(name, "protocol").equals(protocol)) {
result.add(proxyManager.createProxy(name, TomcatWebConnector.class.getClassLoader()));
}
} catch (Exception e) {
log.error("Unable to check the protocol for a connector", e);
}
}
return (TomcatWebConnector[]) result.toArray(new TomcatWebConnector[names.size()]);
}
public WebAccessLog getAccessLog(WebContainer container) {
AbstractNameQuery query = new AbstractNameQuery(TomcatLogManager.class.getName());
Set names = kernel.listGBeans(query);
if(names.size() == 0) {
return null;
} else if(names.size() > 1) {
throw new IllegalStateException("Should not be more than one Tomcat access log manager");
}
return (WebAccessLog) kernel.getProxyManager().createProxy((AbstractName)names.iterator().next(), TomcatLogManager.class.getClassLoader());
}
/**
* Gets the ObjectNames of any existing connectors associated with this network technology.
*/
public NetworkConnector[] getConnectors() {
ProxyManager proxyManager = kernel.getProxyManager();
AbstractNameQuery query = new AbstractNameQuery(TomcatWebConnector.class.getName());
Set names = kernel.listGBeans(query);
TomcatWebConnector[] results = new TomcatWebConnector[names.size()];
int i=0;
for (Iterator it = names.iterator(); it.hasNext(); i++) {
AbstractName name = (AbstractName) it.next();
results[i] = (TomcatWebConnector) proxyManager.createProxy(name, TomcatWebConnector.class.getClassLoader());
}
return results;
}
/**
* Gets the ObjectNames of any existing connectors for the specified container for the specified protocol.
*
* @param protocol A protocol as returned by getSupportedProtocols
*/
public NetworkConnector[] getConnectorsForContainer(Object container, String protocol) {
if(protocol == null) {
return getConnectorsForContainer(container);
}
AbstractName containerName = kernel.getAbstractNameFor(container);
ProxyManager mgr = kernel.getProxyManager();
try {
List results = new ArrayList();
AbstractNameQuery query = new AbstractNameQuery(TomcatWebConnector.class.getName());
Set set = kernel.listGBeans(query); // all Tomcat connectors
for (Iterator it = set.iterator(); it.hasNext();) {
AbstractName name = (AbstractName) it.next(); // a single Tomcat connector
GBeanData data = kernel.getGBeanData(name);
ReferencePatterns refs = data.getReferencePatterns(ConnectorGBean.CONNECTOR_CONTAINER_REFERENCE);
if(containerName.equals(refs.getAbstractName())) {
try {
String testProtocol = (String) kernel.getAttribute(name, "protocol");
if(testProtocol != null && testProtocol.equals(protocol)) {
results.add(mgr.createProxy(name, TomcatWebConnector.class.getClassLoader()));
}
} catch (Exception e) {
log.error("Unable to look up protocol for connector '"+name+"'",e);
}
break;
}
}
return (TomcatWebConnector[]) results.toArray(new TomcatWebConnector[results.size()]);
} catch (Exception e) {
throw (IllegalArgumentException)new IllegalArgumentException("Unable to look up connectors for Tomcat container '"+containerName +"': ").initCause(e);
}
}
/**
* Gets the ObjectNames of any existing connectors for the specified container.
*/
public NetworkConnector[] getConnectorsForContainer(Object container) {
AbstractName containerName = kernel.getAbstractNameFor(container);
ProxyManager mgr = kernel.getProxyManager();
try {
List results = new ArrayList();
AbstractNameQuery query = new AbstractNameQuery(TomcatWebConnector.class.getName());
Set set = kernel.listGBeans(query); // all Tomcat connectors
for (Iterator it = set.iterator(); it.hasNext();) {
AbstractName name = (AbstractName) it.next(); // a single Tomcat connector
GBeanData data = kernel.getGBeanData(name);
ReferencePatterns refs = data.getReferencePatterns(ConnectorGBean.CONNECTOR_CONTAINER_REFERENCE);
if (containerName.equals(refs.getAbstractName())) {
results.add(mgr.createProxy(name, TomcatWebConnector.class.getClassLoader()));
}
}
return (TomcatWebConnector[]) results.toArray(new TomcatWebConnector[results.size()]);
} catch (Exception e) {
throw (IllegalArgumentException) new IllegalArgumentException("Unable to look up connectors for Tomcat container '"+containerName).initCause(e);
}
}
public static final GBeanInfo GBEAN_INFO;
static {
GBeanInfoBuilder infoFactory = GBeanInfoBuilder.createStatic("Tomcat Web Manager", TomcatManagerImpl.class);
infoFactory.addAttribute("kernel", Kernel.class, false);
infoFactory.addInterface(WebManager.class);
infoFactory.setConstructor(new String[] {"kernel"});
GBEAN_INFO = infoFactory.getBeanInfo();
}
public static GBeanInfo getGBeanInfo() {
return GBEAN_INFO;
}
}