br.com.bry.portal.servicos.rest.cliente

Class ServicosAutorizacaoPadrao<T extends ClientePortal>

java.lang.Object

br.com.bry.portal.servicos.rest.cliente.ServicosAutorizacaoPadrao<T>

Type Parameters:

T -

Bry Tecnologia - 2017

All Implemented Interfaces:

Servicos, ServicosAutorizacao

public class ServicosAutorizacaoPadrao<T extends ClientePortal>
extends Object
implements ServicosAutorizacao

Implementação padrão de Agrupamento de Serviços de Autorização.

Since:

12/05/2017

Author:

Ramon Facchin / ramon@bry.com.br

Field Summary

Fields

Modifier and Type	Field and Description
protected T	cliente

Constructor Summary

Constructors

Constructor and Description
ServicosAutorizacaoPadrao(T cliente)

Method Summary

Methods

Modifier and Type	Method and Description
RespostaPortalVO<StatusAutorizacaoPortalVO>	derivarToken(String tokenADerivar, String dispositivo, Date dataValidade) Gera um token a partir de outro Token.
RespostaPortalVO<StatusAutorizacaoPortalVO>	recuperarTokenDeAutorizacao(String identificadorContextoAutorizacao) Checa se o processo de autorização foi concluído.
RespostaPortalVO<StatusAutorizacaoPortalVO>	renovarToken(String tokenRenovacao) Renova um Token que expirou.
<V> V	servico(MetodoHttp metodo, String endpoint, String tokenSessao, Map<String,String> cabecalhos, Map<String,String> parametros, V entidade, com.sun.jersey.api.client.GenericType<V> tipoRetorno, boolean renovacao) Chama um serviço REST da API do Portal.
RespostaPortalVO<UrlAutorizacaoTerceiroVO>	solicitarURLAutorizacao(String dispositivo) Inicializa um processo de autorização (emissão de token) para um usuário.
RespostaPortalVO<UrlAutorizacaoTerceiroVO>	solicitarURLAutorizacao(String dispositivo, Date validadeToken) Inicializa um processo de autorização (emissão de token) para um usuário.

Methods inherited from class java.lang.Object

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

Field Detail

cliente

protected T extends ClientePortal cliente

Constructor Detail

ServicosAutorizacaoPadrao

public ServicosAutorizacaoPadrao(T cliente)

Method Detail

servico

public <V> V servico(MetodoHttp metodo,
            String endpoint,
            String tokenSessao,
            Map<String,String> cabecalhos,
            Map<String,String> parametros,
            V entidade,
            com.sun.jersey.api.client.GenericType<V> tipoRetorno,
            boolean renovacao)
          throws PortalAPIException

Description copied from interface: Servicos

Chama um serviço REST da API do Portal.

Specified by:

servico in interface Servicos

Parameters:

metodo - O MetodoHttp que deverá ser utilizado na chamada (POST/PUT/GET/DELETE)

endpoint - A URL completa para chamada do serviço

tokenSessao - Se o serviço chamado depende da existência de uma sessão de usuário, o tokenSessao será utilizado no lugar do Token da sua aplicação para a chamada.

cabecalhos - headers da chamada HTTP

parametros - parâmetros de URL (query) a serem utilizados na chamada

entidade - preencha com sua entidade caso o serviço sendo chamado espere uma entidade no corpo da requisição.

tipoRetorno - a classe desejada de retorno da chamada

renovacao - se esta chamada rest é de renovação de token

Returns:

Objeto com o retorno da chamada do serviço.

Throws:

PortalAutorizacaoException - caso você não possua permissão para realizar a chamada.

PortalProcessamentoRespostaException - caso tenha ocorrido algum erro interno no servidor.

PortalAPIException - no caso de erros inesperados.

PortalTokenExpiradoException - quando a chamada não foi autorizada pelo servidor devido ao uso de um token expirado. Neste caso, um token de renovação de autorização é emitido e armazenado em PortalTokenExpiradoException.getTokenRenovacao()

solicitarURLAutorizacao

public RespostaPortalVO<UrlAutorizacaoTerceiroVO> solicitarURLAutorizacao(String dispositivo)
                                                                   throws PortalAPIException

Description copied from interface: ServicosAutorizacao

Inicializa um processo de autorização (emissão de token) para um usuário. A URL retornada deverá ser acessada pelo usuário via navegador Web para que ele se autentique no sistema e autorize a sua aplicação a emitir um Token.

Depois que o usuário autenticar-se no navegador e autorizar sua aplicação, invoque o método 'recuperarTokenDeAutorizacao' informando o Identificador de Contexto de Autorização retornado por esta chamada para que você possa recuperar o Token que foi emitido para o usuário.

Specified by:

solicitarURLAutorizacao in interface ServicosAutorizacao

Parameters:

dispositivo - uma String para ajudar a identificar o dispositivo a partir do qual o usuário que está emitindo um token está acessando o sistema. (ex.: "@fulano-desktop", "@213.122.51.100" etc).

Returns:

a UrlAutorizacaoTerceiroVO para que o usuário possa, através de navegador, realizar a prova de credenciais para emitir um Token pela sua aplicação. Também é retornado um Identificador de Contexto de Autorização.

Throws:

PortalAutorizacaoException - caso você não possua permissão para realizar a chamada.

PortalProcessamentoRespostaException - caso tenha ocorrido algum erro interno no servidor.

PortalAPIException - no caso de erros inesperados.

PortalTokenExpiradoException - quando a chamada não foi autorizada pelo servidor devido ao uso de um token expirado. Neste caso, um token de renovação de autorização é emitido e armazenado em PortalTokenExpiradoException.getTokenRenovacao()

solicitarURLAutorizacao

public RespostaPortalVO<UrlAutorizacaoTerceiroVO> solicitarURLAutorizacao(String dispositivo,
                                                                 Date validadeToken)
                                                                   throws PortalAPIException

Description copied from interface: ServicosAutorizacao

Inicializa um processo de autorização (emissão de token) para um usuário. A URL retornada deverá ser acessada pelo usuário via navegador Web para que ele se autentique no sistema e autorize a sua aplicação a emitir um Token.

Depois que o usuário autenticar-se no navegador e autorizar sua aplicação, invoque o método 'recuperarTokenDeAutorizacao' informando o Identificador de Contexto de Autorização retornado por esta chamada para que você possa recuperar o Token que foi emitido para o usuário.

Specified by:

solicitarURLAutorizacao in interface ServicosAutorizacao

Parameters:

dispositivo - uma String para ajudar a identificar o dispositivo a partir do qual o usuário que está emitindo um token está acessando o sistema. (ex.: "@fulano-desktop", "@213.122.51.100" etc).

validadeToken - a data até a qual o token que será emitido deve valer, caso seja informado null, assume-se 01/02/2201.

Returns:

a UrlAutorizacaoTerceiroVO para que o usuário possa, através de navegador, realizar a prova de credenciais para emitir um Token pela sua aplicação. Também é retornado um Identificador de Contexto de Autorização.

Throws:

PortalAutorizacaoException - caso você não possua permissão para realizar a chamada.

PortalProcessamentoRespostaException - caso tenha ocorrido algum erro interno no servidor.

PortalAPIException - no caso de erros inesperados.

PortalTokenExpiradoException - quando a chamada não foi autorizada pelo servidor devido ao uso de um token expirado. Neste caso, um token de renovação de autorização é emitido e armazenado em PortalTokenExpiradoException.getTokenRenovacao()

recuperarTokenDeAutorizacao

public RespostaPortalVO<StatusAutorizacaoPortalVO> recuperarTokenDeAutorizacao(String identificadorContextoAutorizacao)
                                                                        throws PortalAPIException

Description copied from interface: ServicosAutorizacao

Checa se o processo de autorização foi concluído.
- Caso tenha sido concluído, um Token será retornado.
- Caso não tenha sido concluído, o Token estará vazio. Se o contexto não estiver ativo, significa que não é mais possível concluir esse processo de autorização.

Specified by:

recuperarTokenDeAutorizacao in interface ServicosAutorizacao

Parameters:

identificadorContextoAutorizacao - o Identificador de Contexto de Autorização do processo de autorização que foi iniciado.

Returns:

o StatusAutorizacaoPortalVO com o Token gerado no processo de autorização representado pelo Identificador de Contexto de Autorização informado. Caso o processo de autorização não tenha sido concluído, nenhum Token será retornado - e se o atributo 'contextoAtivo' for false e o Token estiver vazio, significa que o contexto expirou e nenhum Token poderá mais ser emitido.

Throws:

PortalAutorizacaoException - caso você não possua permissão para realizar a chamada.

PortalProcessamentoRespostaException - caso tenha ocorrido algum erro interno no servidor.

PortalAPIException - no caso de erros inesperados.

PortalTokenExpiradoException - quando a chamada não foi autorizada pelo servidor devido ao uso de um token expirado. Neste caso, um token de renovação de autorização é emitido e armazenado em PortalTokenExpiradoException.getTokenRenovacao()

derivarToken

public RespostaPortalVO<StatusAutorizacaoPortalVO> derivarToken(String tokenADerivar,
                                                       String dispositivo,
                                                       Date dataValidade)
                                                         throws PortalAPIException

Description copied from interface: ServicosAutorizacao

Gera um token a partir de outro Token.

Este método é usado para mesclar as informações as informações de usuário e conta do Token de Sessão (informado como parâmetro) com os dados de aplicação do Token da sua aplicação. Ou seja: une os dados de usuário do parâmetro, com as permissões da sua aplicação - visto que aplicações diferentes não necessariamente possuem as mesmas permissões.

Specified by:

derivarToken in interface ServicosAutorizacao

Parameters:

tokenADerivar - o token do qual serão lidas as informações de usuário.

dispositivo - uma String para ajudar a identificar o dispositivo a partir do qual o usuário que está emitindo um token está acessando o sistema. (ex.: "@fulano-desktop", "@213.122.51.100" etc).

dataValidade - a data até a qual o token emitido deve ser válido (se não informada, assume-se 01/01/2201).

Returns:

um StatusAutorizacaoPortalVO contendo um novo Token emitido pela sua aplicação, contendo as informações de usuário e conta contidas no 'tokenADerivar'.

Throws:

PortalAutorizacaoException - caso você não possua permissão para realizar a chamada.

PortalProcessamentoRespostaException - caso tenha ocorrido algum erro interno no servidor.

PortalAPIException - no caso de erros inesperados.

PortalTokenExpiradoException - quando a chamada não foi autorizada pelo servidor devido ao uso de um token expirado. Neste caso, um token de renovação de autorização é emitido e armazenado em PortalTokenExpiradoException.getTokenRenovacao()

renovarToken

public RespostaPortalVO<StatusAutorizacaoPortalVO> renovarToken(String tokenRenovacao)
                                                         throws PortalAPIException

Description copied from interface: ServicosAutorizacao

Renova um Token que expirou.

Specified by:

renovarToken in interface ServicosAutorizacao

Parameters:

tokenRenovacao - o token de renovação que foi fornecido após uma chamada não autorizada por motivo de token expirado.

ATENÇÃO: O Token de Renovação só é retornado na primeira chamada de API após o vencimento.

Returns:

um StatusAutorizacaoPortalVO contendo um novo Token.

Throws:

PortalAutorizacaoException - caso você não possua permissão para realizar a chamada.

PortalProcessamentoRespostaException - caso tenha ocorrido algum erro interno no servidor.

PortalAPIException - no caso de erros inesperados.