| /* |
| * Copyright 2002,2004 The Apache Software Foundation. |
| * |
| * Licensed 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.catalina.mbeans; |
| |
| import java.util.ArrayList; |
| |
| import javax.management.MBeanException; |
| import javax.management.MalformedObjectNameException; |
| import javax.management.ObjectName; |
| import javax.management.RuntimeOperationsException; |
| |
| import org.apache.catalina.deploy.ContextEnvironment; |
| import org.apache.catalina.deploy.ContextResource; |
| import org.apache.catalina.deploy.ContextResourceLink; |
| import org.apache.catalina.deploy.NamingResources; |
| import org.apache.commons.modeler.BaseModelMBean; |
| import org.apache.commons.modeler.ManagedBean; |
| import org.apache.commons.modeler.Registry; |
| import org.apache.tomcat.util.compat.JdkCompat; |
| |
| /** |
| * <p>A <strong>ModelMBean</strong> implementation for the |
| * <code>org.apache.catalina.deploy.NamingResources</code> component.</p> |
| * |
| * @author Amy Roh |
| * @version $Revision$ $Date$ |
| */ |
| |
| public class NamingResourcesMBean extends BaseModelMBean { |
| |
| |
| // ----------------------------------------------------------- Constructors |
| |
| |
| /** |
| * Construct a <code>ModelMBean</code> with default |
| * <code>ModelMBeanInfo</code> information. |
| * |
| * @exception MBeanException if the initializer of an object |
| * throws an exception |
| * @exception RuntimeOperationsException if an IllegalArgumentException |
| * occurs |
| */ |
| public NamingResourcesMBean() |
| throws MBeanException, RuntimeOperationsException { |
| |
| super(); |
| |
| } |
| |
| |
| // ----------------------------------------------------- Class Variables |
| |
| |
| /** |
| * JDK compatibility support |
| */ |
| private static final JdkCompat jdkCompat = JdkCompat.getJdkCompat(); |
| |
| |
| // ----------------------------------------------------- Instance Variables |
| |
| /** |
| * The configuration information registry for our managed beans. |
| */ |
| protected Registry registry = MBeanUtils.createRegistry(); |
| |
| |
| /** |
| * The <code>ManagedBean</code> information describing this MBean. |
| */ |
| protected ManagedBean managed = |
| registry.findManagedBean("NamingResources"); |
| |
| // ------------------------------------------------------------- Attributes |
| |
| |
| /** |
| * Return the MBean Names of the set of defined environment entries for |
| * this web application |
| */ |
| public String[] getEnvironments() { |
| ContextEnvironment[] envs = |
| ((NamingResources)this.resource).findEnvironments(); |
| ArrayList results = new ArrayList(); |
| for (int i = 0; i < envs.length; i++) { |
| try { |
| ObjectName oname = |
| MBeanUtils.createObjectName(managed.getDomain(), envs[i]); |
| results.add(oname.toString()); |
| } catch (MalformedObjectNameException e) { |
| IllegalArgumentException iae = new IllegalArgumentException |
| ("Cannot create object name for environment " + envs[i]); |
| jdkCompat.chainException(iae, e); |
| throw iae; |
| } |
| } |
| return ((String[]) results.toArray(new String[results.size()])); |
| |
| } |
| |
| |
| /** |
| * Return the MBean Names of all the defined resource references for this |
| * application. |
| */ |
| public String[] getResources() { |
| |
| ContextResource[] resources = |
| ((NamingResources)this.resource).findResources(); |
| ArrayList results = new ArrayList(); |
| for (int i = 0; i < resources.length; i++) { |
| try { |
| ObjectName oname = |
| MBeanUtils.createObjectName(managed.getDomain(), resources[i]); |
| results.add(oname.toString()); |
| } catch (MalformedObjectNameException e) { |
| IllegalArgumentException iae = new IllegalArgumentException |
| ("Cannot create object name for resource " + resources[i]); |
| jdkCompat.chainException(iae, e); |
| throw iae; |
| } |
| } |
| return ((String[]) results.toArray(new String[results.size()])); |
| |
| } |
| |
| |
| /** |
| * Return the MBean Names of all the defined resource link references for |
| * this application. |
| */ |
| public String[] getResourceLinks() { |
| |
| ContextResourceLink[] resourceLinks = |
| ((NamingResources)this.resource).findResourceLinks(); |
| ArrayList results = new ArrayList(); |
| for (int i = 0; i < resourceLinks.length; i++) { |
| try { |
| ObjectName oname = |
| MBeanUtils.createObjectName(managed.getDomain(), resourceLinks[i]); |
| results.add(oname.toString()); |
| } catch (MalformedObjectNameException e) { |
| IllegalArgumentException iae = new IllegalArgumentException |
| ("Cannot create object name for resource " + resourceLinks[i]); |
| jdkCompat.chainException(iae, e); |
| throw iae; |
| } |
| } |
| return ((String[]) results.toArray(new String[results.size()])); |
| |
| } |
| |
| // ------------------------------------------------------------- Operations |
| |
| |
| /** |
| * Add an environment entry for this web application. |
| * |
| * @param envName New environment entry name |
| * @param type The type of the new environment entry |
| * @param value The value of the new environment entry |
| */ |
| public String addEnvironment(String envName, String type, String value) |
| throws MalformedObjectNameException { |
| |
| NamingResources nresources = (NamingResources) this.resource; |
| if (nresources == null) { |
| return null; |
| } |
| ContextEnvironment env = nresources.findEnvironment(envName); |
| if (env != null) { |
| throw new IllegalArgumentException |
| ("Invalid environment name - already exists '" + envName + "'"); |
| } |
| env = new ContextEnvironment(); |
| env.setName(envName); |
| env.setType(type); |
| env.setValue(value); |
| nresources.addEnvironment(env); |
| |
| // Return the corresponding MBean name |
| ManagedBean managed = registry.findManagedBean("ContextEnvironment"); |
| ObjectName oname = |
| MBeanUtils.createObjectName(managed.getDomain(), env); |
| return (oname.toString()); |
| |
| } |
| |
| |
| /** |
| * Add a resource reference for this web application. |
| * |
| * @param resourceName New resource reference name |
| * @param type New resource reference type |
| */ |
| public String addResource(String resourceName, String type) |
| throws MalformedObjectNameException { |
| |
| NamingResources nresources = (NamingResources) this.resource; |
| if (nresources == null) { |
| return null; |
| } |
| ContextResource resource = nresources.findResource(resourceName); |
| if (resource != null) { |
| throw new IllegalArgumentException |
| ("Invalid resource name - already exists'" + resourceName + "'"); |
| } |
| resource = new ContextResource(); |
| resource.setName(resourceName); |
| resource.setType(type); |
| nresources.addResource(resource); |
| |
| // Return the corresponding MBean name |
| ManagedBean managed = registry.findManagedBean("ContextResource"); |
| ObjectName oname = |
| MBeanUtils.createObjectName(managed.getDomain(), resource); |
| return (oname.toString()); |
| } |
| |
| |
| /** |
| * Add a resource link reference for this web application. |
| * |
| * @param resourceLinkName New resource link reference name |
| * @param type New resource link reference type |
| */ |
| public String addResourceLink(String resourceLinkName, String type) |
| throws MalformedObjectNameException { |
| |
| NamingResources nresources = (NamingResources) this.resource; |
| if (nresources == null) { |
| return null; |
| } |
| ContextResourceLink resourceLink = |
| nresources.findResourceLink(resourceLinkName); |
| if (resourceLink != null) { |
| throw new IllegalArgumentException |
| ("Invalid resource link name - already exists'" + |
| resourceLinkName + "'"); |
| } |
| resourceLink = new ContextResourceLink(); |
| resourceLink.setName(resourceLinkName); |
| resourceLink.setType(type); |
| nresources.addResourceLink(resourceLink); |
| |
| // Return the corresponding MBean name |
| ManagedBean managed = registry.findManagedBean("ContextResourceLink"); |
| ObjectName oname = |
| MBeanUtils.createObjectName(managed.getDomain(), resourceLink); |
| return (oname.toString()); |
| } |
| |
| |
| /** |
| * Remove any environment entry with the specified name. |
| * |
| * @param envName Name of the environment entry to remove |
| */ |
| public void removeEnvironment(String envName) { |
| |
| NamingResources nresources = (NamingResources) this.resource; |
| if (nresources == null) { |
| return; |
| } |
| ContextEnvironment env = nresources.findEnvironment(envName); |
| if (env == null) { |
| throw new IllegalArgumentException |
| ("Invalid environment name '" + envName + "'"); |
| } |
| nresources.removeEnvironment(envName); |
| |
| } |
| |
| |
| /** |
| * Remove any resource reference with the specified name. |
| * |
| * @param resourceName Name of the resource reference to remove |
| */ |
| public void removeResource(String resourceName) { |
| |
| resourceName = ObjectName.unquote(resourceName); |
| NamingResources nresources = (NamingResources) this.resource; |
| if (nresources == null) { |
| return; |
| } |
| ContextResource resource = nresources.findResource(resourceName); |
| if (resource == null) { |
| throw new IllegalArgumentException |
| ("Invalid resource name '" + resourceName + "'"); |
| } |
| nresources.removeResource(resourceName); |
| |
| } |
| |
| |
| /** |
| * Remove any resource link reference with the specified name. |
| * |
| * @param resourceLinkName Name of the resource link reference to remove |
| */ |
| public void removeResourceLink(String resourceLinkName) { |
| |
| resourceLinkName = ObjectName.unquote(resourceLinkName); |
| NamingResources nresources = (NamingResources) this.resource; |
| if (nresources == null) { |
| return; |
| } |
| ContextResourceLink resourceLink = |
| nresources.findResourceLink(resourceLinkName); |
| if (resourceLink == null) { |
| throw new IllegalArgumentException |
| ("Invalid resource Link name '" + resourceLinkName + "'"); |
| } |
| nresources.removeResourceLink(resourceLinkName); |
| } |
| |
| } |
