palio.modules
Class FTP

java.lang.Object
  extended by palio.modules.core.Module
      extended by palio.modules.FTP
All Implemented Interfaces:
palio.modules.core.CurrentModuleDataKeys

public class FTP
extends palio.modules.core.Module

Moduł udostępnia zestaw funkcji do wykonywania opearcji związanych z transferem plików z serwera FTP. Aby można było polączyć sie z serwerem, należy zdefiniować konektor "FTP" w konfiguracji instancji jpalio. Parametr transferMode jest opcjonalny. W przypadku jego braku, wybierana jest domyślna wartość dla serwera. Dozwolone wartości: ACTIVE, PASSIVE. Przykładowy konektor:
<connector name="ftp" url="ftp://ftp.torn.com.pl:21">
  <user>test</user>
  <password>test</password>
  <transferMode>ACTIVE</transferMode>
</connector>

Moduł jest dostępny w każdej instancji jPalio.

Version:
1.1.0
Author:
Krzysztof Madyniak (kmadyniak@torn.com.pl), Tomasz Rogozik (trogozik@torn.com.pl)

Field Summary
 
Fields inherited from interface palio.modules.core.CurrentModuleDataKeys
DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT
 
Constructor Summary
FTP(palio.Instance instance, java.util.Properties parameters)
           
 
Method Summary
 void deleteFile(java.lang.String connector, java.lang.String remotePath)
          Usuwa plik z serwera FTP
 java.lang.Object execute(java.lang.String connector, Closure commands)
          Calles given closure with passed FTPClient object as an argument.
 java.lang.Long getFileSize(java.lang.String connector, java.lang.String remotePath)
          Zwraca rozmiar pliku (w bajtach) znajdującego się na serwerze FTP
 java.lang.String getVersion()
          Returns the module version
 java.lang.String[] listFiles(java.lang.String connector, java.lang.String remotePath)
          Zwraca tablicę nazw plików i folderów w wybranym folderze zdalnym
 java.lang.String[] listFiles(java.lang.String connector, java.lang.String remotePath, java.lang.Boolean fullPath)
          Zwraca tablicę nazw plików i folderów w wybranym folderze zdalnym
 void makeDirectory(java.lang.String connector, java.lang.String remotePath)
          Tworzy nowy folder na serwerze FTP
 void removeDirectory(java.lang.String connector, java.lang.String remotePath)
          Usuwa pusty folder na serwerze FTP
 void renameFile(java.lang.String connector, java.lang.String remotePathFrom, java.lang.String remotePathTo)
          Zmienia nazwę pliku na serwerze FTP
 void retriveFile(java.lang.String connector, java.lang.String remotePath, java.lang.String localPath)
          Pobiera plik z serwera
 void storeFile(java.lang.String connector, java.lang.String remotePath, java.lang.String localPath)
          Wykonuje upload pliku na serwer
 void storeFile(java.lang.String connector, java.lang.String remotePath, java.lang.String localPath, java.lang.String fileType)
          Wykonuje upload pliku na serwer
 
Methods inherited from class palio.modules.core.Module
getConfigParam, getDescription, getModuleTranslation
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FTP

public FTP(palio.Instance instance,
           java.util.Properties parameters)
Method Detail

getVersion

public java.lang.String getVersion()
Description copied from class: palio.modules.core.Module
Returns the module version

Specified by:
getVersion in class palio.modules.core.Module

retriveFile

public void retriveFile(java.lang.String connector,
                        java.lang.String remotePath,
                        java.lang.String localPath)
                 throws palio.PalioException
Pobiera plik z serwera

Parameters:
connector - Nazwa konektora
remotePath - Ścieżka do pliku na serwerze FTP
localPath - Docelowa ścieżka do pliku lokalnego
Throws:
palio.PalioException

storeFile

public void storeFile(java.lang.String connector,
                      java.lang.String remotePath,
                      java.lang.String localPath,
                      java.lang.String fileType)
               throws palio.PalioException
Wykonuje upload pliku na serwer

Parameters:
connector - Nazwa konektora
remotePath - Docelowa ścieżka do pliku na serwerze FTP
localPath - Ścieżka do pliku lokalnego
fileType - Nazwa typu pliku. Możliwe wartości: ASCII, BINARY, EBCDIC, LOCAL.
Throws:
palio.PalioException
Since:
jPALIO 7.0.9, module 1.0.2

storeFile

public void storeFile(java.lang.String connector,
                      java.lang.String remotePath,
                      java.lang.String localPath)
               throws palio.PalioException
Wykonuje upload pliku na serwer

Parameters:
connector - nazwa konektora
remotePath - docelowa ścieżka do pliku na serwerze FTP
localPath - ścieżka do pliku lokalnego
Throws:
palio.PalioException

listFiles

public java.lang.String[] listFiles(java.lang.String connector,
                                    java.lang.String remotePath,
                                    java.lang.Boolean fullPath)
                             throws palio.PalioException
Zwraca tablicę nazw plików i folderów w wybranym folderze zdalnym

Parameters:
connector - nazwa konektora
remotePath - ścieżka do folderu na serwerze FTP
fullPath - czy nazwy plików mają zawierać pełną ścieżkę
Returns:
tablica nazw plików znajdujących się w folderze zdalnym
Throws:
palio.PalioException
Since:
jPALIO 7.2.0, module 1.0.3

listFiles

public java.lang.String[] listFiles(java.lang.String connector,
                                    java.lang.String remotePath)
                             throws palio.PalioException
Zwraca tablicę nazw plików i folderów w wybranym folderze zdalnym

Parameters:
connector - nazwa konektora
remotePath - ścieżka do folderu na serwerze FTP
Returns:
tablica nazw plików znajdujących się w folderze zdalnym
Throws:
palio.PalioException
Since:
jPALIO 7.2.0, module 1.0.3

deleteFile

public void deleteFile(java.lang.String connector,
                       java.lang.String remotePath)
                throws palio.PalioException
Usuwa plik z serwera FTP

Parameters:
connector - nazwa konektora
remotePath - ścieżka do pliku na serwerze FTP
Throws:
palio.PalioException
Since:
jPALIO 7.2.0, module 1.0.3

renameFile

public void renameFile(java.lang.String connector,
                       java.lang.String remotePathFrom,
                       java.lang.String remotePathTo)
                throws palio.PalioException
Zmienia nazwę pliku na serwerze FTP

Parameters:
connector - nazwa konektora
remotePathFrom - pierwotna ścieżka pliku na serwerze FTP
remotePathTo - docelowa ścieżka pliku na serwerze FTP
Throws:
palio.PalioException
Since:
jPALIO 7.2.0, module 1.0.3

makeDirectory

public void makeDirectory(java.lang.String connector,
                          java.lang.String remotePath)
                   throws palio.PalioException
Tworzy nowy folder na serwerze FTP

Parameters:
connector - nazwa konektora
remotePath - docelowa ścieżka folderu na serwerze FTP
Throws:
palio.PalioException
Since:
jPALIO 7.2.0, module 1.0.3

removeDirectory

public void removeDirectory(java.lang.String connector,
                            java.lang.String remotePath)
                     throws palio.PalioException
Usuwa pusty folder na serwerze FTP

Parameters:
connector - nazwa konektora
remotePath - ścieżka istniejącego folderu na serwerze FTP
Throws:
palio.PalioException
Since:
jPALIO 7.2.0, module 1.0.3

getFileSize

public java.lang.Long getFileSize(java.lang.String connector,
                                  java.lang.String remotePath)
                           throws palio.PalioException
Zwraca rozmiar pliku (w bajtach) znajdującego się na serwerze FTP

Parameters:
connector - nazwa konektora
remotePath - ścieżka istniejącego pliku na serwerze FTP
Returns:
rozmiar pliku (w bajtach)
Throws:
palio.PalioException
Since:
jPALIO 7.2.0, module 1.0.3

execute

public java.lang.Object execute(java.lang.String connector,
                                Closure commands)
                         throws palio.PalioException
Calles given closure with passed FTPClient object as an argument. Can be used for some operations that are not supperted by this module. Should be used only by programmers with basic knowledge of Apache Commons Net library.

Parameters:
connector - Connector name
commands - Commands closure. This closure is called with one parameter of type FTPClient. See jPALIO documentation for some examples.
Returns:
Value returned by given commnads closure
Throws:
palio.PalioException
Since:
jPALIO 7.4.32, module 1.1.0