PortalWebApp - JBOSS Portal 2.6 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.server.deployment
Class PortalWebApp

java.lang.Object
  org.jboss.portal.server.deployment.PortalWebApp

Direct Known Subclasses:: PortalWebTomcat4App, PortalWebTomcat5App

public abstract class PortalWebApp
extends java.lang.Object

Encapsulate the infos needed by the portal deployment layer to create the application.

Version:: $Revision: 5448 $
Author:: Julien Viet

Field Summary

private java.lang.String contextPath
          .

private org.w3c.dom.Document descriptor
          .

private java.lang.String id
          .

private java.lang.ClassLoader loader
          .

protected org.apache.log4j.Logger log
          The logger.

private javax.servlet.ServletContext servletContext
          .

private java.net.URL url
          .

Constructor Summary

protected PortalWebApp()
          Constructor with the given web app.

Method Summary

java.lang.ClassLoader getClassLoader()
          Return the classloader of the web app.

java.lang.String getContextPath()
          Returns the context path of the web application.

org.w3c.dom.Document getDescriptor()


java.lang.String getId()
          Return the application id.

javax.servlet.ServletContext getServletContext()
          Returns the servlet context of the web application.

java.net.URL getURL()
          Return the URL associated to this webapp.

boolean importFile(java.lang.String parentDirRelativePath, java.lang.String name, java.io.InputStream source, boolean overwrite)
          Import a file in the war file.

protected void init(javax.servlet.ServletContext servletContext, java.net.URL url, java.lang.ClassLoader loader, java.lang.String contextPath)


abstract void instrument()
          Instrument the web application.

private void readJBossAppDescriptor()
          Read jboss-app.xml deployment and fetch the overriden id if it exists.

java.lang.String toString()


Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.log4j.Logger log

The logger.

descriptor

private org.w3c.dom.Document descriptor

servletContext

private javax.servlet.ServletContext servletContext

loader

private java.lang.ClassLoader loader

url

private java.net.URL url

id

private java.lang.String id

contextPath

private java.lang.String contextPath

Constructor Detail

PortalWebApp

protected PortalWebApp()

Constructor with the given web app.

Method Detail

instrument

public abstract void instrument()
                         throws java.lang.Exception

Instrument the web application.

Throws:: java.lang.Exception

getURL

public final java.net.URL getURL()

Return the URL associated to this webapp.

getId

public final java.lang.String getId()

Return the application id.

getClassLoader

public final java.lang.ClassLoader getClassLoader()

Return the classloader of the web app.

getContextPath

public final java.lang.String getContextPath()

Returns the context path of the web application.

getServletContext

public final javax.servlet.ServletContext getServletContext()

Returns the servlet context of the web application.

getDescriptor

public final org.w3c.dom.Document getDescriptor()

importFile

public final boolean importFile(java.lang.String parentDirRelativePath,
                                java.lang.String name,
                                java.io.InputStream source,
                                boolean overwrite)
                         throws java.io.IOException

Import a file in the war file. The file could not be created for some reasons which are :

The parent dir exists and is a file
The parent dir does not exist and its creation failed
An underlying exception occurs when writing bytes from the source Inputstream to the target OutputStream

Parameters:: parentDirRelativePath - the parent relative path in the web app starting from the app root; name - the name the created file should have; source - the data of the target file; overwrite - if false and the file already exists nothing is done
Returns:: true if the file has been created
Throws:: java.io.IOException - if the file cannot be created

init

protected final void init(javax.servlet.ServletContext servletContext,
                          java.net.URL url,
                          java.lang.ClassLoader loader,
                          java.lang.String contextPath)
                   throws CannotCreatePortletWebAppException

Throws:: CannotCreatePortletWebAppException

readJBossAppDescriptor

private void readJBossAppDescriptor()

Read jboss-app.xml deployment and fetch the overriden id if it exists.

Returns:: the app id or null if it does not exists

toString

public java.lang.String toString()