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

PortletContainer - JBOSS Portal 2.2 API 英文版文档


org.jboss.portal.portlet
Class PortletContainer

java.lang.Object
  extended byorg.jboss.portal.portlet.PortletContainer
All Implemented Interfaces:
Adaptable, Component

public class PortletContainer
extends java.lang.Object
implements Component


Field Summary
protected  java.util.Map classAdapters
          Map of class adapters.
protected  java.lang.String className
          The portlet implementation class name.
protected  PortletConfig config
          The portlet config.
protected  ContentTypes contentTypes
          .
protected  org.apache.log4j.Logger log
          Logger.
protected  PortletMetaData metadata
          .
protected  java.util.Map plugins
          Map of plugins.
protected  Portlet portlet
          The portlet instance.
protected  ResourceBundles resourceBundles
          .
protected  java.util.Map securityRoleRefsMap
          Give the correspondance between role name and role link.
protected  boolean started
          Are we started or not
protected  java.util.Set userDataConstraints
          User data constraint.
protected  Valve valve
          The invocation valve.
protected  PortletWebApp webApp
          .
 
Constructor Summary
PortletContainer(PortletWebApp webApp, PortletMetaData metadata)
           
 
Method Summary
 void dispatch(ComponentInvocation invocation)
          Deliver the api call to the target.
 java.lang.Object getAdapter(java.lang.Class adapterClass)
          Return an adapter for the adapter class.
 PortletConfig getConfig()
           
 ContentTypes getContentTypes()
          Return the set of content types and modes associated to each content type;
 LocalizedString getDescription()
           
 LocalizedString getDisplayName()
           
 java.lang.String getId()
          Return the component id.
 java.lang.String getName()
          Return the component name.
 Portlet getPortlet()
           
 ResourceBundles getResourceBundles()
           
 java.util.Map getSecurityRoleRefsMap()
           
 java.util.Set getUserDataConstraints()
           
 Valve getValve()
           
 WebApp getWebApp()
          Return the web application owner of this component.
protected  Result invokeAction(ActionInvocation invocation)
           
protected  Result invokeRender(RenderInvocation invocation)
           
 boolean isStarted()
           
 void start()
           
 void stop()
           
 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
Logger.


webApp

protected PortletWebApp webApp
.


metadata

protected PortletMetaData metadata
.


className

protected java.lang.String className
The portlet implementation class name.


config

protected PortletConfig config
The portlet config.


portlet

protected Portlet portlet
The portlet instance.


contentTypes

protected ContentTypes contentTypes
.


resourceBundles

protected ResourceBundles resourceBundles
.


valve

protected final Valve valve
The invocation valve.


securityRoleRefsMap

protected java.util.Map securityRoleRefsMap
Give the correspondance between role name and role link.


started

protected boolean started
Are we started or not


userDataConstraints

protected java.util.Set userDataConstraints
User data constraint.


plugins

protected java.util.Map plugins
Map of plugins.


classAdapters

protected java.util.Map classAdapters
Map of class adapters.

Constructor Detail

PortletContainer

public PortletContainer(PortletWebApp webApp,
                        PortletMetaData metadata)
Method Detail

getId

public java.lang.String getId()
Description copied from interface: Component
Return the component id.

Specified by:
getId in interface Component

getName

public java.lang.String getName()
Description copied from interface: Component
Return the component name.

Specified by:
getName in interface Component

isStarted

public boolean isStarted()

getDisplayName

public LocalizedString getDisplayName()

getDescription

public LocalizedString getDescription()

start

public void start()
           throws java.lang.Exception,
                  PortletInitializationException
Throws:
java.lang.Exception
PortletInitializationException

stop

public void stop()

getConfig

public PortletConfig getConfig()

getPortlet

public Portlet getPortlet()

getContentTypes

public ContentTypes getContentTypes()
Description copied from interface: Component
Return the set of content types and modes associated to each content type;

Specified by:
getContentTypes in interface Component

getResourceBundles

public ResourceBundles getResourceBundles()

getSecurityRoleRefsMap

public java.util.Map getSecurityRoleRefsMap()

getWebApp

public WebApp getWebApp()
Description copied from interface: Component
Return the web application owner of this component.

Specified by:
getWebApp in interface Component

getValve

public Valve getValve()

getUserDataConstraints

public java.util.Set getUserDataConstraints()

toString

public java.lang.String toString()

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapterClass)
Description copied from interface: Adaptable
Return an adapter for the adapter class.

Specified by:
getAdapter in interface Adaptable
Returns:
the adapter object or null if no adapter is found

dispatch

public void dispatch(ComponentInvocation invocation)
              throws InvocationException,
                     InvocationRuntimeException
Description copied from interface: Component
Deliver the api call to the target.

Specified by:
dispatch in interface Component
Throws:
InvocationException
InvocationRuntimeException

invokeAction

protected Result invokeAction(ActionInvocation invocation)
                       throws java.lang.Exception
Throws:
java.lang.Exception

invokeRender

protected Result invokeRender(RenderInvocation invocation)
                       throws java.lang.Exception
Throws:
java.lang.Exception