org.jboss.arquillian.container.tomcat.CommonTomcatConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arquillian-tomcat-common Show documentation
There is a newer version: 1.2.2.Final
Show newest version
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011 Red Hat Inc. and/or its affiliates and other contributors
 * as indicated by the @authors tag. All rights reserved.
 * See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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.jboss.arquillian.container.tomcat;

import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;

import org.jboss.arquillian.container.spi.ConfigurationException;
import org.jboss.arquillian.container.spi.client.container.ContainerConfiguration;

/**
 * Arquillian Tomcat Container Configuration
 *
 * @author Karel Piwko
 * @author Juraj Huska
 * @version $Revision: $
 */
public class CommonTomcatConfiguration implements ContainerConfiguration
{

   private static final int MIN_PORT = 0;

   private static final int MAX_PORT = 65535;

   private String bindAddress = "localhost";

   private int bindHttpPort = 8080;

   private String user;

   private String pass;

   private int jmxPort = 8089;

   private String jmxVirtualHost = "localhost";

   private String urlCharset = "ISO-8859-1";

   private String appBase = "webapps";

   private boolean unpackArchive = false;

   private URI jmxUri;

   private URL managerUrl;

   @Override
   public void validate() throws ConfigurationException
   {
      Validate.notNullOrEmpty(bindAddress, "Bind address must not be null or empty");
      Validate.isInRange(jmxPort, 0, MAX_PORT, "JMX port must be in interval ]" + MIN_PORT + "," + MAX_PORT + "[, but was " + jmxPort);

      try
      {
         this.setJmxUri(createJmxUri());
         this.setManagerUrl(createManagerUrl());
      }
      catch (URISyntaxException ex)
      {
         throw new ConfigurationException("JMX URI is not valid, please provide ", ex);
      }
      catch (MalformedURLException e)
      {
         throw new ConfigurationException("JMX URI is not valid", e);
      }
   }

   public String getBindAddress()
   {
      return bindAddress;
   }

   public void setBindAddress(String bindAddress)
   {
      this.bindAddress = bindAddress;
   }

   public int getBindHttpPort()
   {
      return bindHttpPort;
   }

   /**
    * Set the HTTP bind port.
    *
    * @param httpBindPort HTTP bind port
    */
   public void setBindHttpPort(int bindHttpPort)
   {
      this.bindHttpPort = bindHttpPort;
   }

   public String getUser()
   {
      return user;
   }

   public void setUser(String user)
   {
      this.user = user;
   }

   public String getPass()
   {
      return pass;
   }

   public void setPass(String pass)
   {
      this.pass = pass;
   }

   public int getJmxPort()
   {
      return jmxPort;
   }

   public void setJmxPort(int jmxPort)
   {
      this.jmxPort = jmxPort;
   }

   public String getAppBase()
   {
      return appBase;
   }

   /**
    * @param appBase the directory where the deployed webapps are stored within the Tomcat installation
    */
   public void setAppBase(String appBase)
   {
      this.appBase = appBase;
   }

   /**
    * @return a switch indicating whether the WAR should be unpacked
    */
   public boolean isUnpackArchive()
   {
      return unpackArchive;
   }

   /**
    * Sets the WAR to be unpacked into the java.io.tmpdir when deployed. Unpacking is required if you are using Weld to provide
    * CDI support in a servlet environment.
    *
    * @param a switch indicating whether the WAR should be unpacked
    */
   public void setUnpackArchive(boolean unpackArchive)
   {
      this.unpackArchive = unpackArchive;
   }

   /**
    * @param urlCharset the urlCharset to set
    */
   public void setUrlCharset(String urlCharset)
   {
      this.urlCharset = urlCharset;
   }

   /**
    * @return the urlCharset
    */
   public String getUrlCharset()
   {
      return urlCharset;
   }

   /**
    * @param jmxVirtualHost the jmxVirtualHost to set
    */
   public void setJmxVirtualHost(String jmxVirtualHost)
   {
      this.jmxVirtualHost = jmxVirtualHost;
   }

   /**
    * @return the jmxVirtualHost
    */
   public String getJmxVirtualHost()
   {
      return jmxVirtualHost;
   }

   /**
    * @param jmxUri the jmxUri to set
    */
   public void setJmxUri(URI jmxUri)
   {
      this.jmxUri = jmxUri;
   }

   /**
    * @return the jmxUri
    */
   public URI getJmxUri()
   {
      return jmxUri;
   }

   /**
    * @param managerUrl the managerUrl to set
    */
   public void setManagerUrl(URL managerUrl)
   {
      this.managerUrl = managerUrl;
   }

   /**
    * @return the managerUrl
    */
   public URL getManagerUrl()
   {
      return managerUrl;
   }

   protected URI createJmxUri() throws URISyntaxException
   {
      final String template = "service:jmx:rmi:///jndi/rmi://%s:%d/jmxrmi";

      return new URI(String.format(template, bindAddress, jmxPort));
   }

   protected URL createManagerUrl() throws MalformedURLException
   {
      final String template = "http://%s:%d/manager";

      return new URL(String.format(template, bindAddress, bindHttpPort));
   }

}