csbase.remote

Interface HttpServiceInterface

All Superinterfaces:

java.rmi.Remote, ServiceInterface

public interface HttpServiceInterface
extends ServiceInterface

Interface remota para acesso ao Serviço de download de arquivos.

Author:

Taciana Melcop

Field Summary

Fields

Modifier and Type	Field and Description
static int	CSV_DOWNLOAD_TYPE tipo texto csv
static int	FILE_DOWNLOAD_TYPE tipo arquivo usando o caminho unix completo
static int	PDF_REPORT_DOWNLOAD_TYPE tipo relatório pdf
static java.lang.String	SERVICE_NAME Nome do serviço para o ServiceManager
static int	TEXT_DOWNLOAD_TYPE tipo texto ascii
static int	UNKNOWN_DOWNLOAD_TYPE tipo desconhecido
static int	URL_DOWNLOAD_TYPE tipo URL

Method Summary

Modifier and Type	Method and Description
boolean	createFile(java.lang.String accessCode, java.lang.String fileName) Cria um arquivo
boolean	finishUpload(java.lang.String accessCode, java.lang.String fileName) Remove o upload da lista de requisicoes e informa que o arquivo nao esta' mais em construcao.
java.lang.String	getDownloadCSVURL(java.lang.Object userId, java.lang.String password, java.lang.String text) Pega a URL que será chamada pelo browser quando o tipo de dowload for CSV.
java.lang.String	getDownloadCSVURL(java.lang.Object userId, java.lang.String password, java.lang.String text, java.lang.String fileName)
java.lang.String	getDownloadTextURL(java.lang.Object userId, java.lang.String password, java.lang.String text) Pega a URL que será chamada pelo browser quando o tipo de dowload for TEXTO.
java.lang.String	getDownloadTextURL(java.lang.Object userId, java.lang.String password, java.lang.String text, java.lang.String fileName) Pega a URL que será chamada pelo browser quando o tipo de dowload for TEXTO, permitindo a escolha do nome do arquivo.
int	getDownloadType(java.lang.String accessCode) Pega o tipo de método utilizado no download referente ao accessCode passado.
java.lang.String	getDownloadURL(java.lang.Object userId, java.lang.String password, java.lang.Object projectId, java.lang.String[] filePath) Obtem a url atraves da qual o arquivo deve ser acessado para download.
java.lang.String	getFilePath(java.lang.String accessCode) Obtem o caminho do arquivo a ser exibido
java.lang.String	getFilePath(java.lang.String accessCode, java.lang.String filePath) Obtem o caminho do arquivo a ser exibido
java.lang.String	getFileType(java.lang.String accessCode, java.lang.String filePath) Obtem o tipo do arquivo a ser exibido
java.lang.String	getJdbcDriverClassName(java.lang.String accessCode) Obtém o nome da classe do driver JDBC para criação de uma conexão com um banco de dados a partir do servlets(upload e download), caso seja necessário.
java.lang.String	getJdbcPassword(java.lang.String accessCode) Obtém a senha JDBC para criação de uma conexão com um banco de dados a partir do servlets(upload e download), caso seja necessário.
java.lang.String	getJdbcURL(java.lang.String accessCode) Obtém URL JDBC para criação de uma conexão com um banco de dados a partir do servlets(upload e download), caso seja necessário.
java.lang.String	getJdbcUser(java.lang.String accessCode) Obtém o usuário JDBC para criação de uma conexão com um banco de dados a partir do servlets(upload e download), caso seja necessário.
java.util.Map	getParameters(java.lang.String accessCode) Obtém os parâmetros da RequestInfo para usos gerais
java.lang.String	getPresentationPath(java.lang.String accessCode) Obtem o caminho do arquivo de entrada do upload.
int	getRequestListSize() Obtém o número de requisições de download retidos em memória, aguardando limpeza periódica.
java.lang.String	getResultPath(java.lang.String accessCode) Obtem o caminho do arquivo de resultado do upload.
java.lang.String	getText(java.lang.String accessCode) Pega o texto que está armazenado na RequestInfo referente ao accessCode passado.
java.lang.String	getUploadURL(java.lang.Object userId, java.lang.String password, java.lang.Object projectId, java.lang.String[] filePath, java.lang.String fileType) Obtem a url atraves da qual o arquivo deve ser acessado para upload.
boolean	isDirectory(java.lang.String accessCode) Verifica se o arquivo e' diretorio.

Methods inherited from interface csbase.remote.ServiceInterface

getName, isActive

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Nome do serviço para o ServiceManager

See Also:

Constant Field Values

UNKNOWN_DOWNLOAD_TYPE

static final int UNKNOWN_DOWNLOAD_TYPE

tipo desconhecido

See Also:

Constant Field Values

FILE_DOWNLOAD_TYPE

static final int FILE_DOWNLOAD_TYPE

tipo arquivo usando o caminho unix completo

See Also:

Constant Field Values

URL_DOWNLOAD_TYPE

static final int URL_DOWNLOAD_TYPE

tipo URL

See Also:

Constant Field Values

TEXT_DOWNLOAD_TYPE

static final int TEXT_DOWNLOAD_TYPE

tipo texto ascii

See Also:

Constant Field Values

PDF_REPORT_DOWNLOAD_TYPE

static final int PDF_REPORT_DOWNLOAD_TYPE

tipo relatório pdf

See Also:

Constant Field Values

CSV_DOWNLOAD_TYPE

static final int CSV_DOWNLOAD_TYPE

tipo texto csv

See Also:

Constant Field Values

Method Detail

getDownloadURL

java.lang.String getDownloadURL(java.lang.Object userId,
                                java.lang.String password,
                                java.lang.Object projectId,
                                java.lang.String[] filePath)
                         throws java.rmi.RemoteException

Obtem a url atraves da qual o arquivo deve ser acessado para download.

Parameters:

userId - Identificador do usuário no servidor http remoto.

password - Senha do usuário para autenticar o usuário que está fazendo a chamada do método.

projectId - Identificador do projeto.

filePath - Caminho do arquivo no projeto.

Returns:

Texto que representa a URL para acesso ao arquivo.

Throws:

java.rmi.RemoteException

getUploadURL

java.lang.String getUploadURL(java.lang.Object userId,
                              java.lang.String password,
                              java.lang.Object projectId,
                              java.lang.String[] filePath,
                              java.lang.String fileType)
                       throws java.rmi.RemoteException

Obtem a url atraves da qual o arquivo deve ser acessado para upload.

Parameters:

userId - Identificador do usuário no servidor http remoto.

password - Senha do usuário para autenticar o usuário que está fazendo a chamada do método.

projectId - Identificador do projeto.

filePath - Caminho do arquivo no projeto.

fileType - Tipo do arquivo a ser obtido.

Returns:

Texto que representa a URL para acesso ao arquivo.

Throws:

java.rmi.RemoteException

getFileType

java.lang.String getFileType(java.lang.String accessCode,
                             java.lang.String filePath)
                      throws java.rmi.RemoteException

Obtem o tipo do arquivo a ser exibido

Parameters:

accessCode - de acesso do arquivo

filePath - caminho do arquivo

Returns:

.

Throws:

java.rmi.RemoteException - .

getFilePath

java.lang.String getFilePath(java.lang.String accessCode)
                      throws java.rmi.RemoteException

Obtem o caminho do arquivo a ser exibido

Parameters:

accessCode - de acesso do arquivo

Returns:

caminho canonico do arquivo

Throws:

java.rmi.RemoteException - .

getFilePath

java.lang.String getFilePath(java.lang.String accessCode,
                             java.lang.String filePath)
                      throws java.rmi.RemoteException

Obtem o caminho do arquivo a ser exibido

Parameters:

accessCode - de acesso do arquivo

filePath - caminho do arquivo

Returns:

caminho canonico do arquivo

Throws:

java.rmi.RemoteException - .

getPresentationPath

java.lang.String getPresentationPath(java.lang.String accessCode)
                              throws java.rmi.RemoteException

Obtem o caminho do arquivo de entrada do upload.

Parameters:

accessCode - de acesso do arquivo

Returns:

caminho canonico do arquivo

Throws:

java.rmi.RemoteException - .

getResultPath

java.lang.String getResultPath(java.lang.String accessCode)
                        throws java.rmi.RemoteException

Obtem o caminho do arquivo de resultado do upload.

Parameters:

accessCode - de acesso do arquivo

Returns:

caminho canonico do arquivo

Throws:

java.rmi.RemoteException - .

finishUpload

boolean finishUpload(java.lang.String accessCode,
                     java.lang.String fileName)
              throws HttpServiceException,
                     java.rmi.RemoteException

Remove o upload da lista de requisicoes e informa que o arquivo nao esta' mais em construcao.

Parameters:

accessCode -

fileName - O nome original do arquivo que sofreu upload.

Returns:

boolean se a operacao foi realizada com sucesso.

Throws:

HttpServiceException - .

java.rmi.RemoteException - .

isDirectory

boolean isDirectory(java.lang.String accessCode)
             throws java.rmi.RemoteException

Verifica se o arquivo e' diretorio.

Parameters:

accessCode -

Returns:

boolean que indica se o arquivo e' diretorio

Throws:

java.rmi.RemoteException - .

createFile

boolean createFile(java.lang.String accessCode,
                   java.lang.String fileName)
            throws java.rmi.RemoteException

Cria um arquivo

Parameters:

accessCode -

fileName - Nome do arquivo

Returns:

caso o tipo tenha sido setado com sucesso

Throws:

java.rmi.RemoteException - .

getText

java.lang.String getText(java.lang.String accessCode)
                  throws java.rmi.RemoteException

Pega o texto que está armazenado na RequestInfo referente ao accessCode passado. Se o accessCode for null ou inválido o método retornará null.

Parameters:

accessCode -

Returns:

Texto a ser jogado no browser

Throws:

java.rmi.RemoteException

getDownloadType

int getDownloadType(java.lang.String accessCode)
             throws java.rmi.RemoteException

Pega o tipo de método utilizado no download referente ao accessCode passado. Se o accessCode for null ou inválido o método retornará UNKNOWN_DOWNLOAD_TYPE.

Parameters:

accessCode -

Returns:

tipo de donwload

Throws:

java.rmi.RemoteException

getDownloadTextURL

java.lang.String getDownloadTextURL(java.lang.Object userId,
                                    java.lang.String password,
                                    java.lang.String text)
                             throws java.rmi.RemoteException

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

Parameters:

userId -

password -

text -

Returns:

Throws:

java.rmi.RemoteException

getDownloadTextURL

java.lang.String getDownloadTextURL(java.lang.Object userId,
                                    java.lang.String password,
                                    java.lang.String text,
                                    java.lang.String fileName)
                             throws java.rmi.RemoteException

Pega a URL que será chamada pelo browser quando o tipo de dowload for TEXTO, permitindo a escolha do nome do arquivo.

Parameters:

userId -

password -

text -

fileName -

Returns:

Throws:

java.rmi.RemoteException

getDownloadCSVURL

java.lang.String getDownloadCSVURL(java.lang.Object userId,
                                   java.lang.String password,
                                   java.lang.String text)
                            throws java.rmi.RemoteException

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

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:

java.rmi.RemoteException

getDownloadCSVURL

java.lang.String getDownloadCSVURL(java.lang.Object userId,
                                   java.lang.String password,
                                   java.lang.String text,
                                   java.lang.String fileName)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getParameters

java.util.Map getParameters(java.lang.String accessCode)
                     throws java.rmi.RemoteException

Obtém os parâmetros da RequestInfo para usos gerais

Parameters:

accessCode -

Returns:

Throws:

java.rmi.RemoteException

getJdbcDriverClassName

java.lang.String getJdbcDriverClassName(java.lang.String accessCode)
                                 throws java.rmi.RemoteException

Obtém o nome da classe do driver JDBC para criação de uma conexão com um banco de dados a partir do servlets(upload e download), caso seja necessário.

Parameters:

accessCode -

Returns:

Throws:

java.rmi.RemoteException

getJdbcURL

java.lang.String getJdbcURL(java.lang.String accessCode)
                     throws java.rmi.RemoteException

Obtém URL JDBC para criação de uma conexão com um banco de dados a partir do servlets(upload e download), caso seja necessário.

Parameters:

accessCode -

Returns:

Throws:

java.rmi.RemoteException

getJdbcUser

java.lang.String getJdbcUser(java.lang.String accessCode)
                      throws java.rmi.RemoteException

Obtém o usuário JDBC para criação de uma conexão com um banco de dados a partir do servlets(upload e download), caso seja necessário.

Parameters:

accessCode -

Returns:

Throws:

java.rmi.RemoteException

getJdbcPassword

java.lang.String getJdbcPassword(java.lang.String accessCode)
                          throws java.rmi.RemoteException

Obtém a senha JDBC para criação de uma conexão com um banco de dados a partir do servlets(upload e download), caso seja necessário.

Parameters:

accessCode -

Returns:

Throws:

java.rmi.RemoteException

getRequestListSize

int getRequestListSize()
                throws java.rmi.RemoteException

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

Returns:

Throws:

java.rmi.RemoteException