javax.portlet.annotations

Interface PortletSerializable

public interface PortletSerializable

This interface must be implemented by RenderStateScoped beans in order to allow the bean portlet container to intialize the bean at the beginning of a request and passivate the bean at the end of the request.

These methods are not intended to be called by application code.

A @RenderStateScoped bean must be a valid bean; in particular, it must provide a default constructor or be constructable through an @Produces method or field.

Note that only changes made to the bean state during ActionMethod or EventMethod execution are stored in the render state. Changes made during RenderMethod, ServeResourceMethod, or HeaderMethod execution will not be available during subsequent requests.

Since:

3.0

See Also:

RenderStateScoped

Method Summary

Modifier and Type	Method and Description
void	deserialize(String[] state) The bean portlet container calls this method at the beginning of every portlet request method that uses the bean.
String[]	serialize() The portlet bean container calls this method after ActionMethod or EventMethod execution to obtain the bean state.

Method Detail

serialize

String[] serialize()

The portlet bean container calls this method after ActionMethod or EventMethod execution to obtain the bean state.

The bean developer should take care to include all internal bean data in the returned state that is necessary for properly initializing the bean when the portlet bean container calls the deserialize method.

If no bean data has been set, this method should return an empty array or null in order to avoid setting extraneous parameters.

Returns:

The bean state as a string array.

deserialize

void deserialize(String[] state)

The bean portlet container calls this method at the beginning of every portlet request method that uses the bean.

The string array render state data is the same array provided to the container by the serialize method. The bean should reconstruct its internal state during execution of this method.

If no data is available for the portlet, for example because because no ActionMethod or EventMethod has been executed for the portlet, the state parameter will be an empty array.

If the state array is empty, the bean implementation should provide approriate default values for its internal variables.

Parameters:

state - The bean state as string array. The array will be empty if bean data has not yet been set.