csbase.server.services.httpservice

Class HttpService

java.lang.Object

csbase.remote.RemoteObjectObservable

csbase.server.ServerRemoteObjectObservable

csbase.server.Service

csbase.server.services.httpservice.HttpService

All Implemented Interfaces:

csbase.remote.HttpServiceInterface, csbase.remote.RemoteObservable, csbase.remote.RemoteObserverNotifierInterface, csbase.remote.ServiceInterface, csbase.server.plugin.service.IService, Remote

public class HttpService
extends Service
implements csbase.remote.HttpServiceInterface

A classe HttpService implementa o serviço de download e upload de arquivos. Cada requisicao de dowload e' inserida na requestList, para um usuario, projeto e filePath Nulo, alem de a data de criacao do registro. O filePath e' nulo no download pois o arquivo pode ter referencias para outros arquivos que possuem caminhos distintos, sendo que estes precisam de um mesmo codigo de acesso.

Field Summary

Fields inherited from class csbase.remote.RemoteObjectObservable

observerManager

Fields inherited from interface csbase.remote.HttpServiceInterface

CSV_DOWNLOAD_TYPE, FILE_DOWNLOAD_TYPE, PDF_REPORT_DOWNLOAD_TYPE, SERVICE_NAME, TEXT_DOWNLOAD_TYPE, UNKNOWN_DOWNLOAD_TYPE, URL_DOWNLOAD_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpService() Construtor.

Method Summary

Modifier and Type	Method and Description
boolean	createFile(String accessCode, String fileName)
static void	createService() Constrói a instância do serviço.
boolean	finishUpload(String accessCode, String fileName) Remove o upload da lista de requisicoes e informa que o arquivo nao esta' mais em construcao, se foi um upload de arquivo de projeto.
String	getDownloadCSVURL(Object userId, String password, String text) Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV.
String	getDownloadCSVURL(Object userId, String password, String text, String fileName) Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV.
String	getDownloadCSVURL(String text) Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV.
String	getDownloadCSVURL(String text, String fileName) Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV.
String	getDownloadPDFReportURL(String filePath, Map<String,String> parameters, String jdbcDriverClassName, String jdbcURL, String jdbcUser, String jdbcPassword) Obtém a URL para a exibição de um relatório no formato pdf em um navegador web.
String	getDownloadTextURL(Object userId, String password, String text)
String	getDownloadTextURL(Object userId, String password, String text, String fileName)
String	getDownloadTextURL(String text) Pega a URL que será chamada pelo browser quando o tipo de dowload for TEXTO.
int	getDownloadType(String accessCode)
String	getDownloadURL(Object userId, String password, Object projectId, String[] filePath)
String	getDownloadURL(String filePath) Obtem a url para download do arquivo.
String	getDownloadURL(String filePath, Map<String,String> parameters) Obtem a url para download do arquivo.
String	getFileDownloadURL(String filePath) Obtém uma URL para exibição de um arquivo do sistema de arquivos (NFS) em um navegador web.
String	getFilePath(String accessCode)
String	getFilePath(String accessCode, String filePath)
String	getFileType(String accessCode, String filePath)
static HttpService	getInstance() Obtém a instância do serviço.
String	getJdbcDriverClassName(String accessCode)
String	getJdbcPassword(String accessCode)
String	getJdbcURL(String accessCode)
String	getJdbcUser(String accessCode)
Map<String,String>	getParameters(String accessCode)
String	getPresentationPath(String accessCode)
int	getRequestListSize() Obtém o número de requisições de download retidos em memória, aguardando limpeza periódica.
String	getResultPath(String accessCode)
String	getText(String accessCode)
String	getUploadURL(Object userId, String password, Object projectId, String[] filePath, String fileType)
String	getUploadURL(String filePath, String presentationPath, String resultPath) Obtem a url para upload do arquivo.
String	getUploadURL(String filePath, String presentationPath, String resultPath, Observer obs) Obtem a url para upload do arquivo.
String	getUploadURL(String filePath, String presentationPath, String resultPath, UploadHandler fileHandler) Obtem a url para upload do arquivo.
protected boolean	has2Update(Object arg, Object event)
void	initService() Inicialização do serviço.
boolean	isDirectory(String accessCode)
void	shutdownService() Término do serviço.

Methods inherited from class csbase.server.Service

getBooleanProperty, getDefaultLocale, getDoubleProperty, getExternalPropertyFile, getFormattedString, getFormattedString, getInitializationDependencies, getInstance, getIntProperty, getKey, getLongProperty, getName, getOptionalString, getOptionalString, getOSPropertyPath, getSenderName, getServices, getString, getString, getStringListProperty, getStringProperty, getSystemId, getThreadLocale, getUser, getUserPermission, hasProperty, incrCounter, isActive, isEnabled, isInternalServerRequest, isLoggingNotifications, isPropertyNull, logNotification, setEnabled, setKey, setSystemId, setUserId, setUserLocale

Methods inherited from class csbase.server.ServerRemoteObjectObservable

handleException, handleFatalError

Methods inherited from class csbase.remote.RemoteObjectObservable

addObserver, countObservers, deleteObserver, deleteObserver, deleteObservers, has2update, notifyObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface csbase.remote.ServiceInterface

getName, isActive

Constructor Detail

HttpService

protected HttpService()
               throws ServerException

Construtor.

Throws:

ServerException - falha na construção do serviço.

Method Detail

createService

public static void createService()
                          throws ServerException

Constrói a instância do serviço.

Throws:

ServerException - em caso de erro.

getDownloadURL

public String getDownloadURL(Object userId,
                             String password,
                             Object projectId,
                             String[] filePath)
                      throws RemoteException

Specified by:

getDownloadURL in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getUploadURL

public String getUploadURL(Object userId,
                           String password,
                           Object projectId,
                           String[] filePath,
                           String fileType)
                    throws RemoteException

Specified by:

getUploadURL in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getFileType

public String getFileType(String accessCode,
                          String filePath)
                   throws RemoteException

Specified by:

getFileType in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getDownloadType

public int getDownloadType(String accessCode)
                    throws RemoteException

Specified by:

getDownloadType in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

createFile

public boolean createFile(String accessCode,
                          String fileName)
                   throws RemoteException

Specified by:

createFile in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getFilePath

public String getFilePath(String accessCode)
                   throws RemoteException

Specified by:

getFilePath in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getFilePath

public String getFilePath(String accessCode,
                          String filePath)
                   throws RemoteException

Specified by:

getFilePath in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getPresentationPath

public String getPresentationPath(String accessCode)
                           throws RemoteException

Specified by:

getPresentationPath in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getResultPath

public String getResultPath(String accessCode)
                     throws RemoteException

Specified by:

getResultPath in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

isDirectory

public boolean isDirectory(String accessCode)
                    throws RemoteException

Specified by:

isDirectory in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

finishUpload

public boolean finishUpload(String accessCode,
                            String fileName)
                     throws csbase.exception.HttpServiceException

Remove o upload da lista de requisicoes e informa que o arquivo nao esta' mais em construcao, se foi um upload de arquivo de projeto. Notifica os observadores que o upload terminou.

Specified by:

finishUpload in interface csbase.remote.HttpServiceInterface

Parameters:

accessCode - código de acesso.

fileName - O nome original do arquivo que sofreu upload.

Returns:

boolean se a operacao foi realizada com sucesso.

Throws:

csbase.exception.HttpServiceException - em caso de erro.

getFileDownloadURL

public String getFileDownloadURL(String filePath)
                          throws RemoteException

Obtém uma URL para exibição de um arquivo do sistema de arquivos (NFS) em um navegador web.

Parameters:

filePath - caminho absoluto do arquivo no sistema de arquivos.

Returns:

url para exibição do arquivo em um navegador.

Throws:

RemoteException - em caso de erro.

getDownloadPDFReportURL

public String getDownloadPDFReportURL(String filePath,
                                      Map<String,String> parameters,
                                      String jdbcDriverClassName,
                                      String jdbcURL,
                                      String jdbcUser,
                                      String jdbcPassword)
                               throws RemoteException

Obtém a URL para a exibição de um relatório no formato pdf em um navegador web.

Parameters:

filePath - caminho absoluto do arquivo .jasper que representa o layout do relatório

parameters - parâmetros passados para o relatório

jdbcDriverClassName - nome da classe do driver jdbc para criação da conexão usada no relatório

jdbcURL - URL de acesso para criação da conexão usada no relatório

jdbcUser - usuário de acesso para criação da conexão usada no relatório

jdbcPassword - senha de acesso para criação da conexão usada no relatório

Returns:

url para exibição do arquivo em um navegador.

Throws:

RemoteException - em caso de erro.

getParameters

public Map<String,String> getParameters(String accessCode)
                                 throws RemoteException

Specified by:

getParameters in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getJdbcDriverClassName

public String getJdbcDriverClassName(String accessCode)
                              throws RemoteException

Specified by:

getJdbcDriverClassName in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getJdbcURL

public String getJdbcURL(String accessCode)
                  throws RemoteException

Specified by:

getJdbcURL in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getJdbcUser

public String getJdbcUser(String accessCode)
                   throws RemoteException

Specified by:

getJdbcUser in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getJdbcPassword

public String getJdbcPassword(String accessCode)
                       throws RemoteException

Specified by:

getJdbcPassword in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getUploadURL

public String getUploadURL(String filePath,
                           String presentationPath,
                           String resultPath)
                    throws RemoteException

Obtem a url para upload do arquivo.

Parameters:

filePath - caminho do arquivo local no projeto.

presentationPath - Path do arquivo html para upload.

resultPath - Path do arquivo html resultado do upload.

Returns:

String que representa a url do arquivo

Throws:

RemoteException - em caso de erro.

getUploadURL

public String getUploadURL(String filePath,
                           String presentationPath,
                           String resultPath,
                           UploadHandler fileHandler)

Obtem a url para upload do arquivo.

Parameters:

filePath - caminho do arquivo local no projeto.

presentationPath - Path do arquivo html para upload.

resultPath - Path do arquivo html resultado do upload.

fileHandler - Classe que realiza o upload.

Returns:

String que representa a url do arquivo

getUploadURL

public String getUploadURL(String filePath,
                           String presentationPath,
                           String resultPath,
                           Observer obs)

Obtem a url para upload do arquivo.

Parameters:

filePath - caminho do arquivo local no projeto.

presentationPath - Path do arquivo html para upload.

resultPath - Path do arquivo html resultado do upload.

obs - Observador que é notificado quando o upload termina.

Returns:

String que representa a url do arquivo

getDownloadURL

public String getDownloadURL(String filePath)
                      throws RemoteException

Obtem a url para download do arquivo.

Parameters:

filePath - caminho do arquivo local no projeto.

Returns:

String que representa a url do arquivo

Throws:

RemoteException - em caso de erro.

getDownloadURL

public String getDownloadURL(String filePath,
                             Map<String,String> parameters)
                      throws RemoteException

Obtem a url para download do arquivo.

Parameters:

filePath - caminho do arquivo local no projeto.

parameters - parâmetros que serão armazenados na RequestInfo para uso geral.

Returns:

String que representa a url do arquivo

Throws:

RemoteException - em caso de erro.

getDownloadTextURL

public String getDownloadTextURL(Object userId,
                                 String password,
                                 String text)
                          throws RemoteException

Specified by:

getDownloadTextURL in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getDownloadTextURL

public String getDownloadTextURL(String text)
                          throws RemoteException

Pega a URL que será chamada pelo browser quando o tipo de dowload for TEXTO.

Parameters:

text - Texto que será exibido no navegador

Returns:

a URL.

Throws:

RemoteException - em caso de erro.

getDownloadTextURL

public String getDownloadTextURL(Object userId,
                                 String password,
                                 String text,
                                 String fileName)
                          throws RemoteException

Specified by:

getDownloadTextURL in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

getDownloadCSVURL

public String getDownloadCSVURL(Object userId,
                                String password,
                                String text)
                         throws RemoteException

Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV.

Specified by:

getDownloadCSVURL in interface csbase.remote.HttpServiceInterface

Parameters:

userId - identificação do usuário.

password - senha do usuário.

text - texto contendo o conteúdo do CSV.

Returns:

URL de download do arquivo CSV.

Throws:

RemoteException - em caso de erro.

getDownloadCSVURL

public String getDownloadCSVURL(String text)
                         throws RemoteException

Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV. OBS: Esse método não é exportado na interface remota, só pode ser chamada de outro serviço.

Parameters:

text - texto contendo o conteúdo do CSV.

Returns:

URL de download do arquivo CSV.

Throws:

RemoteException - em caso de erro.

getDownloadCSVURL

public String getDownloadCSVURL(String text,
                                String fileName)
                         throws RemoteException

Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV. OBS: Esse método não é exportado na interface remota, só pode ser chamada de outro serviço.

Parameters:

text - texto contendo o conteúdo do CSV.

fileName - nome do arquivo gerado para download

Returns:

URL de download do arquivo CSV.

Throws:

RemoteException - em caso de erro.

getText

public String getText(String accessCode)
               throws RemoteException

Specified by:

getText in interface csbase.remote.HttpServiceInterface

Throws:

RemoteException

has2Update

protected boolean has2Update(Object arg,
                             Object event)

Specified by:

has2Update in class csbase.remote.RemoteObjectObservable

shutdownService

public void shutdownService()
                     throws ServerException

Término do serviço.

Specified by:

shutdownService in class Service

Throws:

ServerException - em caso de erro.

initService

public void initService()
                 throws ServerException

Inicialização do serviço.

Specified by:

initService in class Service

Throws:

ServerException - se ocorrer um erro na inicialização

getInstance

public static HttpService getInstance()

Obtém a instância do serviço.

Returns:

instância do serviço.

getDownloadCSVURL

public String getDownloadCSVURL(Object userId,
                                String password,
                                String text,
                                String fileName)
                         throws RemoteException

Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV.

Specified by:

getDownloadCSVURL in interface csbase.remote.HttpServiceInterface

Parameters:

userId - identificação do usuário.

password - senha do usuário.

text - texto contendo o conteúdo do CSV.

fileName - nome do arquivo que será gerado

Returns:

URL de download do arquivo CSV.

Throws:

RemoteException - em caso de erro.

getRequestListSize

public int getRequestListSize()
                       throws RemoteException

Obtém o número de requisições de download retidos em memória, aguardando limpeza periódica.

Specified by:

getRequestListSize in interface csbase.remote.HttpServiceInterface

Returns:

tamanho.

Throws:

RemoteException - em caso de erro.