palio.modules
Class Admin

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

public class Admin
extends palio.modules.core.Module

Moduł udostępnia funkcje do zarządzania instancją, oraz funkcje informacyjne.

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

Version:
1.8.0
Author:
Krzysztof Synowiec (ksynowiec@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
Admin(palio.Instance instance, java.util.Properties parameters)
           
 
Method Summary
 void addConnector(java.lang.String connectorName, java.lang.String url, java.util.Map properties, java.lang.Boolean save)
          Add connector to instance
 void addConnector(java.lang.String driverClass, java.lang.String connectorName, java.lang.String url, java.util.Map properties, java.lang.Boolean save)
          Add connector to instance
 void addConnector(java.lang.String driverClass, java.lang.String connectorName, java.lang.String url, java.util.Properties properties, java.lang.Boolean save)
          Add connector to instance
 void addInstanceError(java.lang.String Error)
           
 void addInstanceError(java.lang.String Error, java.lang.Throwable exception)
           
 void addInstanceInfo(java.lang.String info)
           
 void addInstanceWarning(java.lang.String Warning)
           
 void addPrivToPage(java.lang.Long privID, java.lang.Long pageID)
          Dodaje przywilej do strony.
 void addServerError(java.lang.String Error)
           
 void addServerError(java.lang.String Error, java.lang.Throwable exception)
           
 void addServerInfo(java.lang.String info)
           
 void addServerWarning(java.lang.String Warning)
           
 void cacheClear(java.lang.String cacheType, java.lang.Long ID)
          Czyści zawartość cache w instancji.
 void connectorClose(java.lang.String connector)
          Zamyka wszystkie połączenia danego connectora
 java.lang.Long countSessions()
          Zwraca liczbę aktualnie zalogowanych sesji
 java.lang.Long countUsers()
           
 void delPrivFromPage(java.lang.Long privID, java.lang.Long pageID)
          Usuwa przywilej ze strony.
 java.lang.String geFirstTreeType()
           
 java.lang.Long getCachedSessions()
           
 java.lang.Long getCachedUsers()
           
 java.util.LinkedList<java.lang.Long> getChildrenTreeType(java.lang.Long ID)
           
 java.util.LinkedList<java.lang.String> getChildrenTreeType(java.lang.String code)
           
 java.lang.Long getCurrentClients()
           
 java.lang.String getDatabaseVersion()
           
 java.lang.Long getFirstTreeTypeID()
           
static java.lang.String getModulesImplementationVersion()
           
 java.util.List<java.lang.Object[]> getModulesInfo()
           
static java.lang.String getModulesSpecificationVersion()
           
 java.util.Date getObjectCreatedDate()
          Zwraca datę utworzenia aktualnie wykonywanego obiektu
 java.util.Date getObjectCreatedDate(java.lang.Long ID)
          Zwraca datę utworzenia obiektu
 java.util.Date getObjectCreatedDate(java.lang.String code)
          Zwraca datę utworzenia obiektu
 java.util.Date getObjectLastUpdated()
          Zwraca datę ostatniej modyfikacji aktualnie wykonywanego obiektu
 java.util.Date getObjectLastUpdated(java.lang.Long ID)
          Zwraca datę ostatniej modyfikacji obiektu
 java.util.Date getObjectLastUpdated(java.lang.String code)
          Zwraca datę ostatniej modyfikacji obiektu
 java.util.Date getPageCreatedDate()
          Zwraca datę utworzenia aktualnie wykonywanej strony
 java.util.Date getPageCreatedDate(java.lang.Long ID)
          Zwraca datę utworzenia strony
 java.util.Date getPageCreatedDate(java.lang.String code)
          Zwraca datę utworzenia strony
 java.util.Date getPageLastUpdated()
          Zwraca datę ostatniej modyfikacji aktualnie wykonywanej strony
 java.util.Date getPageLastUpdated(java.lang.Long ID)
          Zwraca datę ostatniej modyfikacji strony
 java.util.Date getPageLastUpdated(java.lang.String code)
          Zwraca datę ostatniej modyfikacji strony
 java.util.Date getPageLastVisited()
          Zwraca datę ostatnich odwiedzin aktualnie wykonywanej strony
 java.util.Date getPageLastVisited(java.lang.Long ID)
          Zwraca datę ostatnich odwiedzin strony
 java.util.Date getPageLastVisited(java.lang.String code)
          Zwraca datę ostatnich odwiedzin strony
 java.lang.Long getPageLastVisitedCount(java.lang.String code)
          Zwraca liczbę odwiedzin strony
 java.util.Date getPageStartedDate()
          Zwraca datę wywloania strony.
 java.lang.Long getPageVisitedCount()
          Zwraca liczbę odwiedzin aktualnie wykonywanej strony
 java.lang.Long getPageVisitedCount(java.lang.Long ID)
          Zwraca liczbę odwiedzin strony
static java.lang.String getPalioImplementationVersion()
           
static java.lang.String getPalioSpecificationVersion()
           
 java.lang.String getParentTreeType()
           
 java.lang.Long getParentTreeTypeID()
           
 java.util.LinkedList<java.lang.String> getRootTreeType()
           
 java.util.LinkedList<java.lang.Long> getRootTreeTypeIDs()
           
static java.lang.String getStackTrace()
          Zwraca StackTrace wykonywanego kodu
 java.util.Date getStartedDate()
          Zwraca datę uruchomienia serwera jPALIO.
 java.lang.String getVersion()
          Zwraca numer wersji modułu.
 java.lang.String getWorkingTreeType()
           
 java.lang.Long getWorkingTreeTypeID()
           
 void installPatch(java.lang.Long dsUserID, java.lang.String dsUserName, byte[] patch, java.lang.Object[] options)
          Wykonuje łatkę podaną w formie binarnej.
 boolean isInstanceRunning(java.lang.String instanceName)
          Returns if instance is running
 void removeConnector(java.lang.String connectorName, java.lang.Boolean delete)
          Remove connector from instance
 void setWorkingTreeType(java.lang.Long ID)
           
 void setWorkingTreeType(java.lang.String code)
           
 void synchronizeCode(java.lang.String connectorFrom, java.lang.String connectorTo, java.lang.Boolean printProgress)
          Synchronizuje kod aplikacyjny.
 
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

Admin

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

getVersion

public java.lang.String getVersion()
Zwraca numer wersji modułu.

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

getStartedDate

public java.util.Date getStartedDate()
Zwraca datę uruchomienia serwera jPALIO.


getPageStartedDate

public java.util.Date getPageStartedDate()
Zwraca datę wywloania strony. Może byc wykorzystywana do do wywietlenia czasu przetwarzania strony na samym jej koncu.

Returns:
data wywolania strony.
Since:
module 1.6.3

getStackTrace

public static java.lang.String getStackTrace()
Zwraca StackTrace wykonywanego kodu

Since:
jPALIO 8.0.10

synchronizeCode

public final void synchronizeCode(java.lang.String connectorFrom,
                                  java.lang.String connectorTo,
                                  java.lang.Boolean printProgress)
                           throws palio.PalioException
Synchronizuje kod aplikacyjny. Funkcja nie musi być umieszczona w bloku transakcyjnym, sama zapewnia transakcyjność synchronizacji.

Throws:
palio.PalioException

cacheClear

public final void cacheClear(java.lang.String cacheType,
                             java.lang.Long ID)
Czyści zawartość cache w instancji.

Parameters:
cacheType - nazwa cache, dostępne są następujące opcje: OBJECT, PAGE, TREE_TYPE, MEDIA, MIME_TYPE, ROLE, PRIV, REGION, ALL
ID - identyfikator elementu w cache, gdy null to oznacza że są czyszczone wszystkie elementy z danego cache, nieużywane dla parametru cacheType z wartością ALL

countSessions

public java.lang.Long countSessions()
Zwraca liczbę aktualnie zalogowanych sesji


countUsers

public java.lang.Long countUsers()

getObjectCreatedDate

public java.util.Date getObjectCreatedDate()
Zwraca datę utworzenia aktualnie wykonywanego obiektu


getObjectCreatedDate

public java.util.Date getObjectCreatedDate(java.lang.Long ID)
                                    throws palio.PalioException
Zwraca datę utworzenia obiektu

Throws:
palio.PalioException

getObjectCreatedDate

public java.util.Date getObjectCreatedDate(java.lang.String code)
                                    throws palio.PalioException
Zwraca datę utworzenia obiektu

Throws:
palio.PalioException

getObjectLastUpdated

public java.util.Date getObjectLastUpdated()
Zwraca datę ostatniej modyfikacji aktualnie wykonywanego obiektu


getObjectLastUpdated

public java.util.Date getObjectLastUpdated(java.lang.Long ID)
                                    throws palio.PalioException
Zwraca datę ostatniej modyfikacji obiektu

Throws:
palio.PalioException

getObjectLastUpdated

public java.util.Date getObjectLastUpdated(java.lang.String code)
                                    throws palio.PalioException
Zwraca datę ostatniej modyfikacji obiektu

Throws:
palio.PalioException

getPageCreatedDate

public java.util.Date getPageCreatedDate()
Zwraca datę utworzenia aktualnie wykonywanej strony


getPageCreatedDate

public java.util.Date getPageCreatedDate(java.lang.Long ID)
                                  throws palio.PalioException
Zwraca datę utworzenia strony

Throws:
palio.PalioException

getPageCreatedDate

public java.util.Date getPageCreatedDate(java.lang.String code)
                                  throws palio.PalioException
Zwraca datę utworzenia strony

Throws:
palio.PalioException

getPageLastUpdated

public java.util.Date getPageLastUpdated()
Zwraca datę ostatniej modyfikacji aktualnie wykonywanej strony


getPageLastUpdated

public java.util.Date getPageLastUpdated(java.lang.Long ID)
                                  throws palio.PalioException
Zwraca datę ostatniej modyfikacji strony

Throws:
palio.PalioException

getPageLastUpdated

public java.util.Date getPageLastUpdated(java.lang.String code)
                                  throws palio.PalioException
Zwraca datę ostatniej modyfikacji strony

Throws:
palio.PalioException

getPageLastVisited

public java.util.Date getPageLastVisited()
Zwraca datę ostatnich odwiedzin aktualnie wykonywanej strony


getPageLastVisited

public java.util.Date getPageLastVisited(java.lang.Long ID)
                                  throws palio.PalioException
Zwraca datę ostatnich odwiedzin strony

Throws:
palio.PalioException

getPageLastVisited

public java.util.Date getPageLastVisited(java.lang.String code)
                                  throws palio.PalioException
Zwraca datę ostatnich odwiedzin strony

Throws:
palio.PalioException

getPageVisitedCount

public java.lang.Long getPageVisitedCount()
Zwraca liczbę odwiedzin aktualnie wykonywanej strony


getPageVisitedCount

public java.lang.Long getPageVisitedCount(java.lang.Long ID)
                                   throws palio.PalioException
Zwraca liczbę odwiedzin strony

Throws:
palio.PalioException

getPageLastVisitedCount

public java.lang.Long getPageLastVisitedCount(java.lang.String code)
                                       throws palio.PalioException
Zwraca liczbę odwiedzin strony

Throws:
palio.PalioException

connectorClose

public final void connectorClose(java.lang.String connector)
Zamyka wszystkie połączenia danego connectora

Parameters:
connector - nazwa connectora

addPrivToPage

public final void addPrivToPage(java.lang.Long privID,
                                java.lang.Long pageID)
                         throws palio.PalioException
Dodaje przywilej do strony. Przywilej ten będzie odpowiadal za dostęp do strony przez danego użytkownika jesli strona będzie w trybie chronionym. Po jego dodaniu użytkownik bez danego przywileju nie dostanie się do strony.

Throws:
palio.PalioException
Since:
module 1.6.3

delPrivFromPage

public final void delPrivFromPage(java.lang.Long privID,
                                  java.lang.Long pageID)
                           throws palio.PalioException
Usuwa przywilej ze strony. Przywilej ten będzie odpowiadal za dostęp do strony przez danego użytkownika jesli strona bedzie w trybie chronionym. Po jego usunięciu użytkownik posiadajacy ten przywilej nie dostanie się do strony.

Throws:
palio.PalioException
Since:
module 1.6.3

getModulesSpecificationVersion

public static java.lang.String getModulesSpecificationVersion()
Returns:
numer wersji specyfikacji modułów jPalio

getModulesImplementationVersion

public static java.lang.String getModulesImplementationVersion()
Returns:
numer wersji implementacji modułów jPalio

getPalioSpecificationVersion

public static java.lang.String getPalioSpecificationVersion()
Returns:
numer wersji specyfikacji jPalio

getPalioImplementationVersion

public static java.lang.String getPalioImplementationVersion()
Returns:
numer wersji implementacji jPalio

installPatch

public void installPatch(java.lang.Long dsUserID,
                         java.lang.String dsUserName,
                         byte[] patch,
                         java.lang.Object[] options)
                  throws java.lang.Throwable
Wykonuje łatkę podaną w formie binarnej. Dodatkowe opcje są identyczne do opcji dostępnych z poziomu jDesignera: - "delete-all", - "ignore-media", - "ignore-privs", - "ignore-roles", - "ignore-tasks", - "ignore-params".

Parameters:
patch - Binarna forma łatki (ZIP)
options - Tablica z dodatkowymi opcjami (niedozwolona jest wartość null - zastosuj pustą tablicę)
Throws:
java.lang.Throwable

setWorkingTreeType

public void setWorkingTreeType(java.lang.String code)

setWorkingTreeType

public void setWorkingTreeType(java.lang.Long ID)

getWorkingTreeType

public java.lang.String getWorkingTreeType()

getWorkingTreeTypeID

public java.lang.Long getWorkingTreeTypeID()

getRootTreeType

public java.util.LinkedList<java.lang.String> getRootTreeType()

getRootTreeTypeIDs

public java.util.LinkedList<java.lang.Long> getRootTreeTypeIDs()

geFirstTreeType

public java.lang.String geFirstTreeType()

getFirstTreeTypeID

public java.lang.Long getFirstTreeTypeID()

getParentTreeType

public java.lang.String getParentTreeType()

getParentTreeTypeID

public java.lang.Long getParentTreeTypeID()

getChildrenTreeType

public java.util.LinkedList<java.lang.String> getChildrenTreeType(java.lang.String code)

getChildrenTreeType

public java.util.LinkedList<java.lang.Long> getChildrenTreeType(java.lang.Long ID)

addInstanceInfo

public void addInstanceInfo(java.lang.String info)

addServerInfo

public void addServerInfo(java.lang.String info)

addInstanceWarning

public void addInstanceWarning(java.lang.String Warning)

addServerWarning

public void addServerWarning(java.lang.String Warning)

addInstanceError

public void addInstanceError(java.lang.String Error)

addServerError

public void addServerError(java.lang.String Error)

addInstanceError

public void addInstanceError(java.lang.String Error,
                             java.lang.Throwable exception)

addServerError

public void addServerError(java.lang.String Error,
                           java.lang.Throwable exception)

getDatabaseVersion

public java.lang.String getDatabaseVersion()

getCachedSessions

public java.lang.Long getCachedSessions()

getCachedUsers

public java.lang.Long getCachedUsers()

getCurrentClients

public java.lang.Long getCurrentClients()

getModulesInfo

public java.util.List<java.lang.Object[]> getModulesInfo()

isInstanceRunning

public boolean isInstanceRunning(java.lang.String instanceName)
Returns if instance is running

Since:
jPALIO 8.0.6

removeConnector

public void removeConnector(java.lang.String connectorName,
                            java.lang.Boolean delete)
                     throws palio.PalioException
Remove connector from instance

Throws:
palio.PalioException
Since:
jPALIO 8.0.9

addConnector

public void addConnector(java.lang.String connectorName,
                         java.lang.String url,
                         java.util.Map properties,
                         java.lang.Boolean save)
                  throws palio.PalioException
Add connector to instance

Throws:
palio.PalioException
Since:
jPALIO 8.0.9

addConnector

public void addConnector(java.lang.String driverClass,
                         java.lang.String connectorName,
                         java.lang.String url,
                         java.util.Map properties,
                         java.lang.Boolean save)
                  throws palio.PalioException,
                         java.lang.ClassNotFoundException
Add connector to instance

Throws:
palio.PalioException
java.lang.ClassNotFoundException
Since:
jPALIO 8.0.9

addConnector

public void addConnector(java.lang.String driverClass,
                         java.lang.String connectorName,
                         java.lang.String url,
                         java.util.Properties properties,
                         java.lang.Boolean save)
                  throws palio.PalioException,
                         java.lang.ClassNotFoundException
Add connector to instance

Throws:
palio.PalioException
java.lang.ClassNotFoundException
Since:
jPALIO 8.0.9