FTP
Recurso cliente de FTP.
abort
_ftp.abort() : FTP
Descrição
Interrompe a operação de transferência de dados em andamento.
Retorno
( FTP )
O recurso FTP atual.
changeToParentDirectory
_ftp.changeToParentDirectory() : FTP
Descrição
Muda para a pasta anterior onde deve ser utilizada para realizar as operações.
Retorno
( FTP )
O recurso FTP atual.
changeWorkingDirectory
_ftp.changeWorkingDirectory(caminhoRemoto: string) : FTP
Descrição
Define o caminho remoto que deve ser utilizado para realizar as operações.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor para realizar o trabalho. |
Retorno
( FTP )
O recurso FTP atual.
close
_ftp.close() : void
Descrição
Fecha a conexão FTP com o servidor.
Retorno
( void )
config
_ftp.config() : FTPConfig
Descrição
Inicia uma nova configuração própria.
Retorno
( FTPConfig )
Objeto de configuração carregada a partir dos dados recebidos.
_ftp.config(config: Values) : FTPConfig
Descrição
Inicia uma nova configuração própria.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| config | Values | Estrutura de dados da definição da configuração. |
Retorno
( FTPConfig )
Objeto de configuração carregada a partir dos dados recebidos.
_ftp.config(config: FTPConfig) : FTP
Descrição
Define outra configuração que deve ser utilizada.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| config | FTPConfig | Definição da nova configuração. |
Retorno
( FTP )
Objeto FTP atual.
connect
_ftp.connect() : FTP
Descrição
Inicia a conexão com o servidor através do FTP.
Retorno
( FTP )
O recurso FTP atual.
createDirectory
_ftp.createDirectory(caminhoRemoto: string) : FTP
Descrição
Cria uma pastas no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor onde a pasta será criada. |
Retorno
( FTP )
O recurso FTP atual.
deleteDirectory
_ftp.deleteDirectory(caminhoRemoto: string) : FTP
Descrição
Remove uma pasta no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor a pasta será removida. |
Retorno
( FTP )
O recurso FTP atual.
deleteFile
_ftp.deleteFile(caminhoRemoto: string) : FTP
Descrição
Remove um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor o arquivo será removido. |
Retorno
( FTP )
O recurso FTP atual.
disconnect
_ftp.disconnect() : FTP
Descrição
Realiza a desconexão FTP com o servidor.
Retorno
( FTP )
O recurso FTP atual.
download
_ftp.download(caminhoRemoto: string, destino: OutputStream) : FTP
Descrição
Copia um arquivo no servidor para um arquivo local.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| destino | OutputStream | Arquivo local de destino para armazenar o conteúdo remoto. |
Retorno
( FTP )
O recurso FTP atual.
_ftp.download(caminhoRemoto: string, destino: File) : FTP
Descrição
Copia um arquivo no servidor para um arquivo local.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| destino | File | Arquivo local de destino para armazenar o conteúdo remoto. |
Retorno
( FTP )
O recurso FTP atual.
_ftp.download(caminhoRemoto: string, destino: Storage) : FTP
Descrição
Copia um arquivo no servidor para um arquivo local.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| destino | Storage | Arquivo local de destino para armazenar o conteúdo remoto. |
Retorno
( FTP )
O recurso FTP atual.
downloadBytes
_ftp.downloadBytes(caminhoRemoto: string) : byte[]
Descrição
Obtém um array de bytes do conteúdo de um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
Retorno
( byte[] )
Array de bytes com o conteúdo do arquivo remoto no servidor.
downloadText
_ftp.downloadText(caminhoRemoto: string) : string
Descrição
Obtém um conteúdo de texto de um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
Retorno
( string )
Conteúdo de texto do arquivo remoto no servidor.
_ftp.downloadText(caminhoRemoto: string, encodificacao: string) : string
Descrição
Obtém um conteúdo de texto de um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| encodificacao | string | Código de encodificação dos caractéres. |
Retorno
( string )
Conteúdo de texto do arquivo remoto no servidor.
enabled
_ftp.enabled() : boolean
Retorno
( boolean )
_ftp.enabled(ativo: boolean) : FTP
Descrição
Define se está habilitado.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| ativo | boolean | Se fica ativo ou inactivo. |
Retorno
( FTP )
Objeto FTP atual.
getClient
_ftp.getClient() : org.netuno.psamata.ftp.FTPClient
Descrição
Obtém o cliente FTP base.
Retorno
( org.netuno.psamata.ftp.FTPClient )
Cliente FTP original de base.
getConfig
_ftp.getConfig() : FTPConfig
Descrição
Obtém a configuração que está a ser utilizada.
Retorno
( FTPConfig )
Objeto da configuração ativa.
getWorkingDirectory
_ftp.getWorkingDirectory() : string
Descrição
Obtém o caminho remoto atual de trabalho onde as operações estão sendo realizadas.
Retorno
( string )
O caminho remoto completo que está sendo utilizado.
init
_ftp.init() : FTP
Descrição
Inicia uma nova instância do FTP utilizando a configuração do FTP da chave default.
Retorno
( FTP )
A nova instância do recurso FTP com base na configuração do FTP default.
_ftp.init(configKey: string) : FTP
Descrição
Inicia uma nova instância do FTP a partir de uma configuração específica.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| configKey | string | Chave da configuração FTP que será utilizada. |
Retorno
( FTP )
A nova instância do recurso FTP com base na configuração do FTP especificada.
_ftp.init(config: FTPConfig) : FTP
Descrição
Inicia uma nova instância do FTP a partir de uma configuração que é definida em um objeto de configuração própria.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| config | FTPConfig | Configuração que será utilizada. |
Retorno
( FTP )
A nova instância do recurso FTP com base na configuração definida.
isEnabled
_ftp.isEnabled() : boolean
Descrição
Verifica se está habilitado.
Retorno
( boolean )
Resultado se está ou não ativado.
list
_ftp.list(caminhoRemoto: string) : java.util.List
Descrição
Lista os itens da pasta no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho da pasta no servidor. |
Retorno
( java.util.List )
A lista de itens que está caminho do servidor.
rename
_ftp.rename(caminhoAntigo: string, caminhoNovo: string) : FTP
Descrição
Renomeia um arquivo ou pasta no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoAntigo | string | Caminho no servidor que deve ser renomeado. |
| caminhoNovo | string | O caminho de destino no servidor. |
Retorno
( FTP )
O recurso FTP atual.
sendCommand
_ftp.sendCommand(comando: string) : int
Descrição
Envia um comando específico.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| comando | string | Comando que deve ser enviado. |
Retorno
( int )
Resultado do comando.
_ftp.sendCommand(comando: string, args: string) : int
Descrição
Envia um comando específico com argumentos adicionais necessários para o comando FTP.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| comando | string | Comando que deve ser enviado. |
| args | string | Argumentos adicionais. |
Retorno
( int )
Resultado do comando.
sendSiteCommand
_ftp.sendSiteCommand(comando: string) : FTP
Descrição
Envia um comando específico do site.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| comando | string | Comando que deve ser enviado. |
Retorno
( FTP )
O recurso FTP atual.
setConfig
_ftp.setConfig(config: FTPConfig) : FTP
Descrição
Define outra configuração que deve ser utilizada.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| config | FTPConfig | Definição da nova configuração. |
Retorno
( FTP )
Objeto FTP atual.
setEnabled
_ftp.setEnabled(ativo: boolean) : FTP
Descrição
Define se está habilitado.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| ativo | boolean | Se fica ativo ou inactivo. |
Retorno
( FTP )
Objeto FTP atual.
upload
_ftp.upload(caminhoRemoto: string, origem: InputStream) : FTP
Descrição
Envia os dados de um arquivo para ser salvo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| origem | InputStream | Arquivo local de origem. |
Retorno
( FTP )
O recurso FTP atual.
_ftp.upload(caminhoRemoto: string, origem: File) : FTP
Descrição
Envia os dados de um arquivo para ser salvo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| origem | File | Arquivo local de origem. |
Retorno
( FTP )
O recurso FTP atual.
_ftp.upload(caminhoRemoto: string, origem: Storage) : FTP
Descrição
Envia os dados de um arquivo para ser salvo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| origem | Storage | Arquivo local de origem. |
Retorno
( FTP )
O recurso FTP atual.
uploadBytes
_ftp.uploadBytes(caminhoRemoto: string, bytes: byte[]) : FTP
Descrição
Envia um array de bytes para serem salvos em um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| bytes | byte[] | Array de bytes. |
Retorno
( FTP )
O recurso FTP atual.
uploadText
_ftp.uploadText(caminhoRemoto: string, texto: string) : FTP
Descrição
Envia um conteúdo de texto para ser salvado em um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| texto | string | Conteúdo de texto. |
Retorno
( FTP )
O recurso FTP atual.
_ftp.uploadText(caminhoRemoto: string, texto: string, encodificacao: string) : FTP
Descrição
Envia um conteúdo de texto para ser salvado em um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho do arquivo no servidor. |
| texto | string | Conteúdo de texto. |
| encodificacao | string | Código de encodificação dos caractéres. |
Retorno
( FTP )
O recurso FTP atual.