palio.modules
Class Disk

java.lang.Object
  palio.modules.core.Module
      palio.modules.Disk

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class Disk
extends Module

Moduł udostępnia podstawowe funkcje dostępu do plików dyskowych.

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

Version:

1.1.2

Author:

Leszek Leszczyński, Mateusz Gembarzewski, Krzysztof Madyniak, Krzysztof Synowiec

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

Disk(Instance instance, java.util.Properties parameters)

Method Summary

static void	append(java.lang.String filename, byte[] data) Dopisuje dane do pliku na dysku
static void	append(java.lang.String filename, java.lang.String data) Dopisuje dane do pliku na dysku.
static void	append(java.lang.String filename, java.lang.String data, java.lang.String charset) Dopisuje dane do pliku na dysku
static byte[]	convertFile(byte[] input, java.lang.String inputCharset, java.lang.String outputCharset) Konwertuje zawartość pliku tekstowego zakodowanego w inputCharset na nowe kodowanie outputCharset.
static java.lang.Long	copyFile(java.lang.String sourceFile, java.lang.String destinationFile) Kopiuje plik.
static java.lang.Long	copyURLToFile(java.lang.String sourceURL, java.lang.String destinationFile) Kopiuje zawartość adresu URL do pliku.
static java.lang.Long	copyURLToFile(java.lang.String sourceURL, java.lang.String destinationFile, java.lang.Long timeout) Kopiuje zawartość adresu URL do pliku.
static java.lang.Long	copyURLToFile(java.lang.String sourceURL, java.lang.String destinationFile, java.lang.String user, java.lang.String password) Kopiuje zawartość adresu URL do pliku z użyciem prostej autoryzacji HTTP.
static java.lang.Long	copyURLToFile(java.lang.String sourceURL, java.lang.String destinationFile, java.lang.String user, java.lang.String password, java.lang.Long timeout) Kopiuje zawartość adresu URL do pliku z użyciem prostej autoryzacji HTTP.
static void	decompressGZIP(java.lang.String gzipFile, java.lang.String targetFile) Rozpakowuje plik spakowany gzipem.
static void	deleteFile(java.lang.String path) Deletes a file from given path.
static java.lang.Object[]	fileInfo(java.lang.String path) Jeżeli podana ścieżka prowadzi do istniejącego pliku to funkcja zwraca następujące dane na temat tego pliku: [name, path, length, lastModified, canRead, canWrite, isHidden].
static java.lang.Long	fileSize(java.lang.String path)
static java.lang.Long	getSize(java.lang.String filename) Zwraca długość pliku
java.lang.String	getVersion() Zwraca numer wersji modułu
static java.lang.Object[]	ls(java.lang.String path) Listuje zawartość katalogu.
static java.lang.Object[]	ls(java.lang.String path, java.lang.String regexFilter) Listuje zawartość katalogu z nałożonym filtrem.
static boolean	mkdir(java.lang.String path) Tworzy nowy katalog
static boolean	mkdirs(java.lang.String path)
static byte[]	read(java.lang.String filename) Wczytuje dane z dysku
static java.lang.String	readText(java.lang.String filename) Wczytuje dane z dysku z pliku tekstowego.
static java.lang.String	readText(java.lang.String filename, java.lang.String charset) Wczytuje dane z dysku z pliku tekstowego.
static void	rename(java.lang.String from, java.lang.String to) Renames/moves given file or directory
static void	renameTo(java.lang.String from, java.lang.String to) Deprecated. Replaced by rename(String, String)
static void	write(java.lang.String filename, byte[] data) Zapisuje dane do pliku na dysku
static void	write(java.lang.String filename, java.lang.String data) Zapisuje dane do pliku na dysku.
static void	write(java.lang.String filename, java.lang.String data, java.lang.String charset) Zapisuje dane do pliku na dysku

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

Disk

public Disk(Instance instance,
            java.util.Properties parameters)

Method Detail

getVersion

public java.lang.String getVersion()

Zwraca numer wersji modułu

Specified by:

getVersion in class Module

append

public static void append(java.lang.String filename,
                          java.lang.String data)
                   throws java.io.IOException

Dopisuje dane do pliku na dysku. Używa domyślnego kodowania maszyny wirtualnej.

Parameters:

filename - nazwa pliku do zapisania

data - dane do zapisania

Throws:

java.io.IOException

Since:

jPALIO 7.0.11, module 1.1.0

append

public static void append(java.lang.String filename,
                          java.lang.String data,
                          java.lang.String charset)
                   throws java.io.IOException

Dopisuje dane do pliku na dysku

Parameters:

filename - nazwa pliku do zapisania

data - dane do zapisania

charset - kodowanie w jakim ma zostać zapisany plik

Throws:

java.io.IOException

Since:

jPALIO 7.0.11, module 1.1.0

append

public static void append(java.lang.String filename,
                          byte[] data)
                   throws java.io.IOException

Dopisuje dane do pliku na dysku

Parameters:

filename - nazwa pliku do zapisania

data - dane do zapisania

Throws:

java.io.IOException

Since:

jPALIO 7.0.11, module 1.1.0

write

public static void write(java.lang.String filename,
                         java.lang.String data)
                  throws java.io.IOException

Zapisuje dane do pliku na dysku. Używa domyślnego kodowania maszyny wirtualnej.

Parameters:

filename - nazwa pliku do zapisania

data - dane do zapisania

Throws:

java.io.IOException

write

public static void write(java.lang.String filename,
                         java.lang.String data,
                         java.lang.String charset)
                  throws java.io.IOException

Zapisuje dane do pliku na dysku

Parameters:

filename - nazwa pliku do zapisania

data - dane do zapisania

charset - kodowanie w jakim ma zostać zapisany plik

Throws:

java.io.IOException

Since:

jPALIO 7.0.11, module 1.1.0

write

public static void write(java.lang.String filename,
                         byte[] data)
                  throws java.io.IOException

Zapisuje dane do pliku na dysku

Parameters:

filename - nazwa pliku do zapisania

data - dane do zapisania

Throws:

java.io.IOException

read

public static byte[] read(java.lang.String filename)
                   throws java.io.IOException,
                          palio.PalioException

Wczytuje dane z dysku

Parameters:

filename - nazwa pliku do pobrania danych

Throws:

java.io.IOException

palio.PalioException

readText

public static java.lang.String readText(java.lang.String filename)
                                 throws palio.PalioException,
                                        java.io.IOException

Wczytuje dane z dysku z pliku tekstowego.

Parameters:

filename - nazwa pliku do pobrania danych. Używa domyślnego kodowania maszyny wirtualnej.

Throws:

java.io.IOException

palio.PalioException

Since:

jPALIO 7.0.11, module 1.1.0

readText

public static java.lang.String readText(java.lang.String filename,
                                        java.lang.String charset)
                                 throws palio.PalioException,
                                        java.io.IOException

Wczytuje dane z dysku z pliku tekstowego.

Parameters:

filename - nazwa pliku do pobrania danych.

charset - kodowanie z jakim ma zostać wczytany plik tekstowy

Throws:

java.io.IOException

palio.PalioException

Since:

jPALIO 7.0.11, module 1.1.0

mkdir

public static boolean mkdir(java.lang.String path)

Tworzy nowy katalog

Parameters:

path - ścieżka katalogu

Returns:

true gdy katalog został utworzony, false w przeciwnym przypadku

mkdirs

public static boolean mkdirs(java.lang.String path)

ls

public static java.lang.Object[] ls(java.lang.String path)

Listuje zawartość katalogu. Każdy element tablicy to dwuelementowa tablica (0 - ścieżka, 1 - znacznik okreslający czy dany element to plik czy katalog (true-plik, false-katalog))

Parameters:

path - ścieżka katalogu

ls

public static java.lang.Object[] ls(java.lang.String path,
                                    java.lang.String regexFilter)

Listuje zawartość katalogu z nałożonym filtrem. Filtr realizowany przez wyrażenie regularne. Każdy element tablicy to dwuelementowa tablica (0 - ścieżka, 1 - znacznik okreslający czy dany element to plik czy katalog (true-plik, false-katalog))

Parameters:

path - ścieżka do katalogu

regexFilter - wyrażenie regularne filtru

getSize

public static java.lang.Long getSize(java.lang.String filename)

Zwraca długość pliku

Parameters:

filename - nazwa pliku

Since:

jPALIO 7.0.11, module 1.1.0

deleteFile

public static void deleteFile(java.lang.String path)
                       throws palio.PalioException

Deletes a file from given path.

Parameters:

path - File path

Throws:

palio.PalioException - If a resource from given path is not a file or deleting failed (File.delete() returns false)

renameTo

@Deprecated
public static void renameTo(java.lang.String from,
                                       java.lang.String to)

Deprecated. Replaced by rename(String, String)

Zmienia nazwę pliku/katalogu spod podanej ścieżki

Parameters:

from - nazwa pliku/katalogu zródłowego

to - nazwa pliku/katalogu docelowego

rename

public static void rename(java.lang.String from,
                          java.lang.String to)
                   throws palio.PalioException

Renames/moves given file or directory

Parameters:

from - Source resource name

to - Destitnation resource name

Throws:

palio.PalioException - If renaming failed (File.renameTo(File) returns false)

Since:

jPALIO 7.2.54, module 1.1.1

copyFile

public static java.lang.Long copyFile(java.lang.String sourceFile,
                                      java.lang.String destinationFile)
                               throws java.io.IOException

Kopiuje plik.

Parameters:

sourceFile - plik źródłowy

destinationFile - plik docelowy

Returns:

ilość bajtów skopiowanych

Throws:

java.io.IOException

copyURLToFile

public static java.lang.Long copyURLToFile(java.lang.String sourceURL,
                                           java.lang.String destinationFile,
                                           java.lang.Long timeout)
                                    throws java.io.IOException

Kopiuje zawartość adresu URL do pliku.

Parameters:

sourceURL - adres źródła

destinationFile - plik docelowy

timeout - timeout na połączenie podawany w milisekundach

Returns:

ilość bajtów skopiowanych

Throws:

java.io.IOException

copyURLToFile

public static java.lang.Long copyURLToFile(java.lang.String sourceURL,
                                           java.lang.String destinationFile)
                                    throws java.io.IOException

Kopiuje zawartość adresu URL do pliku.

Parameters:

sourceURL - adres źródła

destinationFile - plik docelowy

Returns:

ilość bajtów skopiowanych

Throws:

java.io.IOException

copyURLToFile

public static java.lang.Long copyURLToFile(java.lang.String sourceURL,
                                           java.lang.String destinationFile,
                                           java.lang.String user,
                                           java.lang.String password,
                                           java.lang.Long timeout)
                                    throws java.io.IOException

Kopiuje zawartość adresu URL do pliku z użyciem prostej autoryzacji HTTP.

Parameters:

sourceURL - adres źródła

destinationFile - plik docelowy

user - nazwa użytkownika

password - hasło

timeout - timeout na połączenie podawany w milisekundach

Returns:

ilość bajtów skopiowanych

Throws:

java.io.IOException

copyURLToFile

public static java.lang.Long copyURLToFile(java.lang.String sourceURL,
                                           java.lang.String destinationFile,
                                           java.lang.String user,
                                           java.lang.String password)
                                    throws java.io.IOException

Kopiuje zawartość adresu URL do pliku z użyciem prostej autoryzacji HTTP.

Parameters:

sourceURL - adres źródła

destinationFile - plik docelowy

user - nazwa użytkownika

password - hasło

Returns:

ilość bajtów skopiowanych

Throws:

java.io.IOException

fileSize

public static java.lang.Long fileSize(java.lang.String path)

fileInfo

public static java.lang.Object[] fileInfo(java.lang.String path)
                                   throws java.io.IOException

Jeżeli podana ścieżka prowadzi do istniejącego pliku to funkcja zwraca następujące dane na temat tego pliku: [name, path, length, lastModified, canRead, canWrite, isHidden].

Throws:

java.io.IOException

convertFile

public static byte[] convertFile(byte[] input,
                                 java.lang.String inputCharset,
                                 java.lang.String outputCharset)
                          throws java.io.UnsupportedEncodingException

Konwertuje zawartość pliku tekstowego zakodowanego w inputCharset na nowe kodowanie outputCharset. Przykładowe kodowania: "utf-8", "iso-8859-2".

Parameters:

input - zawartość pliku tekstowego

inputCharset - kodowanie pliku tekstowego

outputCharset - kodowanie wyjściowe

Returns:

zawartość tekstowego pliku po konwersji

Throws:

java.io.UnsupportedEncodingException

decompressGZIP

public static void decompressGZIP(java.lang.String gzipFile,
                                  java.lang.String targetFile)
                           throws java.io.FileNotFoundException,
                                  java.io.IOException

Rozpakowuje plik spakowany gzipem.

Parameters:

gzipFile - sciezka do pliku spakowanego gzipem

targetFile - scierzka do pliku po rozpakowaniu

Throws:

java.io.FileNotFoundException

java.io.IOException

Since:

jPALIO 7.4.56, module 1.1.2