org.ops4j.pax.web.extender.war.internal.model
Class WebAppServlet

java.lang.Object
  org.ops4j.pax.web.extender.war.internal.model.WebAppServlet

public class WebAppServlet
extends Object

Servlet element in web.xml.

Since:

0.3.0, December 27, 2007

Author:

Alin Dreghiciu

Constructor Summary

WebAppServlet()
Creates a new web app servlet.

Method Summary

void	addInitParam(WebAppInitParam param) Add a init param for filter.
void	addUrlPattern(String urlPattern) Add an url mapping for servlet.
String[]	getAliases() Returns the aliases associated with this servlet.
WebAppInitParam[]	getInitParams() Returns the init params associated with this filter.
javax.servlet.Servlet	getServlet() Getter.
String	getServletClass() Getter.
String	getServletName() Getter.
void	setServlet(javax.servlet.Servlet servlet) Setter.
void	setServletClass(String servletClass) Setter.
void	setServletName(String servletName) Setter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAppServlet

public WebAppServlet()

Creates a new web app servlet.

Method Detail

getServletName

public String getServletName()

Getter.

Returns:

servlet name

setServletName

public void setServletName(String servletName)

Setter.

Parameters:

servletName - value to set. Cannot be null

Throws:

org.ops4j.lang.NullArgumentException - if servlet name is null

getServletClass

public String getServletClass()

Getter.

Returns:

servlet class name

setServletClass

public void setServletClass(String servletClass)

Setter.

Parameters:

servletClass - value to set. Cannot be null

Throws:

org.ops4j.lang.NullArgumentException - if servlet class is null

getServlet

public javax.servlet.Servlet getServlet()

Getter.

Returns:

servlet

setServlet

public void setServlet(javax.servlet.Servlet servlet)

Setter.

Parameters:

servlet - value to set.

getAliases

public String[] getAliases()

Returns the aliases associated with this servlet. If there are no associated aliases an empty array is returned.

Returns:

array of aliases

addUrlPattern

public void addUrlPattern(String urlPattern)

Add an url mapping for servlet. The url mapping is converted to an alias by emoving trailing "*"

Parameters:

urlPattern - to be added. Cannot be null

Throws:

org.ops4j.lang.NullArgumentException - if url pattern is null

addInitParam

public void addInitParam(WebAppInitParam param)

Add a init param for filter.

Parameters:

param - to be added

Throws:

org.ops4j.lang.NullArgumentException - if param, param name, param value is null

getInitParams

public WebAppInitParam[] getInitParams()

Returns the init params associated with this filter. If there are no associated init params an empty array is returned.

Returns:

array of url patterns

toString

public String toString()

Overrides:

toString in class Object