| org.apache.cocoon.portal.coplet.adapter.CopletAdapter
All known Subclasses: org.apache.cocoon.portal.coplet.adapter.impl.AbstractCopletAdapter,
| CopletAdapter | | public interface CopletAdapter extends Component(Code) | | This is the "portlet" implementation.
A coplet adapter is the interface between the portal engine and
the implementation of a coplet.
Usually there is only one instance of an adapter (= singleton).
Whenever an instance of this coplet is rendered, the
adapter is invoked to render the coplet.
The behaviour of the adapter can be controlled by a set of
parameters. In general, the coplet base data defines the default
for all coplets, but the value can be overriden by the coplet
data. The coplet base data stores the information in the coplet
config map whereas the coplet data stores them in the attributes.
Apart from that the keys and the data types are the same.
Configuration:
buffer - A boolean value (default is false) that defines if the
xml data stream from the coplet is buffered. If the stream
is not buffered and an exception occurs then the whole
portal will be rendered invalid.
timeout - An integer value (default is endless) that defines the
maximum time (in seconds) the coplet has to deliver it's content.
If the timeout is reached the content is assumed as not
gettable. If you set a timeout, the content is automatically
buffered.
author:
Carsten Ziegeler
author:
Volker Schmitt
version:
CVS $Id: CopletAdapter.java 433543 2006-08-22 06:22:54Z crossley $ |
| destroy | | void destroy(CopletInstanceData coplet)(Code) | | Destroy the coplet
This method is invoked when a coplet instance will be destroyed
For each coplet, this method is only invoked once.
Parameters:
coplet - |
| init | | void init(CopletInstanceData coplet)(Code) | | Initialize the coplet
This method is called immediately after a new instance is created.
For each coplet, this method is only invoked once.
Parameters:
coplet - The coplet |
| login | | void login(CopletInstanceData coplet)(Code) | | User logs in to a coplet
This method is invoked when a user logs in for each coplet instance
of the user
|
| logout | | void logout(CopletInstanceData coplet)(Code) | | User logs out from a coplet
This method is invoked when a user logs out for each coplet instance
of this user.
|
|
|