net.officefloor.plugin.war

Class WarOfficeFloorDecorator

java.lang.Object

net.officefloor.plugin.war.WarOfficeFloorDecorator

All Implemented Interfaces:

OfficeFloorDecorator

public class WarOfficeFloorDecorator
extends Object
implements OfficeFloorDecorator

OfficeFloorDecorator for a WAR.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	META_INF META-INF directory name.
static String	PLUGIN_WAR_ARTIFACT_ID Maven Artifact Id for the WarOfficeFloorDecorator.
static String	PLUGIN_WAR_GROUP_ID Maven Group Id for the WarOfficeFloorDecorator.
static String	WEB_INF WEB-INF directory name.
static String	WEB_INF_CLASSES Directory within the Web Archive containing classes for the class path.
static String	WEB_INF_LIB Directory within the Web Archive containing additional archives for the class path.
static String	WEB_INF_WEB_XML web.xml location within the Web Archive.
static String	WEB_PUBLIC Directory to contain the public web content.

Constructor Summary

Constructors

Constructor and Description
WarOfficeFloorDecorator() Default constructor necessary to act as OfficeFloorDecorator.

Method Summary

Modifier and Type	Method and Description
void	decorate(OfficeFloorDecoratorContext context) Decorates the OfficeFloor.
static File	generateJarMinusMetaAndWebInf(File warOrDirectory) Generates a JAR File decorated ready for use from the input JAR or directory File.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_WAR_GROUP_ID

public static final String PLUGIN_WAR_GROUP_ID

Maven Group Id for the WarOfficeFloorDecorator.

See Also:

Constant Field Values

PLUGIN_WAR_ARTIFACT_ID

public static final String PLUGIN_WAR_ARTIFACT_ID

Maven Artifact Id for the WarOfficeFloorDecorator.

See Also:

Constant Field Values

META_INF

public static final String META_INF

META-INF directory name.

See Also:

Constant Field Values

WEB_INF

public static final String WEB_INF

WEB-INF directory name.

See Also:

Constant Field Values

WEB_INF_CLASSES

public static final String WEB_INF_CLASSES

Directory within the Web Archive containing classes for the class path.

See Also:

Constant Field Values

WEB_INF_LIB

public static final String WEB_INF_LIB

Directory within the Web Archive containing additional archives for the class path.

See Also:

Constant Field Values

WEB_INF_WEB_XML

public static final String WEB_INF_WEB_XML

web.xml location within the Web Archive.

See Also:

Constant Field Values

WEB_PUBLIC

public static final String WEB_PUBLIC

Directory to contain the public web content.

See Also:

Constant Field Values

Constructor Detail

WarOfficeFloorDecorator

public WarOfficeFloorDecorator()

Default constructor necessary to act as OfficeFloorDecorator.

Method Detail

generateJarMinusMetaAndWebInf

public static File generateJarMinusMetaAndWebInf(File warOrDirectory)
                                          throws Exception

Generates a JAR File decorated ready for use from the input JAR or directory File.

The META-INF and WEB-INF contents are not included in the JAR. The reason is that this is used by Maven goals that have already included the content on the class path. The Maven goals use this as they wish to obtain generated web content from the Maven package directory but not re-include the code.

Parameters:

warOrDirectory - WAR or directory.

Returns:

Generated JAR minus META-INF and WEB-INF directories.

Throws:

Exception - If fails to generate the JAR.

decorate

public void decorate(OfficeFloorDecoratorContext context)
              throws Exception

Description copied from interface: OfficeFloorDecorator

Decorates the OfficeFloor.

Specified by:

decorate in interface OfficeFloorDecorator

Parameters:

context - OfficeFloorDecoratorContext.

Throws:

Exception - If fails to decorate.