com.sun.jersey.test.framework
Class WebAppDescriptor

java.lang.Object
  extended by com.sun.jersey.test.framework.AppDescriptor
      extended by com.sun.jersey.test.framework.WebAppDescriptor

public class WebAppDescriptor
extends AppDescriptor

A Web-based application descriptor.

An instance of this class is created by creating an instance of WebAppDescriptor.Builder, invoking methods to add/modify state, and finally invoking the WebAppDescriptor.Builder.build() method.

This application descriptor is compatible with web-based test containers that support Servlets. The following Web-based test container factories are provided:

Author:
Paul.Sandoz@Sun.COM

Nested Class Summary
static class WebAppDescriptor.Builder
          The builder for building a Web-based application descriptor.
static class WebAppDescriptor.FilterDescriptor
           
 
Nested classes/interfaces inherited from class com.sun.jersey.test.framework.AppDescriptor
AppDescriptor.AppDescriptorBuilder<T extends AppDescriptor.AppDescriptorBuilder,V extends AppDescriptor>
 
Method Summary
 Map<String,String> getContextParams()
          Get the context parameters.
 String getContextPath()
          Get the context path.
 List<WebAppDescriptor.FilterDescriptor> getFilters()
          Get the filter class.
 Map<String,String> getInitParams()
          Get the initialization parameters.
 List<Class<? extends EventListener>> getListeners()
          Get all the registered Listener classes
 Class<? extends javax.servlet.http.HttpServlet> getServletClass()
          Get the servlet class.
 String getServletPath()
          Get the servlet path.
 
Methods inherited from class com.sun.jersey.test.framework.AppDescriptor
getClientConfig
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInitParams

public Map<String,String> getInitParams()
Get the initialization parameters.

Returns:
the initialization parameters.

getContextParams

public Map<String,String> getContextParams()
Get the context parameters.

Returns:
the context parameters.

getServletClass

public Class<? extends javax.servlet.http.HttpServlet> getServletClass()
Get the servlet class.

Returns:
the servlet class.

getFilters

public List<WebAppDescriptor.FilterDescriptor> getFilters()
Get the filter class.

Returns:
the filter classes.

getContextPath

public String getContextPath()
Get the context path.

Returns:
the context path.

getServletPath

public String getServletPath()
Get the servlet path.

Returns:
the servlet path.

getListeners

public List<Class<? extends EventListener>> getListeners()
Get all the registered Listener classes

Returns:
the registered listener classes, or null if none is registered.


Copyright © 2013 Oracle Corporation. All Rights Reserved.