当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

PortletContainer - 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.portlet.container
Class PortletContainer

java.lang.Object
  org.jboss.portal.portlet.container.PortletContainer

All Implemented Interfaces:

Portlet

---

public class PortletContainer

extends java.lang.Object

implements Portlet

Version:

$Revision: 5448 $

Author:

Julien Viet

---

Field Summary
protected  PortletApplicationImpl	application           .
protected  PortletResourceBundleManager	bundleMgr           .
protected  java.lang.String	className           The portlet implementation class name.
protected  PortletConfig	config           The portlet config.
protected  ContentTypes	contentTypes           .
protected  PortletInfo	info           Return info.
protected  JBossPortletMetaData	jbossMetaData           .
protected  org.jboss.logging.Logger	log           Logger.
protected  PortletMetaData	metaData           .
protected  Portlet	portlet           The portlet instance.
protected  PortletContext	portletContext           .
protected  PreferencesValidator	preferencesValidator           The preference validator, this is not exposed as runtime meta data as it is only used by the JSR 168 portlet container implementation.
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.

 

Constructor Summary

PortletContainer(PortletApplicationImpl application, PortletMetaData metaData, JBossPortletMetaData jbossMetaData)

 

Method Summary
private  void	destroyPortlet(Portlet portlet)           Destroy the portlet.
PortletInvocationResponse	dispatch(PortletInvocation invocation)
PortletApplication	getApplication()
PortletConfig	getConfig()
ContentTypes	getContentTypes()
PortletContext	getContext()           Return the portlet context.
PortletInfo	getInfo()           Return the portlet info.
JBossPortletMetaData	getJBossMetaData()
PortletMetaData	getMetaData()
java.lang.String	getName()
Portlet	getPortlet()
PreferencesValidator	getPreferencesValidator()
java.util.Map	getSecurityRoleRefsMap()
java.util.Set	getUserDataConstraints()
Valve	getValve()
private  void	initPortlet(Portlet portlet, PortletConfig config)           Initialize the portlet.
protected  PortletInvocationResponse	invokeAction(ActionInvocation invocation)
protected  PortletInvocationResponse	invokeRender(RenderInvocation invocation)
boolean	isRemote()           Determines whether the described portlet is remote or not.
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.jboss.logging.Logger log

Logger.

---

application

protected PortletApplicationImpl application

.

---

metaData

protected PortletMetaData metaData

.

---

jbossMetaData

protected JBossPortletMetaData jbossMetaData

.

---

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

.

---

bundleMgr

protected PortletResourceBundleManager bundleMgr

.

---

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.

---

info

protected PortletInfo info

Return info.

---

portletContext

protected PortletContext portletContext

.

---

preferencesValidator

protected PreferencesValidator preferencesValidator

The preference validator, this is not exposed as runtime meta data as it is only used by the JSR 168 portlet container implementation.

Constructor Detail

PortletContainer

public PortletContainer(PortletApplicationImpl application,
                        PortletMetaData metaData,
                        JBossPortletMetaData jbossMetaData)

Method Detail

getInfo

public PortletInfo getInfo()

Description copied from interface: Portlet

Return the portlet info.

Specified by:

getInfo in interface Portlet

Returns:

the portlet info

---

getContext

public PortletContext getContext()

Description copied from interface: Portlet

Return the portlet context.

Specified by:

getContext in interface Portlet

Returns:

the portlet context

---

isRemote

public boolean isRemote()

Description copied from interface: Portlet

Determines whether the described portlet is remote or not.

Specified by:

isRemote in interface Portlet

Returns:

true if the described portlet runs in a remote context (such as WSRP), false otherwise

---

getName

public java.lang.String getName()

---

getMetaData

public PortletMetaData getMetaData()

---

getJBossMetaData

public JBossPortletMetaData getJBossMetaData()

---

isStarted

public boolean isStarted()

---

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()

---

getSecurityRoleRefsMap

public java.util.Map getSecurityRoleRefsMap()

---

getApplication

public PortletApplication getApplication()

---

getValve

public Valve getValve()

---

getUserDataConstraints

public java.util.Set getUserDataConstraints()

---

getPreferencesValidator

public PreferencesValidator getPreferencesValidator()

---

toString

public java.lang.String toString()

---

initPortlet

private void initPortlet(Portlet portlet,
                         PortletConfig config)
                  throws PortletException

Initialize the portlet.

Throws:

PortletException

---

destroyPortlet

private void destroyPortlet(Portlet portlet)

Destroy the portlet.

---

dispatch

public PortletInvocationResponse dispatch(PortletInvocation invocation)
                                   throws PortletInvokerException,
                                          InvocationException

Throws:

PortletInvokerException

InvocationException

---

invokeAction

protected PortletInvocationResponse invokeAction(ActionInvocation invocation)
                                          throws java.io.IOException,
                                                 PortletException

Throws:

java.io.IOException

PortletException

---

invokeRender

protected PortletInvocationResponse invokeRender(RenderInvocation invocation)
                                          throws java.io.IOException,
                                                 PortletException

Throws:

java.io.IOException

PortletException

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---