WebAppDescriptor (Jersey Test Framework

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.jersey.test.framework
Class WebAppDescriptor

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

public class WebAppDescriptor
extends AppDescriptor
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:

GrizzlyWebTestContainerFactory for testing with the Grizzly Web container and Servlet support.
EmbeddedGlassFishTestContainerFactory for testing with embedded GlassFish.
ExternalTestContainerFactory for testing when the Web application is independently deployed in a separate JVM to that of the tests. For example, the application may be deployed to the Glassfish v2 or v3 application server.

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
`java.util.Map<java.lang.String,java.lang.String>`	`getContextParams()` Get the context parameters.
`java.lang.String`	`getContextPath()` Get the context path.
`java.util.List<WebAppDescriptor.FilterDescriptor>`	`getFilters()` Get the filter class.
`java.util.Map<java.lang.String,java.lang.String>`	`getInitParams()` Get the initialization parameters.
`java.util.List<java.lang.Class<? extends java.util.EventListener>>`	`getListeners()` Get all the registered Listener classes
`java.lang.Class<? extends javax.servlet.http.HttpServlet>`	`getServletClass()` Get the servlet class.
`java.lang.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 java.util.Map<java.lang.String,java.lang.String> getInitParams()

Get the initialization parameters.

Returns:: the initialization parameters.

getContextParams

public java.util.Map<java.lang.String,java.lang.String> getContextParams()

Get the context parameters.

Returns:: the context parameters.

getServletClass

public java.lang.Class<? extends javax.servlet.http.HttpServlet> getServletClass()

Get the servlet class.

Returns:: the servlet class.

getFilters

public java.util.List<WebAppDescriptor.FilterDescriptor> getFilters()

Get the filter class.

Returns:: the filter classes.

getContextPath

public java.lang.String getContextPath()

Get the context path.

Returns:: the context path.

getServletPath

public java.lang.String getServletPath()

Get the servlet path.

Returns:: the servlet path.

getListeners

public java.util.List<java.lang.Class<? extends java.util.EventListener>> getListeners()

Get all the registered Listener classes

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