csbase.client.rest

Class RestController

java.lang.Object

csbase.client.rest.RestController

public class RestController
extends Object

Controlador REST para o cliente.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestController.ApplicationApiModelProcessor Processador do modelo de recursos, usado para modificar os recursos providos por instâncias de aplicação.

Method Summary

Modifier and Type	Method and Description
void	addApplicationResources(String prefix, org.glassfish.jersey.server.ResourceConfig config) Adiciona uma lista de instâncias de recursos a serem registrados no servidor REST.
void	addResourcePackages(String... packages) Adiciona uma lista de pacotes a lista de recursos a serem registrados no servidor REST.
String	getAuthToken() Recupera o token de autenticação do usuário.
static RestController	getInstance() Método para recuperar a instância do singleton do controlador REST.
int	getPort() Consulta a porta REST usada pelo cliente.
LoginInterface	getUserLogin() Recupera o login do usuario corrente.
boolean	isDeveloperMode() Verifica se o servidor está em modo Developer.
boolean	isTokenAuthorized(String checkToken) Verifica se um token de usuário é válido.
void	registerPackages(String... packages) Metodo para registro de pacotes com recursos no servidor REST.
void	registerService(Class<?>[] classes) Metodo para registro de recursos no servidor REST.
void	removeApplicationResources(String prefix) Remove uma lista de recursos registrados no servidor REST.
void	setDocFrontEndDirectory(String docFrontEndDirectory) Define o diretório de recursos para interface web da documentação
void	startServer() Inicia o servidor REST na porta e host padrão.
void	startServer(int port) Inicia o servidor REST no host padrão em uma porta específica.
void	startServer(String host, int port) Inicia o servidor REST em uma porta e host específicos.
void	stopServer() Encerra o servidor REST.

Methods inherited from class java.lang.Object

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

Method Detail

setDocFrontEndDirectory

public void setDocFrontEndDirectory(String docFrontEndDirectory)

Define o diretório de recursos para interface web da documentação

Parameters:

docFrontEndDirectory - diretório.

getInstance

public static RestController getInstance()

Método para recuperar a instância do singleton do controlador REST.

Returns:

A instância única do controlador REST

getAuthToken

public String getAuthToken()

Recupera o token de autenticação do usuário.

Returns:

O token de login do usuário corrente.

isDeveloperMode

public boolean isDeveloperMode()

Verifica se o servidor está em modo Developer.

Returns:

Retorna true no caso de estar no modo de desenvolvimento, ou false caso contrario

isTokenAuthorized

public boolean isTokenAuthorized(String checkToken)

Verifica se um token de usuário é válido. No caso de estar no modo de desenvolvimento, retorna true independentemente do token.

Parameters:

checkToken - O token a ser verificado

Returns:

true se o token passado é válido, ou false caso contrario

getUserLogin

public LoginInterface getUserLogin()

Recupera o login do usuario corrente.

Returns:

a interface de login

stopServer

public void stopServer()

Encerra o servidor REST.

startServer

public void startServer()

Inicia o servidor REST na porta e host padrão.

startServer

public void startServer(int port)

Inicia o servidor REST no host padrão em uma porta específica.

Parameters:

port - porta a ser usada pelo servidor

startServer

public void startServer(String host,
                        int port)

Inicia o servidor REST em uma porta e host específicos.

Parameters:

host - Host a ser usado pelo servidor.

port - porta a ser usada pelo servidor

registerService

public void registerService(Class<?>[] classes)

Metodo para registro de recursos no servidor REST.

Parameters:

classes - Lista de classes de recursos a serem registradas.

addResourcePackages

public void addResourcePackages(String... packages)

Adiciona uma lista de pacotes a lista de recursos a serem registrados no servidor REST.

Parameters:

packages - Lista de pacotes com resursos REST a serem adicionados

addApplicationResources

public void addApplicationResources(String prefix,
                                    org.glassfish.jersey.server.ResourceConfig config)

Adiciona uma lista de instâncias de recursos a serem registrados no servidor REST.

Parameters:

prefix - O prefixo da aplicação

config - Configuração de recursos REST a serem adicionados

removeApplicationResources

public void removeApplicationResources(String prefix)

Remove uma lista de recursos registrados no servidor REST.

Parameters:

prefix - O prefixo da aplicação para retirada de recursos

getPort

public int getPort()

Consulta a porta REST usada pelo cliente.

Returns:

porta.

registerPackages

public void registerPackages(String... packages)

Metodo para registro de pacotes com recursos no servidor REST.

Parameters:

packages - Lista de packages de recursos a serem registradas.