站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.2 API 英文版文档

PortletWebApp - JBOSS Portal 2.2 API 英文版文档


org.jboss.portal.portlet
Class PortletWebApp

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport
      extended byorg.jboss.system.ServiceMBeanSupport
          extended byorg.jboss.portal.common.system.AbstractJBossService
              extended byorg.jboss.portal.portlet.PortletWebApp
All Implemented Interfaces:
javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, org.jboss.system.Service, org.jboss.system.ServiceMBean, WebApp

public class PortletWebApp
extends AbstractJBossService
implements WebApp


Field Summary
protected  APIFactory apiFactory
           
protected  PortletApplicationMetaData metadata
           
protected  PortletContext portletContext
           
protected  java.util.Map portletModes
           
protected  java.util.LinkedHashMap portlets
           
protected  java.lang.String version
           
protected  java.util.Map windowStates
           
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.system.ServiceMBean
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
PortletWebApp(PortletApplicationMetaData metaData)
           
 
Method Summary
 APIFactory getAPIFactory()
           
 Component getComponent(java.lang.String name)
          Return a specific component.
 java.util.Set getComponents()
          Return the set of components part of this web application.
 java.lang.String getContextPath()
          Return the context path.
 java.lang.String getId()
          Return the web app id.
 java.lang.ClassLoader getLoader()
          Return the application classloader.
 PortletApplicationMetaData getMetadata()
           
 PortletContext getPortletContext()
           
 java.util.Map getPortletModes()
           
 javax.servlet.ServletContext getServletContext()
          Return the servlet context.
 java.lang.String getVersion()
           
 java.util.Map getWindowStates()
           
 void setAPIFactory(APIFactory apiFactory)
           
 void start(java.lang.String portletName)
           
 void startService()
           
 void stop(java.lang.String portletName)
           
 void stopService()
           
 java.lang.String toString()
           
 
Methods inherited from class org.jboss.portal.common.system.AbstractJBossService
create, destroy, getState, getStateString, start, stop
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport
createService, destroyService, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport
addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

portlets

protected java.util.LinkedHashMap portlets

metadata

protected PortletApplicationMetaData metadata

portletContext

protected PortletContext portletContext

version

protected java.lang.String version

portletModes

protected java.util.Map portletModes

windowStates

protected java.util.Map windowStates

apiFactory

protected APIFactory apiFactory
Constructor Detail

PortletWebApp

public PortletWebApp(PortletApplicationMetaData metaData)
Method Detail

getId

public java.lang.String getId()
Description copied from interface: WebApp
Return the web app id.

Specified by:
getId in interface WebApp

getAPIFactory

public APIFactory getAPIFactory()

setAPIFactory

public void setAPIFactory(APIFactory apiFactory)

getMetadata

public PortletApplicationMetaData getMetadata()

startService

public void startService()
                  throws java.lang.Exception
Throws:
java.lang.Exception

stopService

public void stopService()
                 throws java.lang.Exception
Throws:
java.lang.Exception

getVersion

public java.lang.String getVersion()

getPortletContext

public PortletContext getPortletContext()

getPortletModes

public java.util.Map getPortletModes()

getWindowStates

public java.util.Map getWindowStates()

start

public void start(java.lang.String portletName)
           throws java.lang.Exception
Throws:
java.lang.Exception

stop

public void stop(java.lang.String portletName)
          throws java.lang.Exception
Throws:
java.lang.Exception

getComponents

public java.util.Set getComponents()
Description copied from interface: WebApp
Return the set of components part of this web application.

Specified by:
getComponents in interface WebApp

getComponent

public Component getComponent(java.lang.String name)
Description copied from interface: WebApp
Return a specific component.

Specified by:
getComponent in interface WebApp

getServletContext

public javax.servlet.ServletContext getServletContext()
Description copied from interface: WebApp
Return the servlet context.

Specified by:
getServletContext in interface WebApp

getContextPath

public java.lang.String getContextPath()
Description copied from interface: WebApp
Return the context path.

Specified by:
getContextPath in interface WebApp

getLoader

public java.lang.ClassLoader getLoader()
Description copied from interface: WebApp
Return the application classloader.

Specified by:
getLoader in interface WebApp

toString

public java.lang.String toString()