SSHSFTP
Cliente SFTP utilizado com o SSH.
close
close() : void
Descrição
Fecha a sessão atual de SFTP.
Retorno
( void )
closed
closed() : boolean
Descrição
Verifica se a sessão SFTP ainda está aberta.
Retorno
( boolean )
Verdadeiro se estiver aberta
createDirectories
createDirectories(caminhoRemoto: string) : SSHSFTP
Descrição
Cria o caminho de pastas no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor onde a estrutura de pastas será criada. |
Retorno
( SSHSFTP )
O cliente SFTP atual.
createDirectory
createDirectory(caminhoRemoto: string) : SSHSFTP
Descrição
Cria uma pastas no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor onde a pasta será criada. |
Retorno
( SSHSFTP )
O cliente SFTP atual.
deleteDirectory
deleteDirectory(caminhoRemoto: string) : SSHSFTP
Descrição
Remove uma pasta no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor a pasta será removida. |
Retorno
( SSHSFTP )
O cliente SFTP atual.
deleteFile
deleteFile(caminhoRemoto: string) : SSHSFTP
Descrição
Remove um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor o arquivo será removido. |
Retorno
( SSHSFTP )
O cliente SFTP atual.
download
download(caminhoRemoto: string, destino: OutputStream) : SSHSFTP
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
( SSHSFTP )
O cliente SFTP atual.
download(caminhoRemoto: string, destino: File) : SSHSFTP
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
( SSHSFTP )
O cliente SFTP atual.
downloadBytes
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
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.
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.
isClosed
isClosed() : boolean
Descrição
Verifica se a sessão SFTP ainda está aberta.
Retorno
( boolean )
Verdadeiro se estiver aberta
list
list(caminhoRemoto: string) : java.util.List<SSHFile>
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.
size
size(caminhoRemoto: string) : long
Descrição
Obtém o tamanho de um arquivo no servidor.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| caminhoRemoto | string | Caminho no servidor onde o arquivo está. |
Retorno
( long )
O tamanho do arquivo.
upload
upload(caminhoRemoto: string, origem: InputStream) : SSHSFTP
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
( SSHSFTP )
O cliente SFTP atual.
upload(caminhoRemoto: string, origem: File) : SSHSFTP
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
( SSHSFTP )
O cliente SFTP atual.
uploadBytes
uploadBytes(caminhoRemoto: string, bytes: byte[]) : SSHSFTP
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
( SSHSFTP )
O cliente SFTP atual.
uploadText
uploadText(caminhoRemoto: string, texto: string) : SSHSFTP
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
( SSHSFTP )
O cliente SFTP atual.
uploadText(caminhoRemoto: string, texto: string, encodificacao: string) : SSHSFTP
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
( SSHSFTP )
O cliente SFTP atual.