org.apache.cactus.integration.api.cactify
Class Redirector

java.lang.Object
  org.apache.cactus.integration.api.cactify.Redirector

Direct Known Subclasses:

FilterRedirector, JspRedirector, ServletRedirector

public abstract class Redirector
extends java.lang.Object

Abstract base class for nested redirector elements.

Version:

Field Summary

protected org.codehaus.cargo.util.log.Logger	logger Cargo logger - when used by Ant, AntLogger must instantiated, when used by Maven MavenLogger should be instantiated;
protected java.lang.String	mapping The URL pattern that the redirector will be mapped to.
protected java.lang.String	name The name of the redirector.
protected java.lang.String	roles Comma-separated list of role names that should be granted access to the redirector.

Constructor Summary

Redirector()
Default constructor.

Redirector(org.codehaus.cargo.util.log.Logger logger)
Constructor with ownerTask.

Method Summary

protected void	addSecurity(org.codehaus.cargo.module.webapp.WebXml theWebXml) Adds the comma-separated list of security roles to a deployment descriptor.
abstract void	mergeInto(org.codehaus.cargo.module.webapp.WebXml theWebXml) Merges the definition of the redirector into the provided deployment descriptor.
void	setMapping(java.lang.String theMapping) Sets the URL pattern that the redirector should be mapped to.
void	setName(java.lang.String theName) Sets the name of the redirector.
void	setRoles(java.lang.String theRoles) Sets the comma-separated list of role names that should be granted access to the redirector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected org.codehaus.cargo.util.log.Logger logger

Cargo logger - when used by Ant, AntLogger must instantiated, when used by Maven MavenLogger should be instantiated;

name

protected java.lang.String name

The name of the redirector.

mapping

protected java.lang.String mapping

The URL pattern that the redirector will be mapped to.

roles

protected java.lang.String roles

Comma-separated list of role names that should be granted access to the redirector.

Constructor Detail

Redirector

public Redirector()

Default constructor.

Redirector

public Redirector(org.codehaus.cargo.util.log.Logger logger)

Constructor with ownerTask.

Parameters:

theOwnerTask - to be instantiated

Method Detail

mergeInto

public abstract void mergeInto(org.codehaus.cargo.module.webapp.WebXml theWebXml)

Merges the definition of the redirector into the provided deployment descriptor.

Parameters:

theWebXml - The deployment descriptor into which the redirector definition should be merged

setName

public final void setName(java.lang.String theName)

Sets the name of the redirector.

Parameters:

theName - The name to set

setMapping

public final void setMapping(java.lang.String theMapping)

Sets the URL pattern that the redirector should be mapped to.

Parameters:

theMapping - The URL pattern to set

setRoles

public final void setRoles(java.lang.String theRoles)

Sets the comma-separated list of role names that should be granted access to the redirector.

Parameters:

theRoles - The roles to set

addSecurity

protected final void addSecurity(org.codehaus.cargo.module.webapp.WebXml theWebXml)

Adds the comma-separated list of security roles to a deployment descriptor.

Parameters:

theWebXml - The deployment descriptor