Capacidade de Endereçamento da URL (Uniform Resource Locator) do Portlet

É possível solicitar um portlet diretamente por meio de uma URL (Uniform Resource Locator) para exibir seu conteúdo sem agregação do portal. O servlet PortletServingServlet registra cada aplicativo da Web contendo portlets. Ele é semelhante ao servlet FileServingServlet do contêiner da Web que entrega recursos. O servlet PortletServingServlet suporta renderização direta de portlets em uma página completa do navegador por um pedido de URL.

É possível chamar cada portlet pela sua raiz de contexto e nome com o mapeamento de URL /<portlet-name> criado para cada portlet. Por exemplo:
http://<host>:<port>/<context-root>/<portlet-name> For example, 
 http://localhost:9080/portlets/TestPortlet1
A raiz de contexto identifica o arquivo Web application archive (WAR) que contém o portlet. O nome do portlet identifica exclusivamente o portlet com um aplicativo de portlet de um arquivo WAR. O servlet DefaultDocumentFilter suporta apenas HTML, codificação UTF8 e um formulário de URL estendido baseado no formulário de URL básico.

O servlet PortletServingServlet permite exibir apenas um portlet de cada vez. Para agregar vários portlets na página, é necessário utilizar a biblioteca de tags de agregação. Consulte a Agregação de Portlet usando o artigo Páginas JavaServer para obter informações adicionais.

Como um portlet fornece apenas saída de fragmento, enquanto que um servlet geralmente fornece saída de documento, é introduzido um mecanismo para converter o fragmento em um documento, chamado de filtro PortletDocumentFilter. Por padrão, o filtro PortletDocumentFilter suporta apenas conversão em HTML. A conversão é implementada utilizando um filtro de servlet antes de o servlet PortletServingServlet ser iniciado para retornar o conteúdo do portlet dentro de um documento. Esse filtro de servlet de documento padrão aplica-se apenas a pedidos de URL, não a inclusões ou a redirecionamentos que utilizem o método RequestDispatcher. É possível criar filtros de servlet para suportar outros filtros de servlet de documento adicionais de marcações. Consulte o artigo Convertendo Fragmentos de Portlet para um Documento HTML para obter informações adicionais

No servlet PortletServingServlet as preferências do portlet não permanecem em um arquivo ou um banco de dados XML. Ele as coloca diretamente em um cookie para armazená-las de forma persistente. Consulte o artigo de preferências do Portlet para obter informações adicionais sobre como alterar este comportamento.

Sintaxe de URL do Portlet

É possível incluir contexto adicional do portal, como modo ou estado da janela do portlet. O servlet PortletServingServlet pode ser acessado utilizando um mapeamento de URL que possui a seguinte estrutura:
http://host:port/context/portlet-name [/portletwindow[/ver [/action | /resource[/id=custom-id][/cacheability]] [/mode] [/state] [rparam][/?name]]]
Qualquer estrutura diferente de URL resultará em uma exceção com.ibm.wsspi.portletcontainer.InvalidURLException. As cadeias vazias não são permitidas como valores de parâmetros e criam uma exceção InvalidURLException. A seguir, uma lista de parâmetros válidos:
http:// host:port/context/portlet-name
Essa é a URL mínima requerida para acessar um portlet. É criada uma janela de portlet padrão chamada "default". A variável portlet-name faz distinção entre maiúsculas e minúsculas.
/portletwindow
Esse parâmetro identifica a janela do portlet. Será necessário configurar esse parâmetro se você optar por incluir mais informações de contexto do portal na URL.
/ver=major.minor
Esse parâmetro opcional é utilizado para definir a versão da API do portlet utilizada. Será necessário configurar esse parâmetro se você optar por incluir mais informações de contexto do portal na URL. Somente as versões "1.0" e "2.0" são suportadas. Qualquer outra versão cria uma exceção InvalidURLException.
/action
Esse será um parâmetro obrigatório se você chamar o método de ação do portlet. O parâmetro de ação faz com que o processo de ação do portlet seja chamado. Após a conclusão da ação, um redirecionamento é emitido automaticamente para chamar o processo de apresentação. Para controlar o processo de renderização subsequente, um filtro de servlet do documento pode configurar um atributo de solicitação com nome "com.ibm.websphere.portlet.action" e valor "redirecionar", para especificar se o PortletServingServlet é retornado diretamente depois da ação sem chamar o processo de renderização.
/mode=view | edit | help | custom-mode
Esse parâmetro opcional define o modo de portlet utilizado para apresentar o portlet. O modo padrão é "view". O valor não faz distinção entre maiúsculas e minúsculas. Por exemplo, "Vew", "view" ou "VIEW" resulta no mesmo modo.
/state=normal | maximized | minimized | custom-state
Esse parâmetro opcional define o estado da janela utilizado para apresentar o portlet. O estado padrão é "normal". O valor não faz distinção entre maiúsculas e minúsculas, por exemplo, "Normal", "normal" ou "NORMAL" resulta no mesmo estado.
* [ /rparam=name *[=value] ]
Esse parâmetro opcional especifica parâmetros de apresentação para o portlet. Repita essa cadeia de parâmetros para fornecer mais de um parâmetro de apresentação. Por exemplo, /rparam=invitation/rparam=days=Monday=Tuesday.
?name=value&name2=value2 …
Parâmetros de consulta podem seguir opcionalmente. Eles não são suportados explicitamente pelo contêiner do portlet, mas não invalidam o formato da URL.
/action | /resource
Esse parâmetro define os métodos do portlet que é chamado. Os valores válidos são no, action ou resource parameter. O método específico definido, no, chama o método de renderização. O método resource parameter só é suportado para portlets JSR 286.
/resource [/id=custom-id] [/cacheability=cacheLevelFull | cacheLevelPortlet | cacheLevelPage]
Configure esse parâmetro para definir o método do portlet a ser chamado. Nenhum redirecionamento ocorre. Nenhum outro método do portlet é chamado. Para controlar o parâmetro de recurso, você pode incluir um parâmetro de ID adicional para fornecer um identificador de atendimento de recurso que seja transmitido pelo portlet. O parâmetro de capacidade de cache define o nível do cache dessa URL de recurso. Esse parâmetro é suportado somente com portlets JSR 286.
[AIX Solaris HP-UX Linux Windows][z/OS]A lista a seguir inclui exemplos de URLs JSR 168 e JSR 286 válidas:
  • 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]A lista a seguir inclui exemplos de URLs JSR 168 e JSR 286 válidas:
  • 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

Ícone que indica o tipo de tópico Tópico de Conceito



Ícone de registro de data e hora Última atualização: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=cport_url_address
Nome do arquivo: cport_url_address.html