From do-not-reply at jboss.org Thu Jan 13 10:25:58 2011 Content-Type: multipart/mixed; boundary="===============4239506399831347281==" MIME-Version: 1.0 From: do-not-reply at jboss.org To: exo-jcr-commits at lists.jboss.org Subject: [exo-jcr-commits] exo-jcr SVN: r3807 - jcr/branches/1.12.x/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup. Date: Thu, 13 Jan 2011 10:25:58 -0500 Message-ID: <201101131525.p0DFPww1013772@svn01.web.mwc.hst.phx2.redhat.com> --===============4239506399831347281== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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/docb= ook/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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- jcr/branches/1.12.x/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/doc= book/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/doc= book/en-US/modules/jcr/backup/backup-clonsole-dist.xml 2011-01-13 15:25:57 = UTC (rev 3807) @@ -0,0 +1,163 @@ + + + + + + Backup console binary distribution + +
+ Introduction + + 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. + + The backup console binary distribution conatins original backup + console and script adaptation for use with GateIn based products like + Platform. +
+ +
+ jcrbackup.cmd and jcrbackup.sh + + These scripts suitable for Standalone and flexible for various + authentication ways shell scripts. + + Command signature: + + <url_basic_authentication> | <url_= form_authentication> <command> = + + <url_basic_authentication>: http(s)//login:password(a)ho= st:port/<context> = + <url_form_authentication> : http(s)//host:port/<conte= xt> <form_auth_parm> = + + <form_auth_part> : form <method> <form= _path> + <method> : POST or GET + <form_path> : /path/path?<paramName1>= ;=3D<paramValue1>&<paramName2>=3D<paramValue2>... + + Example of <url_form_authentication> - http://127.0.0.1:8= 080/portal/rest form POST "/portal/login?initialURI=3D/portal/private&u= sername=3Droot&password=3Dgtn" + + <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] <rep= o[/ws]> + help + + start : start backup of repository or work= space + stop : stop backup + status : information about the current or c= ompleted backup by 'backup_id' + restores : information about the last restore= on specific repository or workspace + restore : restore the repository or workspac= e from specific backup + list : information about the current back= ups (in progress) + list completed : information about the completed (r= eady to restore) backups + info : information about the service back= up + drop : delete the repository or workspace + help : print help information about backu= p console + + <repo[/ws]> : /<repository-name>[/&l= t;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, i= ndex) exists repository/workspace + force-close-session : close opened sessions on repositor= y or workspace +
+ +
+ exobackup.sh and exobackup.cmd + + These scripts suitable for use with GateIn based products like + Platform + + Command signature: + + -u <user> -p <password> [form_o= f_authentication] <host:port> <command> + + <form_of_authentication> : -b - is used for basic authe= ntication + -f [-c <context>] - is used = for form authentication with context portal if parameter context not specif= ied = + if no authentication set basic aut= hentication 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] <rep= o[/ws]> + help + + start : start backup of repository or work= space + stop : stop backup + status : information about the current or c= ompleted backup by 'backup_id' + restores : information about the last restore= on specific repository or workspace + restore : restore the repository or workspac= e from specific backup + list : information about the current back= ups (in progress) + list completed : information about the completed (r= eady to restore) backups + info : information about the service back= up + drop : delete the repository or workspace + help : print help information about backu= p console + + <repo[/ws]> : /<repository-name>[/&l= t;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, i= ndex) exists repository/workspace + force-close-session : close opened sessions on repositor= y or workspace +
+ +
+ Backup console binary distribution usage + +
+ Building application + + + + Go to folder ${JCR-SRC-HOME}/applications/exo.jcr.applications.= backupconsole.dist + . - build the application :mvn clean install + + +
+ +
+ Getting information about backup service + + The context is "portal" by default for FORM authentiaction. + + ./exobackup.sh -u root -p gtn -f 192.168.0.15:8080 i= nfo + + Return : + + 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 +
+ +
+ Getting information about backup service with use not default + context + + The context is "exodms-demo". + + ./exobackup.sh -u root -p gtn -f -c exodms-demo 192.= 168.0.15:8080 info + + Return : + + 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 +
+
+ --===============4239506399831347281==--