org.apache.tomcat.maven.plugin.tomcat6
Class AbstractCatalinaMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.tomcat.maven.plugin.tomcat6.AbstractI18NTomcat6Mojo
          extended by org.apache.tomcat.maven.plugin.tomcat6.AbstractCatalinaMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
AbstractWarCatalinaMojo, ListMojo, ResourcesMojo, RolesMojo, ServerInfoMojo

public abstract class AbstractCatalinaMojo
extends AbstractI18NTomcat6Mojo

Abstract goal that provides common configuration for Catalina-based goals.

Author:
Mark Hobson

Field Summary
 
Fields inherited from class org.apache.tomcat.maven.plugin.tomcat6.AbstractI18NTomcat6Mojo
messagesProvider, path, settings
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractCatalinaMojo()
           
 
Method Summary
 void execute()
          
protected  URL getDeployedURL()
          Gets the URL of the deployed webapp.
protected  TomcatManager getManager()
          Gets the Tomcat manager wrapper object configured for this goal.
protected  String getPath()
          Gets the webapp context path to use when communicating with Tomcat manager.
protected  URL getURL()
          Gets the full URL of the Tomcat manager instance.
protected abstract  void invokeManager()
          Invokes Tomcat manager when this Mojo is executed.
protected  void log(String string)
          Splits the given string into lines and writes each one separately to the log at info level.
 
Methods inherited from class org.apache.tomcat.maven.plugin.tomcat6.AbstractI18NTomcat6Mojo
checkTomcatResponse
 
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractCatalinaMojo

public AbstractCatalinaMojo()
Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:
org.apache.maven.plugin.MojoExecutionException

invokeManager

protected abstract void invokeManager()
                               throws org.apache.maven.plugin.MojoExecutionException,
                                      TomcatManagerException,
                                      IOException
Invokes Tomcat manager when this Mojo is executed.

Throws:
org.apache.maven.plugin.MojoExecutionException - if there was a problem executing this goal
TomcatManagerException - if the Tomcat manager request fails
IOException - if an i/o error occurs

getManager

protected TomcatManager getManager()
                            throws org.apache.maven.plugin.MojoExecutionException
Gets the Tomcat manager wrapper object configured for this goal.

Returns:
the Tomcat manager wrapper object
Throws:
org.apache.maven.plugin.MojoExecutionException - if there was a problem obtaining the authentication details

getURL

protected URL getURL()
Gets the full URL of the Tomcat manager instance.

Returns:
the full URL of the Tomcat manager instance to use

getPath

protected String getPath()
Gets the webapp context path to use when communicating with Tomcat manager.

Overrides:
getPath in class AbstractI18NTomcat6Mojo
Returns:
the webapp context path to use

getDeployedURL

protected URL getDeployedURL()
                      throws MalformedURLException
Gets the URL of the deployed webapp.

Returns:
the URL of the deployed webapp
Throws:
MalformedURLException - if the deployed webapp URL is invalid

log

protected void log(String string)
Splits the given string into lines and writes each one separately to the log at info level.

Parameters:
string - the string to write


Copyright © 2005–2014 The Apache Software Foundation. All rights reserved.