| org.apache.wsrp4j.producer.provider.DescriptionHandler
All known Subclasses: com.liferay.portal.wsrp.DescriptionHandlerImpl,
| DescriptionHandler | | public interface DescriptionHandler (Code) | | This interface provides methods to access portlet descriptions as well as
the service description.
author:
Stefan Behl |
| getPortletDescription | | public PortletDescription getPortletDescription(String portletHandle, RegistrationContext regContext, UserContext userContext, String[] desiredLocales) throws WSRPException(Code) | | Returns an PortletDescription for the given PortletHandle based on the input
arguments. On how the desiredLocales and sendAllLocales parameter affects the
returned PortletDescription, please see the method getProducerOfferedPortletDescriptions().
Parameters:
portletHandle - the handle of a particular portlet
Parameters:
regContext - contains data related to a particular registration(e.g. the registration handle and state)
Parameters:
userContext - contains the user context
Parameters:
desiredLocales - array of requested locales, if null request all available locales PortletDescription |
| getPortletDescription | | public PortletDescription getPortletDescription(String portletHandle) throws WSRPException(Code) | | Returns a complete PortletDescription for the given PortletHandle.
Parameters:
portletHandle - the handle of a particular portlet PortletDescription |
| getProducerOfferedPortletDescriptions | | public PortletDescription[] getProducerOfferedPortletDescriptions(RegistrationContext regContext, String[] desiredLocales) throws WSRPException(Code) | | Returns an array containing all portlet descriptions, i.e. one portlet
description per producer offered portlet.
Parameters:
regContext - contains data related to a particular registration(e.g. the registration handle and state)
Parameters:
desiredLocales - array of requested locales, if null request all available locales Array of PortletDescription-objects. |
| getServiceDescription | | public ServiceDescription getServiceDescription(RegistrationContext regContext, String[] desiredLocales) throws WSRPException(Code) | | Returns a ServiceDescription, based on the input arguments.
See the getProducerOfferedPortletDescriptions() method for more details.
Parameters:
regContext - contains data related to a particular registration(e.g. the registration handle and state)
Parameters:
desiredLocales - array of requested locales, if null request all available locales |
| isRegistrationRequired | | public boolean isRegistrationRequired() throws WSRPException(Code) | | Indicates whether registration is required (for this Producer) or not.
Returns true if registration is required, otherwise false. |
|
|