csbase.remote

Interface RestServiceInterface

All Superinterfaces:

Remote, ServiceInterface

public interface RestServiceInterface
extends ServiceInterface

interface para controle da inicializacao dos servicos Rest

Author:

rodneicouto

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Nome do serviço para o ServiceManager

Method Summary

Modifier and Type	Method and Description
String	createToken(String subject, Map<String,Object> attributes, Date expirationDate, Date issuedDate) Cria um token assinado
String	getClientHttpServer(String id) Obtém a URL do servidor HTTP do cliente com o identificador especificado.
String	getExternalURL() Retorna a URL externa do servidor.
boolean	isClientDeveloperMode() Recupera uma flag da configuração de Client Developer Mode.
void	logInfoMessage(String msg) Adiciona no log um registro de evento de informação relacionada a alguma requisição proveniente da API REST.
void	logSevereMessage(String msg, Throwable t) Adiciona no log um registro de evento severo em decorrência de um erro no servidor causado por alguma requisição proveniente da API REST.
String	parserToken(String token, Map<String,Object> outAttributes) Recupera a informação associado ao token.
void	registerClientHttpServer(String id, String httpServerURL) Registra uma URL de servidor HTTP do cliente com o identificador especificado.
void	unregisterClientHttpServer(String id) Desregistra uma URL de servidor HTTP do cliente com o identificador especificado.

Methods inherited from interface csbase.remote.ServiceInterface

getName, isActive

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

Nome do serviço para o ServiceManager

See Also:

Constant Field Values

Method Detail

getExternalURL

String getExternalURL()

Retorna a URL externa do servidor.

Returns:

URL

logSevereMessage

void logSevereMessage(String msg,
                      Throwable t)

Adiciona no log um registro de evento severo em decorrência de um erro no servidor causado por alguma requisição proveniente da API REST.

Parameters:

msg - a mensagem para o registro no log

t - a exceção que causou o erro

logInfoMessage

void logInfoMessage(String msg)

Adiciona no log um registro de evento de informação relacionada a alguma requisição proveniente da API REST.

Parameters:

msg - a mensagem para o registro no log

parserToken

String parserToken(String token,
                   Map<String,Object> outAttributes)
            throws ParseException

Recupera a informação associado ao token. Caso o token não esteja válido, retorna null.

Parameters:

token - o token

outAttributes - Mapa usado para retorno dos atributos via parâmetro. Se for diferentes de nulo, os atributos adiconais serão preenchidos nesse mapa.Se for nulo, mesmo havendo atributos adicionais, nao será possível lê-los.

Returns:

a Informação do Subject associada ao token ou null caso não exista.

Throws:

ParseException - Caso o token seja inválido

createToken

String createToken(String subject,
                   Map<String,Object> attributes,
                   Date expirationDate,
                   Date issuedDate)

Cria um token assinado

Parameters:

subject - Informacao do subject. Exemplo de uso é o login do usuario

attributes - Atributos adicionais.

expirationDate - Uma data de expiração

issuedDate - Uma data de emissão

Returns:

o token criado e assinado

getClientHttpServer

String getClientHttpServer(String id)

Obtém a URL do servidor HTTP do cliente com o identificador especificado.

Parameters:

id - identificador do cliente.

Returns:

a URL do servidor HTTP do cliente.

registerClientHttpServer

void registerClientHttpServer(String id,
                              String httpServerURL)

Registra uma URL de servidor HTTP do cliente com o identificador especificado.

Parameters:

id - identificador do cliente.

httpServerURL - a URL do servidor HTTP do cliente.

unregisterClientHttpServer

void unregisterClientHttpServer(String id)

Desregistra uma URL de servidor HTTP do cliente com o identificador especificado.

Parameters:

id - identificador do cliente.

isClientDeveloperMode

boolean isClientDeveloperMode()

Recupera uma flag da configuração de Client Developer Mode.

Returns:

true caso o cliente esteja em modo desenvolvedor, ou false caso contrario