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

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

public class WebAppServlet
extends java.lang.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(java.lang.String urlPattern)
          Add an url mapping for servlet.
 java.lang.String[] getAliases()
          Returns the aliases associated with this servlet.
 WebAppInitParam[] getInitParams()
          Returns the init params associated with this filter.
 int getLoadOnStartup()
           
 javax.servlet.Servlet getServlet()
          Getter.
 java.lang.String getServletClass()
          Getter.
 java.lang.String getServletName()
          Getter.
 void setLoadOnStartup(java.lang.String value)
           
 void setServlet(javax.servlet.Servlet servlet)
          Setter.
 void setServletClass(java.lang.String servletClass)
          Setter.
 void setServletName(java.lang.String servletName)
          Setter.
 java.lang.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 java.lang.String getServletName()
Getter.

Returns:
servlet name

setServletName

public void setServletName(java.lang.String servletName)
Setter.

Parameters:
servletName - value to set. Cannot be null
Throws:
org.ops4j.lang.NullArgumentException - if servlet name is null

getServletClass

public java.lang.String getServletClass()
Getter.

Returns:
servlet class name

setServletClass

public void setServletClass(java.lang.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 java.lang.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(java.lang.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

setLoadOnStartup

public void setLoadOnStartup(java.lang.String value)

getLoadOnStartup

public int getLoadOnStartup()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2006-2011 OPS4J - Open Participation Software for Java. All Rights Reserved.