Direccionamiento de URL (Uniform Resource Locator) de portlets

Puede solicitar un portlet directamente a través de un URL (Uniform Resource Locator) para visualizar el contenido sin la agregación de portal. El servlet PortletServingServlet registra todas las aplicaciones web que contienen portlets. Es parecido al servlet FileServingServlet del contenedor web que presta servicio a los recursos. El servlet PortletServingServlet soporta la representación directa de los portlets en una página de navegador completa mediante una solicitud de URL.

Puede invocar cada uno de los portlets mediante su raíz de contexto y nombre con la correlación de URL /<nombre-portlet> que se crea para cada portlet. Por ejemplo:
http://<host>:<puerto>/<raíz-contexto>/<nombre-portlet>
Por ejemplo, 
 http://localhost:9080/portlets/TestPortlet1
La raíz de contexto identifica el archivo archivador de aplicación web (WAR) que contiene el portlet. El nombre de portlet identifica exclusivamente el portlet con una aplicación de portlet de un archivo WAR. El servlet DefaultDocumentFilter sólo da soporte a HTML, el código UTF8 y un formato de URL ampliado basado en el formato de URL básico.

Sólo puede visualizar un portlet cada vez utilizando el servlet PortletServingServlet. Si desea agregar varios portlets a la página, es necesario que utilice la biblioteca de distintivos de agregación. Consulte el artículo Agregación de portlet utilizando JavaServer Pages para obtener información adicional.

Como un portlet sólo proporciona la salida de fragmentos mientras que un servlet generalmente proporciona la salida de documentos, se introduce un mecanismo para convertir el fragmento en un documento denominado el filtro PortletDocumentFilter. De forma predeterminada, el filtro PortletDocumentFilter sólo da soporte a la conversión de HTML. La conversión se implementa utilizando un filtro de servlets antes de iniciar el servlet PortletServingServlet para devolver el contenido de portlet de un documento. Este filtro de servlets de documentos predeterminado sólo se aplica a las solicitudes de URL, no para includes o forwards mediante el método RequestDispatcher. Puede crear filtros de servlets para dar soporte a otros filtros de servlets de documentos adicionales de marcación. Consulte el artículo Conversión de fragmentos de portlet a un documento HTML para obtener información adicional.

El servlet PortletServingServlet no conserva las preferencias de portlets en un archivo XML o base de datos. Coloca las preferencias de portlet directamente en una cookie para almacenar las preferencias de forma persistente. Consulte el artículo sobre las preferencias de portlet para obtener información adicional sobre cómo cambiar este comportamiento.

Sintaxis de URL de portlet

Puede añadir un contexto de portal adicional como, por ejemplo, la modalidad de portlet o estado de ventana. Puede acceder al servlet PortletServingServlet utilizando una correlación de URL que tenga la siguiente estructura:
http://host:puerto/contexto/nombre-portlet [/portletwindow[/ver [/action | 
 /resource[/id=custom-id][/cacheability]] [/mode] [/state] [rparam][/?name]]]
Cualquier estructura de URL que difiera da como resultado una excepción com.ibm.wsspi.portletcontainer.InvalidURLException. Las series no se permiten como valores de parámetros y se crea una excepción InvalidURLException. A continuación, aparece una lista de parámetros válidos:
http:// host:puerto/contexto/nombre-portlet
Este el URL mínimo necesario para acceder a un portlet. Se crea una ventana de portlet predeterminada denominada "default". La variable nombre-porlet es sensible a las mayúsculas y minúsculas.
/portletwindow
Este parámetro identifica la ventana de porlet. Debe establecer este parámetro si opta por añadir más información de contexto de portal al URL.
/ver=mayor.menor
Este parámetro opcional se utiliza para definir la version de la API de portlet que se utiliza. Debe establecer este parámetro si opta por añadir más información de contexto de portal al URL. Sólo se da soporte a las versiones "1.0" y "2.0". Cualquier versión que difiera crea una excepción InvalidURLException.
/action
Éste es un parámetro necesario si llama al método action del portlet. Este parámetro de acción hace que se llame al proceso de acción del portlet. Después de que se complete la acción, se emite automáticamente una redirección para llamar al proceso de representación. Para controlar el subsiguiente proceso de representación, un filtro de servlets de documentos puede establecer un atributo de petición con el nombre "com.ibm.websphere.portlet.action" y el valor "redirect" para especificar que se devuelva PortletServingServlet después la acción, sin invocar el proceso de representación.
/mode=view | edit | help | modalidad-personalizada
Este parámetro opcional define la modalidad de portlet que se utiliza para representar el portlet. El valor predeterminado es "view".El valor no distingue entre mayúsculas y minúsculas. Por ejemplo, "Vew", "view" o "VIEW" dan como resultado la misma modalidad.
/state=normal | maximized | minimized | estado-personalizado
Este parámetro opcional define el estado de ventana que se utiliza para representar el portlet. El estado por defecto es "normal". El valor no distingue entre mayúsculas y minúsculas, por ejemplo, "Normal", "normal" o "NORMAL" dan como resultado el mismo estado.
* [ /rparam=nombre *[=valor] ]
Este parámetro opcional especifica los parámetros de representación. Repita esta cadena de parámetros para proporcionar más de un parámetro de representación. Por ejemplo, /rparam=invitation/rparam=days=Monday=Tuesday.
?name=value&name2=value2 …
A continuación pueden aparecer parámetros de consulta opcionalmente. El contenedor de portlets no les da soporte explícitamente, pero no invalidan el formato de URL.
/action | /resource
Este parámetro define los métodos del portlet al que se llama. Los valores válidos son No, Acción o Parámetro de recurso. No se utiliza ningún método no definido para llamar al método de representación. El parámetro de recurso sólo se soporta para los portlets JSR 286.
/resource [/id=custom-id] [/cacheability=cacheLevelFull | cacheLevelPortlet | cacheLevelPage]
Establezca este parámetro para definir el método del portlet al que debe llamarse. No se lleva a cabo ninguna redirección. No se llama a ningún otro método del portlet. Para controlar el parámetro de recurso, puede añadir otro parámetro de ID para proporcionar un identificador que sirva de recurso que se pasará a través del portlet. El parámetro de capacidad de colocación en memoria caché define el nivel de la memoria caché de la URL de este recurso. Este parámetro sólo se soporta con portlets JSR 286.
[AIX Solaris HP-UX Linux Windows][z/OS]La siguiente lista incluye ejemplos de URL de JSR 168 y JSR 286 válidos:
  • http:// localhost:9080/sample/WorldClock
  • http:// localhost:9080/sample/WorldClock/myPortlet/ver=1.0/mode=edit/rparam=timezone=UTC
  • http:// localhost:9080/sample/WorldClock/myPortlet/ver=1.0/action/state=maximized?timezone=UTC
  • http://localhost:9080/sample/WorldClock/myPortlet/ver=2.0/resource/id=somePicture.jpg
[IBM i]La siguiente lista incluye ejemplos de URL de JSR 168 y JSR 286 válidos:
  • http:// your.server.name:9080/sample/WorldClock
  • http:// your.server.name:9080/sample/WorldClock/myPortlet/ver=1.0/mode=edit/rparam=timezone=UTC
  • http:// your.server.name:9080/sample/WorldClock/myPortlet/ver=1.0/action/state=maximized?timezone=UTC
  • http://your.server.name:9080/sample/WorldClock/myPortlet/ver=2.0/resource/id=somePicture.jpg

Icon that indicates the type of topic Concept topic



Timestamp icon Last updated: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=cport_url_address
File name: cport_url_address.html