...
If the portlet has important functions that could likely be reused by some other portlets it makes sense to use the servant mode. Based on the information received with the PortletRequest such portlets can distinguish the normal modes like VIEW,EDIT,HELP from the "servant" and perform different operations to interact with the client-portlet. To provide portlet-servant communication ServerPortletUtil on the servant side ServantUtil class is used. In the following example the groups manager portlet gets the request attribute sent by the client-portlet in the servant mode:
| Code Block | ||||
|---|---|---|---|---|
| ||||
if ( ServerPortletUtilServantUtil.isServantMode(request) ) { IGroupMember[] groupMembers = (IGroupMember[]) ServerPortletUtilServantUtil.getAttribute(request); ... } |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
/**
* The PortletServant interface is a uPortal wrapper around a JSR-168 portlet that implements
* the Portlet Servant mode. It provides methods for delegating rendering and action processing
* to the servant portlet, exchanging attribute values with the Client Portlet, to watch for it's completion and to get the results of the servant's
* operation.
*/
public interface IPortletServant {
/**
* Returns the servant ID given by the portlet servant locator.
* @return a <code>String</code> value
*/
public String getId();
/** Allows the Client Portlet to ascertain if the Servant has accomplished the requested task
* (Note that the way which a certain task is requested is not specified by this interface;
* normally it will be documented by a particular IPortletServant and require some particular
* configuration paramaters used to initialize the servant)
* @return boolean value
*/
public boolean isComplete(PortletRequest request);
public Object getServantData(PortletRequest request);
public void setServantData(PortletRequest request,Object value);
public void render(RenderRequest request, RenderResponse response) throws PortletException, IOException;
public void processAction(ActionRequest request, ActionResponse response) throws PortletException, java.io.IOException;
}
|
Client-side utilities
...