csbase.remote

Interface HttpServiceInterface

All Superinterfaces:

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 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(String accessCode, String fileName) Cria um arquivo
boolean	finishUpload(String accessCode, String fileName) Remove o upload da lista de requisicoes e informa que o arquivo nao esta' mais em construcao.
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 download for CSV.
String	getDownloadTextURL(Object userId, String password, String text) Pega a URL que será chamada pelo browser quando o tipo de dowload for TEXTO.
String	getDownloadTextURL(Object userId, String password, String text, 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(String accessCode) Pega o tipo de método utilizado no download referente ao accessCode passado.
String	getDownloadURL(Object userId, String password, Object projectId, String[] filePath) Obtem a url atraves da qual o arquivo deve ser acessado para download.
String	getFilePath(String accessCode) Obtem o caminho do arquivo a ser exibido
String	getFilePath(String accessCode, String filePath) Obtem o caminho do arquivo a ser exibido
String	getFileType(String accessCode, String filePath) Obtem o tipo do arquivo a ser exibido
String	getJdbcDriverClassName(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.
String	getJdbcPassword(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.
String	getJdbcURL(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.
String	getJdbcUser(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.
Map	getParameters(String accessCode) Obtém os parâmetros da RequestInfo para usos gerais
String	getPresentationPath(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.
String	getResultPath(String accessCode) Obtem o caminho do arquivo de resultado do upload.
String	getText(String accessCode) Pega o texto que está armazenado na RequestInfo referente ao accessCode passado.
String	getUploadURL(Object userId, String password, Object projectId, String[] filePath, String fileType) Obtem a url atraves da qual o arquivo deve ser acessado para upload.
boolean	isDirectory(String accessCode) Verifica se o arquivo e' diretorio.

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

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

String getDownloadURL(Object userId,
                      String password,
                      Object projectId,
                      String[] filePath)
               throws 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:

RemoteException - em caso de erro de comunicação.

getUploadURL

String getUploadURL(Object userId,
                    String password,
                    Object projectId,
                    String[] filePath,
                    String fileType)
             throws 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:

RemoteException - em caso de erro de comunicação.

getFileType

String getFileType(String accessCode,
                   String filePath)
            throws RemoteException

Obtem o tipo do arquivo a ser exibido

Parameters:

accessCode - de acesso do arquivo

filePath - caminho do arquivo

Returns:

.

Throws:

RemoteException - em caso de erro de comunicação.

getFilePath

String getFilePath(String accessCode)
            throws RemoteException

Obtem o caminho do arquivo a ser exibido

Parameters:

accessCode - de acesso do arquivo

Returns:

caminho canonico do arquivo

Throws:

RemoteException - em caso de erro de comunicação.

getFilePath

String getFilePath(String accessCode,
                   String filePath)
            throws 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:

RemoteException - em caso de erro de comunicação.

getPresentationPath

String getPresentationPath(String accessCode)
                    throws RemoteException

Obtem o caminho do arquivo de entrada do upload.

Parameters:

accessCode - de acesso do arquivo

Returns:

caminho canonico do arquivo

Throws:

RemoteException - em caso de erro de comunicação.

getResultPath

String getResultPath(String accessCode)
              throws RemoteException

Obtem o caminho do arquivo de resultado do upload.

Parameters:

accessCode - de acesso do arquivo

Returns:

caminho canonico do arquivo

Throws:

RemoteException - em caso de erro de comunicação.

finishUpload

boolean finishUpload(String accessCode,
                     String fileName)
              throws HttpServiceException,
                     RemoteException

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

Parameters:

accessCode - de acesso do arquivo

fileName - O nome original do arquivo que sofreu upload.

Returns:

boolean se a operacao foi realizada com sucesso.

Throws:

HttpServiceException - .

RemoteException - em caso de erro de comunicação.

isDirectory

boolean isDirectory(String accessCode)
             throws RemoteException

Verifica se o arquivo e' diretorio.

Parameters:

accessCode - de acesso do arquivo

Returns:

boolean que indica se o arquivo e' diretorio

Throws:

RemoteException - em caso de erro de comunicação.

createFile

boolean createFile(String accessCode,
                   String fileName)
            throws RemoteException

Cria um arquivo

Parameters:

accessCode - de acesso do arquivo

fileName - Nome do arquivo

Returns:

caso o tipo tenha sido setado com sucesso

Throws:

RemoteException - em caso de erro de comunicação.

getText

String getText(String accessCode)
        throws 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 - de acesso do arquivo

Returns:

Texto a ser jogado no browser

Throws:

RemoteException - em caso de erro de comunicação.

getDownloadType

int getDownloadType(String accessCode)
             throws 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 - de acesso do arquivo

Returns:

tipo de donwload

Throws:

RemoteException - em caso de erro de comunicação.

getDownloadTextURL

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

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

Parameters:

userId - identificação do usuário.

password - senha do usuário.

text - texto contendo o conteúdo do CSV.

Returns:

a URL.

Throws:

RemoteException - em caso de erro de comunicação.

getDownloadTextURL

String getDownloadTextURL(Object userId,
                          String password,
                          String text,
                          String fileName)
                   throws 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 - identificação do usuário.

password - senha do usuário.

text - texto contendo o conteúdo do CSV.

fileName - o nome do arquivo.

Returns:

a URL.

Throws:

RemoteException - em caso de erro de comunicação.

getDownloadCSVURL

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.

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 de comunicação.

getDownloadCSVURL

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

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

Parameters:

userId - identificação do usuário.

password - senha do usuário.

text - texto contendo o conteúdo do CSV.

fileName - o nome do arquivo.

Returns:

URL de download do arquivo CSV.

Throws:

RemoteException - em caso de erro de comunicação.

getParameters

Map getParameters(String accessCode)
           throws RemoteException

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

Parameters:

accessCode - de acesso do arquivo

Returns:

os parâmetros.

Throws:

RemoteException - em caso de erro de comunicação.

getJdbcDriverClassName

String getJdbcDriverClassName(String accessCode)
                       throws 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 - de acesso do arquivo

Returns:

o nome da classe do driver JDBC.

Throws:

RemoteException - em caso de erro de comunicação.

getJdbcURL

String getJdbcURL(String accessCode)
           throws 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 - de acesso do arquivo

Returns:

a URL JDBC.

Throws:

RemoteException - em caso de erro de comunicação.

getJdbcUser

String getJdbcUser(String accessCode)
            throws 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 - de acesso do arquivo

Returns:

o usuário JDBC.

Throws:

RemoteException - em caso de erro de comunicação.

getJdbcPassword

String getJdbcPassword(String accessCode)
                throws 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 - de acesso do arquivo

Returns:

a senha JDBC.

Throws:

RemoteException - em caso de erro de comunicação.

getRequestListSize

int getRequestListSize()
                throws RemoteException

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

Returns:

o número de requisições.

Throws:

RemoteException - em caso de erro de comunicação.