A E F G H I J L O P R S T V W X

A

addFormatter(ValidationFormatter) - Method in class org.apache.maven.j2ee.WarValidator

Add a formatter to pick up events and display the output.

addValidationListener(ValidationListener) - Method in class org.apache.maven.j2ee.ValidationBroadcaster

add a listener to the list to be notified

addValidationListener(ValidationListener) - Method in class org.apache.maven.j2ee.WarValidator

add a listener to the list to be notified

E

endValidation() - Method in class org.apache.maven.j2ee.WarValidator

End validation - fire an ended event

error(String) - Method in class org.apache.maven.j2ee.WarValidator

Helper method to fire an error message using the broadcaster

execute() - Method in class org.apache.maven.j2ee.WarValidator

Perform the validation.

extract(JarEntry) - Method in class org.apache.maven.j2ee.WarFile

Extract the given entry to a temporary file

F

FormLoginConfig - class org.apache.maven.j2ee.war.FormLoginConfig.

A class to represent the <form-login-config> element of a war file

FormLoginConfig() - Constructor for class org.apache.maven.j2ee.war.FormLoginConfig

Create an instance of the class with null values for all fields

FormLoginConfig(String, String) - Constructor for class org.apache.maven.j2ee.war.FormLoginConfig

Create an instance of the class with the given values for fields

fireEndedEvent(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationBroadcaster

fire an ended event.

fireErrorEvent(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationBroadcaster

fire an error event.

fireInformationEvent(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationBroadcaster

fire a information event.

fireStartedEvent(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationBroadcaster

fire a started event.

fireWarningEvent(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationBroadcaster

fire a warning event.

G

getBroadcaster() - Method in class org.apache.maven.j2ee.WarValidator

Getter for property broadcaster.

getErrorPage() - Method in class org.apache.maven.j2ee.war.FormLoginConfig

Getter for property errorPage.

getErrorPages() - Method in class org.apache.maven.j2ee.WarFile

Get a map of error pages to error locations.

getFile() - Method in class org.apache.maven.j2ee.ValidationFormatter

Getter for property file.

getFormLoginConfig() - Method in class org.apache.maven.j2ee.WarFile

Get the <form-login-config> details specified in the war file, or null if the element is not present

getIdToResource() - Method in class org.apache.maven.j2ee.J2EEEntityResolver

Getter for publicId to resource name map.

getJSPs() - Method in class org.apache.maven.j2ee.WarFile

Get a map of servlet name -> jsp file.

getLibEntries() - Method in class org.apache.maven.j2ee.WarFile

Provide a set of jar files as found in WEB-INF/lib

getLoginPage() - Method in class org.apache.maven.j2ee.war.FormLoginConfig

Getter for property loginPage.

getMessage() - Method in class org.apache.maven.j2ee.ValidationEvent

Getter for property message.

getServletMappings() - Method in class org.apache.maven.j2ee.WarFile

Get a map of servlet name -> url pattern for all defined servlets

getServlets() - Method in class org.apache.maven.j2ee.WarFile

Get a map of servlet name -> servlet class.

getStatus() - Method in class org.apache.maven.j2ee.WarValidator

Provides access to the status listener that is automatically attached to the validation

getStream() - Method in class org.apache.maven.j2ee.ValidationFormatter

Getter for property stream.

getSubject() - Method in class org.apache.maven.j2ee.ValidationEvent

Getter for property subject.

getTaglibs() - Method in class org.apache.maven.j2ee.WarFile

Get a map of taglib-uri -> taglib-location.

getType() - Method in class org.apache.maven.j2ee.ValidationFormatter

Getter for property type.

getWarFileName() - Method in class org.apache.maven.j2ee.WarValidator

Getter for property warFileName.

getWebXml() - Method in class org.apache.maven.j2ee.WarFile

Get the web.xml back as a dom4j Document, for easier processing

getWebXmlEntry() - Method in class org.apache.maven.j2ee.WarFile

Retrieves the WEB-INF/web.xml entry if it exists.

H

hasFile(String) - Method in class org.apache.maven.j2ee.WarFile

Tests whether a 'file' exists in the war.

I

info(String) - Method in class org.apache.maven.j2ee.WarValidator

Helper method to fire an information message using the broadcaster

isEnded() - Method in class org.apache.maven.j2ee.ValidationStatusListener

Has validation ended?

isError() - Method in class org.apache.maven.j2ee.ValidationStatusListener

Has a validation error occurred?

isFailOnError() - Method in class org.apache.maven.j2ee.WarValidator

Whether the build process will fail if a validation error occurs.

isInformation() - Method in class org.apache.maven.j2ee.ValidationStatusListener

Gets whether an info message has been issued.

isStarted() - Method in class org.apache.maven.j2ee.ValidationStatusListener

Has validation started?

isUsefile() - Method in class org.apache.maven.j2ee.ValidationFormatter

Getter for property usefile.

isWarning() - Method in class org.apache.maven.j2ee.ValidationStatusListener

Has a validation warning occurred?

J

J2EEEntityResolver - class org.apache.maven.j2ee.J2EEEntityResolver.

A class to resolve external entity definitions for j2ee artifacts.

J2EEEntityResolver() - Constructor for class org.apache.maven.j2ee.J2EEEntityResolver

Creates a new instance of EntityResolver

J2EE_DTDS - Static variable in class org.apache.maven.j2ee.J2EEEntityResolver

list of j2ee dtds that are being made available

J2EE_RESOURCES - Static variable in class org.apache.maven.j2ee.J2EEEntityResolver

L

LIB - Static variable in class org.apache.maven.j2ee.WarFile

lib entry in the war for jar files

O

org.apache.maven.j2ee - package org.apache.maven.j2ee

org.apache.maven.j2ee.war - package org.apache.maven.j2ee.war

P

PLAIN - Static variable in class org.apache.maven.j2ee.ValidationFormatter

Plain format output

R

removeValidationListener(ValidationListener) - Method in class org.apache.maven.j2ee.ValidationBroadcaster

remove a listener from the list to be notified

removeValidationListener(ValidationListener) - Method in class org.apache.maven.j2ee.WarValidator

remove a listener from the list to be notified

resolveEntity(String, String) - Method in class org.apache.maven.j2ee.J2EEEntityResolver

resolve the entity given by the provided Ids

S

setErrorPage(String) - Method in class org.apache.maven.j2ee.war.FormLoginConfig

Setter for property errorPage.

setFailOnError(boolean) - Method in class org.apache.maven.j2ee.WarValidator

Set whether the build process will fail if a validation error occurs.

setFile(String) - Method in class org.apache.maven.j2ee.ValidationFormatter

Setter for property file.

setIdToResource(Map) - Method in class org.apache.maven.j2ee.J2EEEntityResolver

Setter for publicId to resource name map.

setInformation(boolean) - Method in class org.apache.maven.j2ee.ValidationStatusListener

Sets whether an info message has been issued.

setLoginPage(String) - Method in class org.apache.maven.j2ee.war.FormLoginConfig

Setter for property loginPage.

setMessage(String) - Method in class org.apache.maven.j2ee.ValidationEvent

Setter for property message.

setStream(PrintStream) - Method in class org.apache.maven.j2ee.ValidationFormatter

Setter for property stream.

setSubject(Object) - Method in class org.apache.maven.j2ee.ValidationEvent

Set the subject of the validation event.

setType(String) - Method in class org.apache.maven.j2ee.ValidationFormatter

Setter for property type.

setUsefile(boolean) - Method in class org.apache.maven.j2ee.ValidationFormatter

Setter for property usefile.

setWarFileName(String) - Method in class org.apache.maven.j2ee.WarValidator

Setter for property warFileName.

startValidation() - Method in class org.apache.maven.j2ee.WarValidator

Start validation - issue a started event, and check the war file is ok from a filesystem perspective - exists and is readable

T

toString() - Method in class org.apache.maven.j2ee.WarValidator

Provide a string representation of the validator

V

ValidationBroadcaster - class org.apache.maven.j2ee.ValidationBroadcaster.

ValidationBroadcaster() - Constructor for class org.apache.maven.j2ee.ValidationBroadcaster

Creates a new instance of ValidationBroadcaster

ValidationEvent - class org.apache.maven.j2ee.ValidationEvent.

A class that holds details about the validation

ValidationEvent(Object) - Constructor for class org.apache.maven.j2ee.ValidationEvent

Creates a new instance of ValidationEvent.

ValidationEvent(Object, Object, String) - Constructor for class org.apache.maven.j2ee.ValidationEvent

Creates a new instance of ValidationEvent.

ValidationFormatter - class org.apache.maven.j2ee.ValidationFormatter.

Base class for formatters of validation events.

ValidationFormatter() - Constructor for class org.apache.maven.j2ee.ValidationFormatter

Creates a new instance of ValidationFormatter

ValidationListener - interface org.apache.maven.j2ee.ValidationListener.

An interface implemented by those who want to receive validation events from a J2EE Validator (WAR, EAR etc).

ValidationStatusListener - class org.apache.maven.j2ee.ValidationStatusListener.

A ValidationListener that tracks events and will provide a true/false response about the status of the validation.

ValidationStatusListener() - Constructor for class org.apache.maven.j2ee.ValidationStatusListener

Creates a new instance of ValidationStatusListener

validate() - Method in class org.apache.maven.j2ee.WarValidator

validate the provided war file

validateClass(String, ClassLoader) - Method in class org.apache.maven.j2ee.WarValidator

Validate that the given className can be loaded by the given ClasssLoader

validateErrorPages(WarFile) - Method in class org.apache.maven.j2ee.WarValidator

Validate the error pages defined in the war file (as defined by a <error-page> tag in web.xml), making sure that the location specifed by the nested <location> exists in the war file

validateFormLoginConfig(WarFile) - Method in class org.apache.maven.j2ee.WarValidator

Validate that the <form-login-config> element, if it exists contains valid login and error pages

validateWarContents() - Method in class org.apache.maven.j2ee.WarValidator

Hook point for subclasses to add validations

validationEnded(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationFormatter

Called when validation ends

validationEnded(ValidationEvent) - Method in interface org.apache.maven.j2ee.ValidationListener

Called when validation ends

validationEnded(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationStatusListener

Called when validation ends.

validationError(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationFormatter

Called when a validation error occurs.

validationError(ValidationEvent) - Method in interface org.apache.maven.j2ee.ValidationListener

Called when a validation error occurs.

validationError(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationStatusListener

Called when a validation error occurs.

validationInformation(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationFormatter

Called when validation information events are fired.

validationInformation(ValidationEvent) - Method in interface org.apache.maven.j2ee.ValidationListener

Called when validation information is provided.

validationInformation(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationStatusListener

Called when validation info messages are issued.

validationStarted(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationFormatter

Called when validation starts

validationStarted(ValidationEvent) - Method in interface org.apache.maven.j2ee.ValidationListener

Called when validation starts

validationStarted(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationStatusListener

Called when validation starts.

validationWarning(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationFormatter

Called when a validation warning occurs.

validationWarning(ValidationEvent) - Method in interface org.apache.maven.j2ee.ValidationListener

Called when a validation warning occurs.

validationWarning(ValidationEvent) - Method in class org.apache.maven.j2ee.ValidationStatusListener

Called when a validation warning occurs.

W

WEB_XML - Static variable in class org.apache.maven.j2ee.WarFile

web.xml entry in the war

WarClassLoader - class org.apache.maven.j2ee.WarClassLoader.

A ClassLoader that loads classes from a WarFile

WarClassLoader(WarFile) - Constructor for class org.apache.maven.j2ee.WarClassLoader

Creates a new instance of WarClassLoader

WarClassLoader(WarFile, ClassLoader) - Constructor for class org.apache.maven.j2ee.WarClassLoader

Creates a new instance of WarClassLoader with the provided parent classloader as the one to delegate to if classes can't be found

WarFile - class org.apache.maven.j2ee.WarFile.

Represents a J2EE War File

WarFile(String) - Constructor for class org.apache.maven.j2ee.WarFile

Creates a new instance of WarFile

WarFile(String, boolean) - Constructor for class org.apache.maven.j2ee.WarFile

Creates a new instance of WarFile

WarFile(File) - Constructor for class org.apache.maven.j2ee.WarFile

Creates a new instance of WarFile

WarFile(File, boolean) - Constructor for class org.apache.maven.j2ee.WarFile

Creates a new instance of WarFile

WarFile(File, boolean, int) - Constructor for class org.apache.maven.j2ee.WarFile

Creates a new instance of WarFile

WarValidator - class org.apache.maven.j2ee.WarValidator.

A task to validate a war file.

WarValidator() - Constructor for class org.apache.maven.j2ee.WarValidator

Creates a new instance of WarValidator

warning(String) - Method in class org.apache.maven.j2ee.WarValidator

Helper method to fire a warning message using the broadcaster

X

XML - Static variable in class org.apache.maven.j2ee.ValidationFormatter

xml format output

A E F G H I J L O P R S T V W X