csbase.servlet

Class InitServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

csbase.servlet.InitServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class InitServlet
extends javax.servlet.http.HttpServlet

Servlet responsável por construir uma página JNLP para carregar uma aplicação via Java Web Start.

A página construída é uma cópia de um página original, específica para cada aplicação, na qual são modificados alguns parâmetros e incluídos outros. Esses parâmetros são passados através da requisição ( HttpServletRequest) ou são obtidos do arquivo de propriedades (que deve ser copiado para o diretório WEB-INF pelo script de inicialização do sistema).

A página original deve existir na mesma URL base deste servlet. O nome da página pode ser fornecido através do parâmetro page. Se o nome não for fornecido, é assumido index.jnlp.

Este servlet trata os seguintes marcadores (em parênteses o nome da propriedade correspondente, quando aplicável):

• server_host_name (Server.hostName) : nome do servidor.
• server_host_addr (Server.hostAddr) : endereço IP do servidor.
• server_port_http : porta HTTP do servidor. É obtido diretamente do request feito ao servlet.
• server_port_rmi (ver método getServerRMIport()): porta RMI do servidor. É o único parãmetro que pode não estar definido na URL nem no arquivo de propriedades (neste caso o valor default 1099 será usado).
• client_addr : endereço IP do cliente. É obtido diretamente do request feito ao servlet.

Os demais parâmetros recebidos pelo servlet (com exceção do parâmetro page) são repassados à aplicação através da tag <argument> do JNLP.

IMPORTANTE:

• Os parâmetros referentes ao nome ou endereço do servidor, assim como a porta RMI para conexão, só podem ser definidos via arquivo de propriedades. Isto é feito desta forma porque outros servlets fazem conexão direta com o servidor usando estes valores, e o custo de passar estes parâmetros via URL nos casos em que isto seria necessário supera os benefícios.
• Este mecanismo só funciona com arquivos JNLP se as seguintes condições forem observadas:
  • a tag <jnlp> não pode possuir o parâmetro href. Caso contrário o Java WebStart tentará obter o arquivo diretamente do Tomcat, sem passar pelo servlet, e as traduções não serão aplicadas
  • outros arquivos JNLP referenciados a partir do arquivo principal via tag <extension> não podem possuir os parâmetros codebase nem href nas suas tags <jnlp>, pelo mesmo motivo acima

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PROPERTIES_DIR Diretório dentro de tomcat/webapps/[sistema] para onde será copiado o arquivo de propriedades.
protected static java.lang.String	PROPERTIES_FILE Arquivo com as propriedades do sistema, mantido pelo administrador.

Constructor Summary

Constructors

Constructor and Description
InitServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Constrói e retorna uma página JNLP, usando as informações fornecidas.
protected java.lang.String	getClientRMIport() Obtém a porta RMI para comunicação com o servidor.
protected java.lang.String	getProperty(java.lang.String key) Retorna o valor associado à propriedade.
protected java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Retorna o valor associado à propriedade ou um valor default, caso esta não tenha sido definida.
protected java.lang.String	getRMIpath() Obtém o path RMI para o servidor no formato rmi://IP_SERVIDOR:PORTA_RMI/ .
protected java.lang.String	getServerAddress() Obtém o endereço IP do servidor.
protected java.lang.String	getServerName() Obtém o nome do servidor.
protected java.lang.String	getServerRMIport() Obtém a porta RMI para comunicação com o servidor.
protected boolean	hasPropertiesFile() Verifica se as proprieades foram carregadas.
void	init()
protected boolean	loadPropertiesFile() Carrega as propriedades definidas no arquivo de propriedade.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTIES_DIR

protected static final java.lang.String PROPERTIES_DIR

Diretório dentro de tomcat/webapps/[sistema] para onde será copiado o arquivo de propriedades.

See Also:

Constant Field Values

PROPERTIES_FILE

protected static final java.lang.String PROPERTIES_FILE

Arquivo com as propriedades do sistema, mantido pelo administrador. Este arquivo é copiado para dentro do diretório PROPERTIES_DIR pelo script de inicialização do servidor.

See Also:

Constant Field Values

Constructor Detail

InitServlet

public InitServlet()

Method Detail

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.io.IOException,
                     javax.servlet.ServletException

Constrói e retorna uma página JNLP, usando as informações fornecidas.

Parameters:

request - informações sobre a requisição.

response - informações sobre a resposta.

Throws:

java.io.IOException - em caso de erro de I/O

javax.servlet.ServletException - no caso de erro no servlet.

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

getProperty

protected java.lang.String getProperty(java.lang.String key)

Retorna o valor associado à propriedade.

Parameters:

key - nome da propriedade

Returns:

valor associado à propriedade, ou null caso esta não tenha sido definida.

getProperty

protected java.lang.String getProperty(java.lang.String key,
                                       java.lang.String defaultValue)

Retorna o valor associado à propriedade ou um valor default, caso esta não tenha sido definida.

Parameters:

key - nome da propriedade

defaultValue - valor default

Returns:

valor associado à propriedade ou o valor default caso esta não tenha sido definida

getRMIpath

protected java.lang.String getRMIpath()

Obtém o path RMI para o servidor no formato rmi://IP_SERVIDOR:PORTA_RMI/ .

Returns:

path RMI para o servidor

See Also:

getServerAddress(), getServerRMIport()

getServerName

protected java.lang.String getServerName()

Obtém o nome do servidor. Obtido da propriedade .

Returns:

nome do servidor

getServerAddress

protected java.lang.String getServerAddress()

Obtém o endereço IP do servidor. Obtido da propriedade .

Returns:

endereço IP do servidor

getServerRMIport

protected java.lang.String getServerRMIport()

Obtém a porta RMI para comunicação com o servidor. Obtido da propriedade . Como esta propriedade pode não ter sido definida, temos um fallback para o default .

Returns:

porta para comunicação RMI com o servidor

getClientRMIport

protected java.lang.String getClientRMIport()

Obtém a porta RMI para comunicação com o servidor. Obtido da propriedade . Como esta propriedade pode não ter sido definida, temos um fallback para o default .

Returns:

porta para comunicação RMI com o servidor

loadPropertiesFile

protected boolean loadPropertiesFile()

Carrega as propriedades definidas no arquivo de propriedade.

Returns:

true se as propriedades foram carregadas e false caso contrário.

hasPropertiesFile

protected boolean hasPropertiesFile()

Verifica se as proprieades foram carregadas.

Returns:

true se as propriedades foram carregadas e false caso contrário