DerbyManager (JCMS API)

java.lang.Object
- com.jalios.jcms.ChannelListener
- - com.jalios.jcms.db.DerbyManager

All Implemented Interfaces:

JcmsConstants, PluginComponent, JaliosConstants, java.lang.Comparable
```
public class DerbyManager
extends ChannelListener
implements JcmsConstants
```
This class manages the internal Derby server.

Since:

jcms-6.0.0

Author:

Olivier Dedieu

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String REVISION
- Fields inherited from class com.jalios.jcms.ChannelListener
  order
- Fields inherited from interface com.jalios.jcms.JcmsConstants
  ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
- Fields inherited from interface com.jalios.util.JaliosConstants
  CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`REVISION`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`backupDatabase(java.lang.String backupdirectory)` Backups the database.
`boolean`	`checkServerConnection()` Returns true if the connections with Derby can be established.
`void`	`freezeDatabase()` Freezes the database.
`java.io.File`	`getBackupDir()` Returns the backup directory.
`java.lang.String`	`getBackupSchedule()` Returns the backup schedule (JDring/cron syntax).
`java.lang.String`	`getDerbyPath()`
`static DerbyManager`	`getInstance()`
`java.lang.String`	`getJdbcUrl()` Returns the JDBC URL to access the internal Derby Server.
`java.lang.String`	`getRuntimeInfo()` Returns runtime information about the running Derby Server.
`int`	`getServerPort()` Returns the port of the Derby server.
`java.lang.String`	`getSysInfo()` Returns information about the running Derby Server.
`void`	`handleFinalize()` Called when the channel is finalized
`void`	`initAfterStoreLoad()` Called just after the store has been loaded and the channel has been initialized.
`void`	`initBeforeStoreLoad()` Called just before the store has been loaded.
`boolean`	`isBackupEnabled()` Returns true if the backup is enabled.
`boolean`	`isServerStarted()` Returns true if internal Derby server has been started.
`void`	`performBackup()` Performs a backup of the database and save the backup as a zip file in the backup directory.
`void`	`shutdown()` Shutdown the internal Derby server
`void`	`unfreezeDatabase()` Unfreezes the database.

Methods inherited from class com.jalios.jcms.ChannelListener
compareTo, equals, init

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static DerbyManager getInstance()
```
  - checkServerConnection
```
public boolean checkServerConnection()
```
    Returns true if the connections with Derby can be established.
    
    Returns:
    
    true if the connections with Derby can be established.
    
    Since:
    
    jcms-7.0.0
  - getDerbyPath
```
public java.lang.String getDerbyPath()
```
  - getJdbcUrl
```
public java.lang.String getJdbcUrl()
```
    Returns the JDBC URL to access the internal Derby Server.
    
    Returns:
    
    the JDBC URL to access the internal Derby Server.
    
    Since:
    
    jcms-6.0.0
  - isServerStarted
```
public boolean isServerStarted()
```
    Returns true if internal Derby server has been started.
    
    Returns:
    
    true if internal Derby server has been started.
    
    Since:
    
    jcms-6.0.0
  - getServerPort
```
public int getServerPort()
```
    Returns the port of the Derby server.
    
    Returns:
    
    the port of the Derby server.
    
    Since:
    
    jcms-6.0.0
  - isBackupEnabled
```
public boolean isBackupEnabled()
```
    Returns true if the backup is enabled.
    
    Returns:
    
    true if the backup is enabled.
    
    Since:
    
    jcms-6.0.0
  - getBackupSchedule
```
public java.lang.String getBackupSchedule()
```
    Returns the backup schedule (JDring/cron syntax).
    
    Returns:
    
    the backup schedule.
    
    Since:
    
    jcms-6.0.0
  - getBackupDir
```
public java.io.File getBackupDir()
```
    Returns the backup directory.
    
    Returns:
    
    the backup directory.
    
    Since:
    
    jcms-6.0.0
  - getSysInfo
```
public java.lang.String getSysInfo()
```
    Returns information about the running Derby Server.
    
    Returns:
    
    information about the running Derby Server.
    
    Since:
    
    jcms-6.0.0
  - getRuntimeInfo
```
public java.lang.String getRuntimeInfo()
```
    Returns runtime information about the running Derby Server.
    
    Returns:
    
    runtime information about the running Derby Server.
    
    Since:
    
    jcms-6.0.0
  - freezeDatabase
```
public void freezeDatabase()
```
    Freezes the database.
    
    Since:
    
    jcms-6.0.0
  - unfreezeDatabase
```
public void unfreezeDatabase()
```
    Unfreezes the database.
    
    Since:
    
    jcms-6.0.0
  - backupDatabase
```
public void backupDatabase(java.lang.String backupdirectory)
```
    Backups the database.
    
    Parameters:
    
    backupdirectory - the path of the backup directory
    
    Since:
    
    jcms-6.0.0
  - shutdown
```
public void shutdown()
```
    Shutdown the internal Derby server
    
    Since:
    
    jcms-6.0.0
  - performBackup
```
public void performBackup()
```
    Performs a backup of the database and save the backup as a zip file in the backup directory.
    
    Since:
    
    jcms-6.0.0
  - handleFinalize
```
public void handleFinalize()
```
    Description copied from class: ChannelListener
    
    Called when the channel is finalized
    
    Specified by:
    
    handleFinalize in class ChannelListener
  - initAfterStoreLoad
```
public void initAfterStoreLoad()
                        throws java.lang.Exception
```
    Description copied from class: ChannelListener
    
    Called just after the store has been loaded and the channel has been initialized. If for any reason you want to interrupt JCMS startup, you can throw an exception. The exception's message will be displayed in JCMS status page (to any user!).
    
    Specified by:
    
    initAfterStoreLoad in class ChannelListener
    
    Throws:
    
    java.lang.Exception - any exception you may want to throw if a problem occurs needing to interrupt JCMS startup.
  - initBeforeStoreLoad
```
public void initBeforeStoreLoad()
                         throws java.lang.Exception
```
    Description copied from class: ChannelListener
    
    Called just before the store has been loaded. If for any reason you want to interrupt JCMS startup, you can throw an exception. The exception's message will be displayed in JCMS status page (to any user!).
    
    Specified by:
    
    initBeforeStoreLoad in class ChannelListener
    
    Throws:
    
    java.lang.Exception - any exception you may want to throw if a problem occurs needing to interrupt JCMS startup.

Class DerbyManager

Field Summary

Fields inherited from class com.jalios.jcms.ChannelListener

Fields inherited from interface com.jalios.jcms.JcmsConstants

Fields inherited from interface com.jalios.util.JaliosConstants

Method Summary

Methods inherited from class com.jalios.jcms.ChannelListener

Methods inherited from class java.lang.Object

Field Detail

REVISION

Method Detail

getInstance

checkServerConnection

getDerbyPath

getJdbcUrl

isServerStarted

getServerPort

isBackupEnabled

getBackupSchedule

getBackupDir

getSysInfo

getRuntimeInfo

freezeDatabase

unfreezeDatabase

backupDatabase

shutdown

performBackup

handleFinalize

initAfterStoreLoad

initBeforeStoreLoad