com.sun.enterprise.glassfish.web

Class WarHandler

java.lang.Object

org.glassfish.internal.deployment.GenericHandler

com.sun.enterprise.deploy.shared.AbstractArchiveHandler

com.sun.enterprise.glassfish.web.WarHandler

All Implemented Interfaces:

ArchiveHandler

@Service(name="war")
public class WarHandler
extends AbstractArchiveHandler

Implementation of the ArchiveHandler for war files.

Author:

Jerome Dochez, Sanjeeb Sahoo, Shing Wai Chan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WarHandler.BaseXmlParser
protected class	WarHandler.ContextXmlParser
protected class	WarHandler.GlassFishWebXmlParser
protected class	WarHandler.PayaraWebXmlParser
protected class	WarHandler.SunWebXmlParser
protected class	WarHandler.WeblogicXmlParser
protected class	WarHandler.WebXmlParser

Field Summary

Fields inherited from class com.sun.enterprise.deploy.shared.AbstractArchiveHandler

deplLogger

Fields inherited from class org.glassfish.internal.deployment.GenericHandler

habitat

Constructor Summary

Constructors

Constructor and Description
WarHandler()

Method Summary

Modifier and Type	Method and Description
protected void	configureContextXmlAttribute(WebappClassLoader cloader, File base, DeploymentContext dc)
protected void	configureLoaderAttributes(WebappClassLoader cloader, WarHandler.WebXmlParser webXmlParser, File base)
protected void	configureLoaderProperties(WebappClassLoader cloader, WarHandler.WebXmlParser webXmlParser, File base)
String	getArchiveType() This method is semantically equivalent to ArchiveDetector.getArchiveType() except that this method returns string equivalent of ArchiveType because of backward compatibility reasons.
ClassLoader	getClassLoader(ClassLoader parent, DeploymentContext context) Creates a classloader that can load code from inside the archive.
List<URI>	getClassPathURIs(ReadableArchive archive) Returns the classpath URIs for this archive.
String	getVersionIdentifier(ReadableArchive archive) Returns the default value for versionIdentifier.
protected WarHandler.WebXmlParser	getWebXmlParser(ReadableArchive archive, Application application)
boolean	handles(ReadableArchive archive) Returns true if this handler understands the specified archive and can process it.

Methods inherited from class com.sun.enterprise.deploy.shared.AbstractArchiveHandler

getManifestLibraries, getXMLInputFactory

Methods inherited from class org.glassfish.internal.deployment.GenericHandler

expand, getDefaultApplicationName, getDefaultApplicationName, getDefaultApplicationName, getDefaultApplicationNameFromArchiveName, getManifest, requiresAnnotationScanning

Methods inherited from class java.lang.Object

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

Constructor Detail

WarHandler

public WarHandler()

Method Detail

getArchiveType

public String getArchiveType()

Description copied from interface: ArchiveHandler

This method is semantically equivalent to ArchiveDetector.getArchiveType() except that this method returns string equivalent of ArchiveType because of backward compatibility reasons.

Returns:

the type of the archive or deployment unit handled by this handler

See Also:

ArchiveDetector.getArchiveType()

getVersionIdentifier

public String getVersionIdentifier(ReadableArchive archive)

Description copied from class: GenericHandler

Returns the default value for versionIdentifier. This allows us to override the method only where thhe version-identifier element is supported.

Specified by:

getVersionIdentifier in interface ArchiveHandler

Overrides:

getVersionIdentifier in class GenericHandler

Parameters:

archive - the archive for which to provide the version identifier

Returns:

null

handles

public boolean handles(ReadableArchive archive)
                throws IOException

Description copied from interface: ArchiveHandler

Returns true if this handler understands the specified archive and can process it.

Throws:

IOException - The implementation of this method is expected to interact with the given archive, and if methods on ReadableArchive throws an IOException, it can be simply tunneled to the caller.

getClassLoader

public ClassLoader getClassLoader(ClassLoader parent,
                                  DeploymentContext context)

Description copied from interface: ArchiveHandler

Creates a classloader that can load code from inside the archive.

Parameters:

parent - The newly created classloader to be returned must eventually delegate to this classloader. (This classloader is capable of resolving APIs and other things that the container

getWebXmlParser

protected WarHandler.WebXmlParser getWebXmlParser(ReadableArchive archive,
                                                  Application application)
                                           throws XMLStreamException,
                                                  IOException

Throws:

XMLStreamException

IOException

configureLoaderAttributes

protected void configureLoaderAttributes(WebappClassLoader cloader,
                                         WarHandler.WebXmlParser webXmlParser,
                                         File base)

configureLoaderProperties

protected void configureLoaderProperties(WebappClassLoader cloader,
                                         WarHandler.WebXmlParser webXmlParser,
                                         File base)

configureContextXmlAttribute

protected void configureContextXmlAttribute(WebappClassLoader cloader,
                                            File base,
                                            DeploymentContext dc)
                                     throws XMLStreamException,
                                            IOException

Throws:

XMLStreamException

IOException

getClassPathURIs

public List<URI> getClassPathURIs(ReadableArchive archive)

Returns the classpath URIs for this archive.

Specified by:

getClassPathURIs in interface ArchiveHandler

Overrides:

getClassPathURIs in class GenericHandler

Parameters:

archive - file

Returns:

classpath URIs for this archive