psiprobe.TomcatContainer Maven / Gradle / Ivy

Go to download
/*
 * Licensed under the GPL License. You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 *
 * THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */
package psiprobe;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;

import javax.naming.NamingException;

import org.apache.catalina.Context;
import org.apache.catalina.Wrapper;
import org.apache.catalina.connector.Connector;

import psiprobe.model.ApplicationParam;
import psiprobe.model.ApplicationResource;
import psiprobe.model.FilterInfo;
import psiprobe.model.FilterMapping;
import psiprobe.model.jsp.Summary;

/**
 * Part of Tomcat container version abstraction layer.
 */
public interface TomcatContainer {

  /**
   * Finds a context based on its path.
   *
   * @param name the context path
   *
   * @return the context deployed to that path
   */
  Context findContext(String name);

  /**
   * Formats a context name to a path that the container will recognize. Usually this means
   * prepending a {@code /} character, although there is special behavior for the root context.
   *
   * @param name the context name
   *
   * @return the context name formatted as the container expects
   */
  String formatContextName(String name);

  /**
   * Formats a context name so that it can be used as a step for the context descriptor .xml or
   * deployed .war file. Usually this means stripping a leading {@code /} character, although there
   * is special behavior for the root context.
   *
   * @param contextName the context name
   *
   * @return the filename stem for this context
   */
  String formatContextFilename(String contextName);

  /**
   * Find contexts.
   *
   * @return all contexts
   */
  List findContexts();

  /**
   * Find connectors.
   *
   * @return all connectors
   */
  List findConnectors();

  /**
   * Stops the context with the given name.
   *
   * @param name the name of the context to stop
   *
   * @throws Exception if stopping the context fails spectacularly
   */
  void stop(String name) throws Exception;

  /**
   * Starts the context with the given name.
   *
   * @param name the name of the context to start
   *
   * @throws Exception if starting the context fails spectacularly
   */
  void start(String name) throws Exception;

  /**
   * Undeploys a context.
   *
   * @param name the context path
   *
   * @throws Exception if undeployment fails spectacularly
   */
  void remove(String name) throws Exception;

  /**
   * Installs .war file at the given context name.
   *
   * @param name the name of the context
   *
   * @throws Exception if installing the .war fails spectacularly
   */
  void installWar(String name) throws Exception;

  /**
   * This method always returns absolute path, no matter what Tomcat is up to.
   *
   * @return absolute path to applications base (normally "webapps")
   */
  File getAppBase();

  /**
   * Returns the context descriptor filename for the given context.
   *
   * @param context the context
   *
   * @return the context descriptor filename, or {@code null}
   */
  File getConfigFile(Context context);

  /**
   * Gets the config base.
   *
   * @return the config base
   */
  String getConfigBase();

  /**
   * Sets the wrapper.
   *
   * @param wrapper the new wrapper
   */
  void setWrapper(Wrapper wrapper);

  /**
   * Indicates whether this adapter can bind to the container.
   *
   * @param binding the ServerInfo of the container
   *
   * @return true if binding is possible
   */
  boolean canBoundTo(String binding);

  /**
   * Deploys a context, assuming an context descriptor file exists on the server already.
   *
   * @param contextName the context path, which should match the filename
   *
   * @return {@code true} if deployment was successful
   *
   * @throws Exception if deployment fails spectacularly
   */
  boolean installContext(String contextName) throws Exception;

  /**
   * Lists and optionally compiles all JSPs for the given context. Compilation details are added to
   * the summary.
   *
   * @param context the context
   * @param summary the summary in which the output is stored
   * @param compile whether to compile all of the JSPs or not
   */
  void listContextJsps(Context context, Summary summary, boolean compile);

  /**
   * Compiles a list of JSPs. Names of JSP files are expected to be relative to the webapp root. The
   * method updates summary with compilation details.
   *
   * @param context the context
   * @param summary the summary in which the output is stored
   * @param names the list of JSPs to compile
   */
  void recompileJsps(Context context, Summary summary, List names);

  /**
   * Deletes the "work" directory of the given context.
   *
   * @param context the context
   */
  void discardWorkDir(Context context);

  /**
   * Gets the host name.
   *
   * @return the host name
   */
  String getHostName();

  /**
   * Gets the name.
   *
   * @return the name
   */
  String getName();

  /**
   * Returns the JSP servlet filename for the given JSP file.
   *
   * @param context the context
   * @param jspName the JSP filename
   *
   * @return the name of the JSP servlet
   */
  String getServletFileNameForJsp(Context context, String jspName);

  /**
   * Gets the application filter maps.
   *
   * @param context the context
   *
   * @return the application filter maps
   */
  List getApplicationFilterMaps(Context context);

  /**
   * Gets the available.
   *
   * @param context the context
   *
   * @return the available
   */
  boolean getAvailable(Context context);

  /**
   * Adds the context resource.
   *
   * @param context the context
   * @param resourceList the resource list
   */
  void addContextResource(Context context, List resourceList);

  /**
   * Adds the context resource link.
   *
   * @param context the context
   * @param resourceList the resource list
   */
  void addContextResourceLink(Context context, List resourceList);

  /**
   * Gets the application filters.
   *
   * @param context the context
   *
   * @return the application filters
   */
  List getApplicationFilters(Context context);

  /**
   * Gets the application init params.
   *
   * @param context the context
   *
   * @return the application init params
   */
  List getApplicationInitParams(Context context);

  /**
   * Resource exists.
   *
   * @param name the name
   * @param context the context
   *
   * @return true, if successful
   */
  boolean resourceExists(String name, Context context);

  /**
   * Gets the resource stream.
   *
   * @param name the name
   * @param context the context
   *
   * @return the resource stream
   *
   * @throws IOException Signals that an I/O exception has occurred.
   */
  InputStream getResourceStream(String name, Context context) throws IOException;

  /**
   * Gets the resource attributes.
   *
   * @param name the name
   * @param context the context
   *
   * @return the resource attributes
   */
  Long[] getResourceAttributes(String name, Context context);

  /**
   * Binds a naming context to the current thread's classloader.
   *
   * @param context the catalina context
   *
   * @throws NamingException if binding the classloader fails
   */
  void bindToContext(Context context) throws NamingException;

  /**
   * Unbinds a naming context from the current thread's classloader.
   *
   * @param context the catalina context
   *
   * @throws NamingException if unbinding the classloader fails
   */
  void unbindFromContext(Context context) throws NamingException;
}