org.jboss.forge.project.facets
Interface WebResourceFacet

All Superinterfaces:

Facet

public interface WebResourceFacet
extends Facet

A Facet containing APIs to interact with Java Web Projects

Author:

Lincoln Baxter, III

Method Summary

FileResource<?>	createWebResource(char[] bytes, String relativeFilename) At the given path/filename relative to the project Web Root directory: getWebRootDirectory() - create a FileResource containing the given bytes.
FileResource<?>	createWebResource(String render, String relativeFilename) At the given path/filename relative to the project Web Root directory: getWebRootDirectory() - create a FileResource containing the given String.
FileResource<?>	getWebResource(String relativePath) Get the given FileResource relative to the project Web Root directory: getWebRootDirectory()
List<DirectoryResource>	getWebRootDirectories() Get a list containing all possible Web Root DirectoryResources for the current project.
DirectoryResource	getWebRootDirectory() Get the default Web Root directory (this is the DirectoryResource containing resources to be deployed to the web-root URL when the application is published.

Methods inherited from interface org.jboss.forge.project.Facet

getProject, install, isInstalled, setProject, uninstall

Method Detail

getWebRootDirectory

DirectoryResource getWebRootDirectory()

Get the default Web Root directory (this is the DirectoryResource containing resources to be deployed to the web-root URL when the application is published. (E.g. In a maven project, files in the /project/src/main/webapp directory are typically published to the root URL: http://localhost:8080/project/ root directory. In an eclipse project, this folder is typically located by default at: /project/WebContent/.)

getWebRootDirectories

List<DirectoryResource> getWebRootDirectories()

Get a list containing all possible Web Root DirectoryResources for the current project.

createWebResource

FileResource<?> createWebResource(char[] bytes,
                                  String relativeFilename)

At the given path/filename relative to the project Web Root directory: getWebRootDirectory() - create a FileResource containing the given bytes.

Returns:

a handle to the FileResource that was created.

createWebResource

FileResource<?> createWebResource(String render,
                                  String relativeFilename)

At the given path/filename relative to the project Web Root directory: getWebRootDirectory() - create a FileResource containing the given String.

Returns:

a handle to the FileResource that was created.

getWebResource

FileResource<?> getWebResource(String relativePath)

Get the given FileResource relative to the project Web Root directory: getWebRootDirectory()