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

AbstractUniversalTestPortlet - 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.test.framework.portlet.components
Class AbstractUniversalTestPortlet

java.lang.Object
  org.jboss.portal.test.framework.portlet.components.AbstractUniversalTestPortlet

All Implemented Interfaces:

Portlet

Direct Known Subclasses:

GetResourceBundleDuringInitPortlet, InitializeBeforeHandlePortlet, InlineValuesNotInResourceBundlePortlet, InlineValuesWithNoResourceBundleDefinedPortlet, LoggingPortlet, NotInvokeModeDeclaredForNotSupportedMarkupHelperPortlet, PortletA, PortletB, PortletExceptionDuringInitPortlet, ResourceBundleCascadePortlet, ResourceBundlePortlet, RuntimeExceptionDuringInitPortlet, TestActionWithPortletModePortlet, UnavailableExceptionDuringInitPortlet, UTP1, UTP10, UTP2, UTP3, UTP4, UTP5, UTP6, UTP7, UTP8, UTP9

---

public abstract class AbstractUniversalTestPortlet

extends java.lang.Object

implements Portlet

Universal test portlet that enables to reuse portlet instances across several tests

Version:

$Revision: 5493 $

Author:

Boleslaw Dawidowicz

---

Field Summary
private  Joinpoint	actionJoinpoint           Joinpoint for action phase.
private  java.lang.String	componentId           The component id.
private  PortletConfig	config           To keep PortletConfig for some tests*-.
private  org.apache.log4j.Logger	log           .
private  Joinpoint	renderJoinpoint           Joinpoint for render phase.

 

Constructor Summary

AbstractUniversalTestPortlet()           Construct a test portlet with a test id computed with the method getComponentId().

AbstractUniversalTestPortlet(java.lang.String componentId)           Construct a test portlet with the specified id.

 

Method Summary
protected  java.lang.String	createComponentId()           Get the componentId from the class name.
protected  org.apache.log4j.Logger	createLogger()           Can be subclassed to provide an alternative way to create the logger.
void	destroy()           Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.
Joinpoint	getActionJointpoint()
protected  java.lang.String	getComponentId()
org.apache.log4j.Logger	getLogger()           Return the logger.
PortletConfig	getPortletConfig()           Returns the PortletConfig object of this portlet.
PortletContext	getPortletContext()           Returns the PortletContext of the portlet application the portlet is in.
Joinpoint	getRenderJointpoint()
private  Sequence	getSequence()           Returns Sequence for current testId Returns null if there is no Sequence for current testId
private  SequenceRegistry	getSequenceRegistry()           Returns SequenceRegistry which should be injected into ServletContext Returns null if there is no SequenceRegistry in context
void	init(PortletConfig config)           Called by the portlet container to indicate to a portlet that the portlet is being placed into service.
private  void	init(java.lang.String componentId)
void	processAction(ActionRequest req, ActionResponse resp)           invokes current action from Sequence
void	render(RenderRequest req, RenderResponse resp)           Invokes current action from Sequence.
protected  void	reset()

 

Methods inherited from class java.lang.Object

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

 

Field Detail

log

private final org.apache.log4j.Logger log

.

---

componentId

private java.lang.String componentId

The component id.

---

renderJoinpoint

private Joinpoint renderJoinpoint

Joinpoint for render phase.

---

actionJoinpoint

private Joinpoint actionJoinpoint

Joinpoint for action phase.

---

config

private PortletConfig config

To keep PortletConfig for some tests*-.

Constructor Detail

AbstractUniversalTestPortlet

public AbstractUniversalTestPortlet()

Construct a test portlet with a test id computed with the method getComponentId().

---

AbstractUniversalTestPortlet

public AbstractUniversalTestPortlet(java.lang.String componentId)

Construct a test portlet with the specified id.

Parameters:

componentId -

Method Detail

init

private void init(java.lang.String componentId)

---

init

public void init(PortletConfig config)
          throws PortletException

Description copied from interface: Portlet

Called by the portlet container to indicate to a portlet that the portlet is being placed into service.

The portlet container calls the init method exactly once after instantiating the portlet. The init method must complete successfully before the portlet can receive any requests.

The portlet container cannot place the portlet into service if the init method

1. Throws a PortletException
2. Does not return within a time period defined by the portlet container.

Specified by:

init in interface Portlet

Parameters:

config - a PortletConfig object containing the portlet's configuration and initialization parameters

Throws:

PortletException - if an exception has occurred that interferes with the portlet's normal operation.

---

getPortletConfig

public PortletConfig getPortletConfig()

Returns the PortletConfig object of this portlet.

Returns:

the PortletConfig object of this portlet

---

getPortletContext

public PortletContext getPortletContext()

Returns the PortletContext of the portlet application the portlet is in.

Returns:

the portlet application context

---

processAction

public final void processAction(ActionRequest req,
                                ActionResponse resp)
                         throws PortletException,
                                PortletSecurityException,
                                java.io.IOException

invokes current action from Sequence

Specified by:

processAction in interface Portlet

Parameters:

req -

resp -

Throws:

PortletException

PortletSecurityException

java.io.IOException

---

render

public final void render(RenderRequest req,
                         RenderResponse resp)
                  throws PortletException,
                         PortletSecurityException,
                         java.io.IOException

Invokes current action from Sequence. If failed AssertResult was returned in previouse portlet action phase it will be marshalled.

Specified by:

render in interface Portlet

Parameters:

req -

resp -

Throws:

PortletException

PortletSecurityException

java.io.IOException

---

destroy

public void destroy()

Description copied from interface: Portlet

Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.

Before the portlet container calls the destroy method, it should allow any threads that are currently processing requests within the portlet object to complete execution. To avoid waiting forever, the portlet container can optionally wait for a predefined time before destroying the portlet object.

This method enables the portlet to do the following:

• clean up any resources that it holds (for example, memory, file handles, threads)
• make sure that any persistent state is synchronized with the portlet current state in memory.

Specified by:

destroy in interface Portlet

---

createComponentId

protected java.lang.String createComponentId()

Get the componentId from the class name.

---

getSequenceRegistry

private SequenceRegistry getSequenceRegistry()

Returns SequenceRegistry which should be injected into ServletContext Returns null if there is no SequenceRegistry in context

Returns:

SequenceRegistry

---

getSequence

private Sequence getSequence()
                      throws PortletException

Returns Sequence for current testId Returns null if there is no Sequence for current testId

Returns:

Throws:

PortletException - if there is no SequenceRegistry

---

getComponentId

protected java.lang.String getComponentId()

---

getActionJointpoint

public Joinpoint getActionJointpoint()

---

getRenderJointpoint

public Joinpoint getRenderJointpoint()

---

reset

protected void reset()

---

createLogger

protected org.apache.log4j.Logger createLogger()

Can be subclassed to provide an alternative way to create the logger.

---

getLogger

public final org.apache.log4j.Logger getLogger()

Return the logger.

---

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

---