Gerenciamento de Depend�ncia com JNDI

Veja neste artigo uma introduç�o ao gerenciamento de depend�ncias atrav�s de JNDI (Java Naming and Directory Interface). Veremos como nomear recursos com as anotaç�es e como pesquisar as depend�ncias criadas. Al�m disso, veremos exemplos da utilizaç�o da API JNDI e alternativas para pesquisar determinados componentes.

A l�gica de neg�cio de uma aplicaç�o nem sempre � independente, muitas vezes nossa implementaç�o depende de outros recursos que est�o no servidor de aplicaç�o como JDBC, JMS, Session Bean e Entity Manager.

Para gerenciar essas depend�ncias, os componentes Java EE oferecem refer�ncias para recursos que est�o definidos em meta-dados externos ou anotaç�es. Essas refer�ncias nada mais s�o do que um link nomeado para os recursos que pode ser determinado dinamicamente em tempo de execuç�o dentro do c�digo da aplicaç�o ou automaticamente pelo container quando a inst�ncia do componente � criada.

Toda refer�ncia tem um nome e um destino. O nome � usado pelo c�digo da aplicaç�o para determinar a refer�ncia dinamicamente. O servidor usa a informaç�o de destino para encontrar o recurso que a aplicaç�o est� procurando.

Pesquisa de Depend�ncia

A forma mais tradicional de gerenciamento de depend�ncia em Java EE � atrav�s da pesquisa de depend�ncia na qual o c�digo da aplicaç�o usa o Java Naming and Directory Interface (ou JNDI) para localizar uma refer�ncia nomeada.

A JNDI ou Java Naming and Directory Interface � uma API para acesso a serviços de diret�rios. Ela permite que aplicaç�es cliente descubram e obtenham dados ou objetos atrav�s de um nome. Assim como todas as APIs Java, ela � independente de plataforma. Suas duas funç�es b�sicas s�o Associar (mapear) um nome a um recurso e localizar um recurso a partir de seu nome.

Todas as anotaç�es de recursos suportam o atributo "name" que define o nome da refer�ncia. Quando a anotaç�o de recurso � colocada na definiç�o da classe, este atributo � obrigat�rio. Caso a anotaç�o seja colocada num atributo ou num m�todo setter, o servidor ir� gerar um nome default. Frequentemente colocamos anotaç�es no n�vel da classe, e assim o nome � explicitamente especificado.

O papel do nome � prover um caminho para o cliente localizar a refer�ncia dinamicamente. Todo servidor de aplicaç�o Java EE suporta JNDI, e cada componente tem seu pr�prio contexto de nomeaç�o JNDI local que � chamado de ambiente de contexto de nomeaç�o. O nome da refer�ncia � vinculado ao ambiente de contexto de nomeaç�o, e quando for procurado usando a API JNDI, o servidor determina a refer�ncia e retorna o destino da refer�ncia.

Como um exemplo podemos considerar o bean de sess�o abaixo. No exemplo temos uma depend�ncia com um bean de sess�o atrav�s da anotaç�o @EJB, o bean de sess�o se chama "audit", conforme � definido com o atributo "name". O atributo beanInterface apenas define a interface de neg�cio do bean de sess�o que o cliente est� interessado. No @PostConstruct o bean de sess�o "audit" � localizado e armazenado no atributo "audit". As interfaces Context e InitialContext s�o ambas definidas pela API JNDI. O m�todo lookup() da interface Context � o primeiro ponto para retornar objetos de um contexto JNDI. Para encontrar a refer�ncia "audit", a aplicaç�o procura o nome "java:comp/env/audit" e faz um cast (convers�o) do resultado para a interface de neg�cio AuditService. O prefixo "java:comp/env/" adicionado no nome da refer�ncia indica para o servidor que o ambiente de contexto de nomeaç�o deveria ser pesquisado para encontrar a refer�ncia. Se o nome estiver incorreto, uma exceç�o ser� lançada quando a pesquisa falhar.

Listagem 1: Encontrando uma depend�ncia EJB.

@Stateless
@EJB(name="audit", beanInterface=AuditService.class)
public class DeptServiceBean implements DeptService {
	private AuditService audit;
	@PostConstruct
	public void init() {
		try {
			Context ctx = new InitialContext();
			audit = (AuditService) ctx.lookup("java:comp/env/audit");
		} catch (NamingException e) {
			throw new EJBException(e);
		}
	}
// ...
}

Apesar da forma acima ser v�lida e suportada em larga escala pelos componentes Java EE, podemos notar que � um pouco complicado de utiliz�-lo devido ao tratamento de exceç�o requerido pela JNDI. EJBs tamb�m suportam uma sintaxe alternativa usando um m�todo lookup() da interface EJBContext. A interface EJBContext (e as subinterfaces SessionContext e MessageDrivenContext) est� dispon�vel para qualquer EJB e proveem o bean com acesso a serviços em tempo de execuç�o, tais como serviços de timer. O mesmo exemplo acima � apresentado abaixo usando o m�todo lookup() alternativo. A inst�ncia SessionContext neste exemplo � provido via m�todo setter.

Listagem 2: Encontrando uma depend�ncia usando lookup EJB.

@Stateless
@EJB(name="audit", beanInterface=AuditService.class)
public class DeptServiceBean implements DeptService {
	SessionContext context;
	AuditService audit;
	
	public void setSessionContext(SessionContext context) {
		this.context = context;
	}

	@PostConstruct
	public void init() {
		audit = (AuditService) context.lookup("audit");
	}

	// ...

}

O m�todo lookup() do EJBContext tem duas vantagens principais sobre a API JNDI: Primeiramente � que o argumento para o m�todo � exatamente o nome que foi especificado na refer�ncia de recurso. A segunda vantagem � que apenas exceç�es em tempo de execuç�o s�o lançadas pelo m�todo lookup(), as outras exceç�es checadas da API JNDI podem ser evitadas. O gerenciamento das exceç�es s�o feitas automaticamente, por�m escondidas do cliente.

Conclus�o

Neste artigo vimos que uma aplicaç�o depende de outros componentes e que podemos utilizar a pesquisar de depend�ncia para localizar estes componentes. Uma das formas � utilizar a API JNDI (Java Naming and Directory Interface) onde ela permite que as aplicaç�es clientes descubram e obtenham dados ou objetos atrav�s de um nome, ou ainda podemos utilizar uma interface de suporte para localizar EJBs que por sua vez possui algumas vantagens na sua utilizaç�o ao inv�s da API JNDI.

Refer�ncias

Fundamentos de JNDI
Pro JPA 2 Mastering the Java Persistence API, Apress, 2009.

Gerenciamento de Depend�ncia com JNDI

Veja neste artigo uma introdução ao gerenciamento de dependências através de JNDI (Java Naming and Directory Interface). Veremos como nomear recursos com as anotações e como pesquisar as dependências criadas.