Author: areshetnyak
Date: 2011-01-13 10:25:57 -0500 (Thu, 13 Jan 2011)
New Revision: 3807
Added:
jcr/branches/1.12.x/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-clonsole-dist.xml
Log:
JCR-1574 : The problem with thread safe in IncrementalBackupJob was fixed.
Added:
jcr/branches/1.12.x/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-clonsole-dist.xml
===================================================================
---
jcr/branches/1.12.x/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-clonsole-dist.xml
(rev 0)
+++
jcr/branches/1.12.x/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-clonsole-dist.xml 2011-01-13
15:25:57 UTC (rev 3807)
@@ -0,0 +1,163 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<chapter id="JCR.BackupClient">
+ <?dbhtml filename="ch-backup-clonsole.dist.html"?>
+
+ <title>Backup console binary distribution </title>
+
+ <section>
+ <title>Introduction</title>
+
+ <para>The backup console binary distribution is script-based front-end to
+ backup client to creation backup, restore, getting status of current or
+ completed backup/restore, etc. </para>
+
+ <para>The backup console binary distribution conatins original backup
+ console and script adaptation for use with GateIn based products like
+ Platform.</para>
+ </section>
+
+ <section>
+ <title>jcrbackup.cmd and jcrbackup.sh</title>
+
+ <para>These scripts suitable for Standalone and flexible for various
+ authentication ways shell scripts.</para>
+
+ <para>Command signature:</para>
+
+ <programlisting> <url_basic_authentication> |
<url_form_authentication> <command>
+
+ <url_basic_authentication>:
http(s)//login:password@host:port/<context>
+ <url_form_authentication> :
http(s)//host:port/<context> <form_auth_parm>
+
+ <form_auth_part> : form <method>
<form_path>
+ <method> : POST or GET
+ <form_path> :
/path/path?<paramName1>=<paramValue1>&<paramName2>=<paramValue2>...
+
+ Example of <url_form_authentication> -
http://127.0.0.1:8080/portal/rest form POST
"/portal/login?initialURI=/portal/private&username=root&password=gtn"
+
+ <command> : start <repo[/ws]>
<backup_dir> [<incr>]
+ stop <backup_id>
+ status <backup_id>
+ restores <repo[/ws]>
+ restore [remove-exists]
[<repo[/ws]>] {<backup_id>|<backup_set_path>}
[<pathToConfigFile>]
+ list [completed]
+ info
+ drop [force-close-session]
<repo[/ws]>
+ help
+
+ start : start backup of repository or workspace
+ stop : stop backup
+ status : information about the current or completed backup
by 'backup_id'
+ restores : information about the last restore on specific
repository or workspace
+ restore : restore the repository or workspace from specific
backup
+ list : information about the current backups (in
progress)
+ list completed : information about the completed (ready to
restore) backups
+ info : information about the service backup
+ drop : delete the repository or workspace
+ help : print help information about backup console
+
+ <repo[/ws]> :
/<repository-name>[/<workspace-name>] the repository or
workspace
+ <backup_dir> : path to folder for backup on remote
server
+ <backup_id> : the identifier for backup
+ <incr> : incremental job period
+ <pathToConfigFile> : path (local) to repository or
workspace configuration
+ remove-exists : remove fully (db, value storage, index) exists
repository/workspace
+ force-close-session : close opened sessions on repository or
workspace</programlisting>
+ </section>
+
+ <section>
+ <title>exobackup.sh and exobackup.cmd</title>
+
+ <para>These scripts suitable for use with GateIn based products like
+ Platform</para>
+
+ <para>Command signature:</para>
+
+ <programlisting> -u <user> -p <password>
[form_of_authentication] <host:port> <command>
+
+ <form_of_authentication> : -b - is used for basic
authentication
+ -f [-c <context>] - is used for
form authentication with context portal if parameter context not specified
+ if no authentication set basic authentication is
used
+ -c <context> : context, by default context is
portal
+
+ <command> : start <repo[/ws]>
<backup_dir> [<incr>]
+ stop <backup_id>
+ status <backup_id>
+ restores <repo[/ws]>
+ restore [remove-exists]
[<repo[/ws]>] {<backup_id>|<backup_set_path>}
[<pathToConfigFile>]
+ list [completed]
+ info
+ drop [force-close-session]
<repo[/ws]>
+ help
+
+ start : start backup of repository or workspace
+ stop : stop backup
+ status : information about the current or completed backup
by 'backup_id'
+ restores : information about the last restore on specific
repository or workspace
+ restore : restore the repository or workspace from specific
backup
+ list : information about the current backups (in
progress)
+ list completed : information about the completed (ready to
restore) backups
+ info : information about the service backup
+ drop : delete the repository or workspace
+ help : print help information about backup console
+
+ <repo[/ws]> :
/<repository-name>[/<workspace-name>] the repository or
workspace
+ <backup_dir> : path to folder for backup on remote
server
+ <backup_id> : the identifier for backup
+ <incr> : incremental job period
+ <pathToConfigFile> : path (local) to repository or
workspace configuration
+ remove-exists : remove fully (db, value storage, index) exists
repository/workspace
+ force-close-session : close opened sessions on repository or
workspace</programlisting>
+ </section>
+
+ <section>
+ <title>Backup console binary distribution usage</title>
+
+ <section>
+ <title>Building application</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Go to folder <emphasis
+
role="bold">${JCR-SRC-HOME}/applications/exo.jcr.applications.backupconsole.dist</emphasis>
+ . - build the application :<programlisting>mvn clean
install</programlisting></para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Getting information about backup service</title>
+
+ <para>The context is "portal" by default for FORM
authentiaction.</para>
+
+ <programlisting>./exobackup.sh -u root -p gtn -f 192.168.0.15:8080
info</programlisting>
+
+ <para>Return :</para>
+
+ <programlisting>The backup service information :
+ full backup type :
org.exoplatform.services.jcr.ext.backup.impl.fs.FullBackupJob
+ incremetal backup type :
org.exoplatform.services.jcr.ext.backup.impl.fs.IncrementalBackupJob
+ backup log folder :
/home/rainf0x/java/exo-working/JCR-839/new_JCR/exo-tomcat/bin/../temp/backup
+ default incremental job period : 3600</programlisting>
+ </section>
+
+ <section>
+ <title>Getting information about backup service with use not default
+ context</title>
+
+ <para>The context is "exodms-demo".</para>
+
+ <programlisting>./exobackup.sh -u root -p gtn -f -c exodms-demo
192.168.0.15:8080 info</programlisting>
+
+ <para>Return :</para>
+
+ <programlisting>The backup service information :
+ full backup type :
org.exoplatform.services.jcr.ext.backup.impl.fs.FullBackupJob
+ incremetal backup type :
org.exoplatform.services.jcr.ext.backup.impl.fs.IncrementalBackupJob
+ backup log folder :
/home/rainf0x/java/exo-working/JCR-839/new_JCR/exo-tomcat/bin/../temp/backup
+ default incremental job period : 3600</programlisting>
+ </section>
+ </section>
+</chapter>