Package br.com.davinti.vitruvio.spi

Interface ConfigService

All Known Implementing Classes:

ConfigServiceImpl

public interface ConfigService

Servico de acesso a configuracoes do Vitruvio.

As configuracoes sao organizadas em tres escopos:

• System (*SystemConfig*) — configuracoes globais do sistema;
• User (*UserConfig*) — configuracoes por usuario, identificadas pelo login;
• Process (*ProcessConfig*) — configuracoes vinculadas a um processo ou a uma instancia, identificadas pela combinacao de processo/instancia, login, formKey e key.

Os metodos getXxxAs...(key) retornam null quando a chave nao existe; as sobrecargas que recebem defaultValue retornam esse valor padrao no lugar.

Author:

Eduardo Frazao

Method Summary

Modifier and Type	Method	Description
<T extends Serializable> T	decodeFromStringRepresentation(String representation, Class<T> type)	Decodifica uma representacao em um novo objeto representando seu tipo
String	encodeToStringRepresentation(Serializable object)	Utiliza a mesma implementacao de codificacao de configuracoes para codificar objetos serializaveis.
String	generateUUID()	Gera um UUID Padrao, que deve ser utilizado para geracao em demais servicos
<T extends Config> T	getProcessConfigByInstance(Instancia processo, String login, String formKey, String key, Class<T> configType)
<T extends Config> T	getProcessConfigByInstance(Long instanceId, String login, String formKey, String key, Class<T> configType)
<T extends Config> T	getProcessConfigByInstance(String processInstanceId, String login, String formKey, String key, Class<T> configType)
<T extends Config> T	getProcessConfigByProcess(Processo processo, String login, String formKey, String key, Class<T> configType)
<T extends Config> T	getProcessConfigByProcess(Integer processId, String login, String formKey, String key, Class<T> configType)
String	getProcessConfigDataByInstance(Instancia processo, String login, String formKey, String key)
String	getProcessConfigDataByInstance(Long instanceId, String login, String formKey, String key)
String	getProcessConfigDataByInstance(String processInstanceId, String login, String formKey, String key)
String	getProcessConfigDataByProcess(Processo processo, String login, String formKey, String key)
String	getProcessConfigDataByProcess(Integer processId, String login, String formKey, String key)
String	getProcessConfigDataByProcess(String processKey, String login, String formKey, String key)
<T extends SystemConfig> T	getSystemConfig(Class<T> configType)
<T extends SystemConfig> T	getSystemConfig(String key, Class<T> configType)
Boolean	getSystemConfigAsBoolean(String key)
Boolean	getSystemConfigAsBoolean(String key, Boolean defaultValue)
Date	getSystemConfigAsDate(String key)
Date	getSystemConfigAsDate(String key, Date defaultValue)
Double	getSystemConfigAsDouble(String key)
Double	getSystemConfigAsDouble(String key, Double defaultValue)
Long	getSystemConfigAsLong(String key)
Long	getSystemConfigAsLong(String key, Long defaultValue)
String	getSystemConfigAsString(String key)
String	getSystemConfigAsString(String key, String defaultValue)
<T extends UserConfig> T	getUserConfig(String login, Class<T> configType)
<T extends UserConfig> T	getUserConfig(String login, String key, Class<T> configType)
Boolean	getUserConfigAsBoolean(String login, String key)
Boolean	getUserConfigAsBoolean(String login, String key, Boolean defaultValue)
Date	getUserConfigAsDate(String login, String key)
Date	getUserConfigAsDate(String login, String key, Date defaultValue)
Double	getUserConfigAsDouble(String login, String key)
Double	getUserConfigAsDouble(String login, String key, Double defaultValue)
Long	getUserConfigAsLong(String login, String key)
Long	getUserConfigAsLong(String login, String key, Long defaultValue)
String	getUserConfigAsString(String login, String key)
String	getUserConfigAsString(String login, String key, String defaultValue)
void	removeUserConfig(String login, String key)
void	saveProcessConfigForInstance(Instancia processo, String login, String formKey, String key, Config config)	Salva uma configuracao no escopo de uma instancia especifica de processo.
void	saveProcessConfigForInstance(Instancia processo, String login, String formKey, String key, String configData)
void	saveProcessConfigForInstance(Long instanceId, String login, String formKey, String key, Config config)
void	saveProcessConfigForInstance(Long instanceId, String login, String formKey, String key, String configData)
void	saveProcessConfigForInstance(String processInstanceId, String login, String formKey, String key, Config config)
void	saveProcessConfigForInstance(String processInstanceId, String login, String formKey, String key, String configData)
void	saveProcessConfigForProcess(Processo processo, String login, String formKey, String key, Config config)	Salva uma configuracao no escopo de um processo (vale para todas as instancias daquele processo).
void	saveProcessConfigForProcess(Processo processo, String login, String formKey, String key, String configData)
void	saveProcessConfigForProcess(Integer processId, String login, String formKey, String key, Config config)
void	saveProcessConfigForProcess(Integer processId, String login, String formKey, String key, String configData)
void	saveProcessConfigForProcess(String processKey, String login, String formKey, String key, String configData)
void	saveSystemConfig(SystemConfig config)
void	saveSystemConfig(String key, boolean value)
void	saveSystemConfig(String key, SystemConfig config)
void	saveSystemConfig(String key, Double value)
void	saveSystemConfig(String key, Long value)
void	saveSystemConfig(String key, String value)
void	saveSystemConfig(String key, Date value)
void	saveUserConfig(String login, UserConfig config)
void	saveUserConfig(String login, String key, boolean value)
void	saveUserConfig(String login, String key, UserConfig config)
void	saveUserConfig(String login, String key, Double value)
void	saveUserConfig(String login, String key, Long value)
void	saveUserConfig(String login, String key, String value)
void	saveUserConfig(String login, String key, Date value)

Method Details

saveSystemConfig

void saveSystemConfig(String key,
 String value)

saveSystemConfig

void saveSystemConfig(String key,
 Long value)

saveSystemConfig

void saveSystemConfig(String key,
 Double value)

saveSystemConfig

void saveSystemConfig(String key,
 boolean value)

saveSystemConfig

void saveSystemConfig(String key,
 Date value)

saveSystemConfig

void saveSystemConfig(String key,
 SystemConfig config)

saveSystemConfig

void saveSystemConfig(SystemConfig config)

getSystemConfigAsString

String getSystemConfigAsString(String key)

getSystemConfigAsString

String getSystemConfigAsString(String key,
 String defaultValue)

getSystemConfigAsLong

Long getSystemConfigAsLong(String key)

getSystemConfigAsLong

Long getSystemConfigAsLong(String key,
 Long defaultValue)

getSystemConfigAsDouble

Double getSystemConfigAsDouble(String key)

getSystemConfigAsDouble

Double getSystemConfigAsDouble(String key,
 Double defaultValue)

getSystemConfigAsBoolean

Boolean getSystemConfigAsBoolean(String key)

getSystemConfigAsBoolean

Boolean getSystemConfigAsBoolean(String key,
 Boolean defaultValue)

getSystemConfigAsDate

Date getSystemConfigAsDate(String key)

getSystemConfigAsDate

Date getSystemConfigAsDate(String key,
 Date defaultValue)

getSystemConfig

<T extends SystemConfig> T getSystemConfig(String key,
 Class<T> configType)

getSystemConfig

<T extends SystemConfig> T getSystemConfig(Class<T> configType)

saveUserConfig

void saveUserConfig(String login,
 String key,
 String value)

saveUserConfig

void saveUserConfig(String login,
 String key,
 Long value)

saveUserConfig

void saveUserConfig(String login,
 String key,
 Double value)

saveUserConfig

void saveUserConfig(String login,
 String key,
 boolean value)

saveUserConfig

void saveUserConfig(String login,
 String key,
 Date value)

saveUserConfig

void saveUserConfig(String login,
 String key,
 UserConfig config)

saveUserConfig

void saveUserConfig(String login,
 UserConfig config)

getUserConfigAsString

String getUserConfigAsString(String login,
 String key)

getUserConfigAsString

String getUserConfigAsString(String login,
 String key,
 String defaultValue)

getUserConfigAsLong

Long getUserConfigAsLong(String login,
 String key)

getUserConfigAsLong

Long getUserConfigAsLong(String login,
 String key,
 Long defaultValue)

getUserConfigAsDouble

Double getUserConfigAsDouble(String login,
 String key)

getUserConfigAsDouble

Double getUserConfigAsDouble(String login,
 String key,
 Double defaultValue)

getUserConfigAsBoolean

Boolean getUserConfigAsBoolean(String login,
 String key)

getUserConfigAsBoolean

Boolean getUserConfigAsBoolean(String login,
 String key,
 Boolean defaultValue)

getUserConfigAsDate

Date getUserConfigAsDate(String login,
 String key)

getUserConfigAsDate

Date getUserConfigAsDate(String login,
 String key,
 Date defaultValue)

getUserConfig

<T extends UserConfig> T getUserConfig(String login,
 String key,
 Class<T> configType)

getUserConfig

<T extends UserConfig> T getUserConfig(String login,
 Class<T> configType)

saveProcessConfigForProcess

void saveProcessConfigForProcess(Processo processo,
 String login,
 String formKey,
 String key,
 Config config)

Salva uma configuracao no escopo de um processo (vale para todas as instancias daquele processo). A configuracao e identificada de forma unica pela combinacao processo + login + formKey + key.

Parameters:

processo - processo ao qual a configuracao pertence

login - login do usuario dono da configuracao

formKey - chave do formulario ao qual a configuracao se refere

key - chave da configuracao

config - objeto de configuracao a persistir

saveProcessConfigForProcess

void saveProcessConfigForProcess(Integer processId,
 String login,
 String formKey,
 String key,
 Config config)

saveProcessConfigForInstance

void saveProcessConfigForInstance(Instancia processo,
 String login,
 String formKey,
 String key,
 Config config)

Salva uma configuracao no escopo de uma instancia especifica de processo. A configuracao e identificada de forma unica pela combinacao instancia + login + formKey + key.

Parameters:

processo - instancia a qual a configuracao pertence

login - login do usuario dono da configuracao

formKey - chave do formulario ao qual a configuracao se refere

key - chave da configuracao

config - objeto de configuracao a persistir

saveProcessConfigForInstance

void saveProcessConfigForInstance(String processInstanceId,
 String login,
 String formKey,
 String key,
 Config config)

saveProcessConfigForInstance

void saveProcessConfigForInstance(Long instanceId,
 String login,
 String formKey,
 String key,
 Config config)

saveProcessConfigForProcess

void saveProcessConfigForProcess(Processo processo,
 String login,
 String formKey,
 String key,
 String configData)

saveProcessConfigForProcess

void saveProcessConfigForProcess(Integer processId,
 String login,
 String formKey,
 String key,
 String configData)

saveProcessConfigForProcess

void saveProcessConfigForProcess(String processKey,
 String login,
 String formKey,
 String key,
 String configData)

saveProcessConfigForInstance

void saveProcessConfigForInstance(Instancia processo,
 String login,
 String formKey,
 String key,
 String configData)

saveProcessConfigForInstance

void saveProcessConfigForInstance(Long instanceId,
 String login,
 String formKey,
 String key,
 String configData)

saveProcessConfigForInstance

void saveProcessConfigForInstance(String processInstanceId,
 String login,
 String formKey,
 String key,
 String configData)

getProcessConfigByProcess

<T extends Config> T getProcessConfigByProcess(Processo processo,
 String login,
 String formKey,
 String key,
 Class<T> configType)

getProcessConfigByProcess

<T extends Config> T getProcessConfigByProcess(Integer processId,
 String login,
 String formKey,
 String key,
 Class<T> configType)

getProcessConfigByInstance

<T extends Config> T getProcessConfigByInstance(Instancia processo,
 String login,
 String formKey,
 String key,
 Class<T> configType)

getProcessConfigByInstance

<T extends Config> T getProcessConfigByInstance(String processInstanceId,
 String login,
 String formKey,
 String key,
 Class<T> configType)

getProcessConfigByInstance

<T extends Config> T getProcessConfigByInstance(Long instanceId,
 String login,
 String formKey,
 String key,
 Class<T> configType)

getProcessConfigDataByProcess

String getProcessConfigDataByProcess(Processo processo,
 String login,
 String formKey,
 String key)

getProcessConfigDataByProcess

String getProcessConfigDataByProcess(Integer processId,
 String login,
 String formKey,
 String key)

getProcessConfigDataByProcess

String getProcessConfigDataByProcess(String processKey,
 String login,
 String formKey,
 String key)

getProcessConfigDataByInstance

String getProcessConfigDataByInstance(Instancia processo,
 String login,
 String formKey,
 String key)

getProcessConfigDataByInstance

String getProcessConfigDataByInstance(Long instanceId,
 String login,
 String formKey,
 String key)

getProcessConfigDataByInstance

String getProcessConfigDataByInstance(String processInstanceId,
 String login,
 String formKey,
 String key)

removeUserConfig

void removeUserConfig(String login,
 String key)

encodeToStringRepresentation

String encodeToStringRepresentation(Serializable object)

Utiliza a mesma implementacao de codificacao de configuracoes para codificar objetos serializaveis. A Forma de serializacao e de escolha da implementacao, e pode refletir tecnologias padrao ou nao, como JSON ou XML

Parameters:

Objeto - a ser serializado/codificado

Returns:

decodeFromStringRepresentation

<T extends Serializable> T decodeFromStringRepresentation(String representation,
 Class<T> type)

Decodifica uma representacao em um novo objeto representando seu tipo

Parameters:

representation -

type -

Returns:

generateUUID

String generateUUID()

Gera um UUID Padrao, que deve ser utilizado para geracao em demais servicos