br.gov.consumidor.consumidor.api

Class ConfiguracaoAPI

java.lang.Object

br.gov.consumidor.consumidor.api.ConfiguracaoAPI

public final class ConfiguracaoAPI
extends Object

Disponibiliza itens sobre configurações da API, como métodos para mudar a URL de acesso, o contexto e o local do certificado digital. Uma vez adicionado as configurações, pode-se acessar qualquer outros serviços da API sem ser necessário regerar essas confs. Esses dados são opcionais e devem ser usados somente quando os valores padrões da API não funcionarem ou estão incoerentes com o seu uso. Esta classe é chamada a partir da classe principal ConsumidorAPI.

Author:

João Paulo Sossoloti.

Constructor Summary

Constructors

Constructor and Description
ConfiguracaoAPI()

Method Summary

Modifier and Type	Method and Description
ConfiguracaoAPI	setPathCertificado(String pathCertificado) Insere o path local do arquivo de certificado A1 de acesso aos serviços.
ConfiguracaoAPI	setUrlBase(String urlBase) Insere a URL base de acesso aos serviços, sem barra ao final.
ConfiguracaoAPI	setVersao(String versao) Insere a versão dos serviços a serem acessados.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfiguracaoAPI

public ConfiguracaoAPI()

Method Detail

setUrlBase

public ConfiguracaoAPI setUrlBase(String urlBase)
                           throws ConfiguracaoInvalidaException

Insere a URL base de acesso aos serviços, sem barra ao final. Exemplo de valor: 'https://www.consumidor.gov.br'.

Parameters:

urlBase - String com a url base.

Returns:

ConfiguracaoAPI.

Throws:

ConfiguracaoInvalidaException

setVersao

public ConfiguracaoAPI setVersao(String versao)
                          throws ConfiguracaoInvalidaException

Insere a versão dos serviços a serem acessados. O formato é 'X.X'. Exemplo de valor: '1.0'.

Parameters:

versao - String com a versao da aplicação remota.

Returns:

ConfiguracaoAPI.

Throws:

ConfiguracaoInvalidaException

setPathCertificado

public ConfiguracaoAPI setPathCertificado(String pathCertificado)
                                   throws ConfiguracaoInvalidaException

Insere o path local do arquivo de certificado A1 de acesso aos serviços. O caminho deve ser absoluto. OBS: Já existe internamente a referência a um arquivo 'keystore' padrão.

Parameters:

pathCertificado - String com a local do arquivo.

Returns:

ConfiguracaoAPI.

Throws:

ConfiguracaoInvalidaException