general-cvs@xml.apache.org Archives

Returned mail: see transcript for details

2009-10-14T02:03:19Z

svn commit: r805096 - /xml/site/src/documentation/content/xdocs/site.xml

2009-08-17T19:05:43Z

Author: jeremias
Date: Mon Aug 17 19:05:43 2009
New Revision: 805096

URL: http://svn.apache.org/viewvc?rev=805096&view=rev
Log:
Removed another reference to AxKit (being moved to the Attic).

Modified:
    xml/site/src/documentation/content/xdocs/site.xml

Modified: xml/site/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/xml/site/src/documentation/content/xdocs/site.xml?rev=805096&r1=805095&r2=805096&view=diff
==============================================================================
--- xml/site/src/documentation/content/xdocs/site.xml (original)
+++ xml/site/src/documentation/content/xdocs/site.xml Mon Aug 17 19:05:43 2009
@@ -47,7 +47,6 @@
 
   
     
-    
   
 
   



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r805095 - in /xml/site/targets: communication.html contact.html decisions.html guidelines.html index.html legal.html library.html mail.html management.html mirrors.html mission.html overview.html roles.html source.html svn.html whoweare.html

2009-08-17T19:05:16Z

Author: jeremias
Date: Mon Aug 17 19:05:16 2009
New Revision: 805095

URL: http://svn.apache.org/viewvc?rev=805095&view=rev
Log:
Automatic publish from forrestbot

Modified:
    xml/site/targets/communication.html
    xml/site/targets/contact.html
    xml/site/targets/decisions.html
    xml/site/targets/guidelines.html
    xml/site/targets/index.html
    xml/site/targets/legal.html
    xml/site/targets/library.html
    xml/site/targets/mail.html
    xml/site/targets/management.html
    xml/site/targets/mirrors.html
    xml/site/targets/mission.html
    xml/site/targets/overview.html
    xml/site/targets/roles.html
    xml/site/targets/source.html
    xml/site/targets/svn.html
    xml/site/targets/whoweare.html

Modified: xml/site/targets/communication.html
URL: http://svn.apache.org/viewvc/xml/site/targets/communication.html?rev=805095&r1=805094&r2=805095&view=diff
==============================================================================
--- xml/site/targets/communication.html (original)
+++ xml/site/targets/communication.html Mon Aug 17 19:05:16 2009
@@ -109,9 +109,6 @@
 
 Xindice
 
-
-AxKit
-

Hibernated Projects

Modified: xml/site/targets/contact.html URL: http://svn.apache.org/viewvc/xml/site/targets/contact.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/contact.html (original) +++ xml/site/targets/contact.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/decisions.html URL: http://svn.apache.org/viewvc/xml/site/targets/decisions.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/decisions.html (original) +++ xml/site/targets/decisions.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/guidelines.html URL: http://svn.apache.org/viewvc/xml/site/targets/guidelines.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/guidelines.html (original) +++ xml/site/targets/guidelines.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/index.html URL: http://svn.apache.org/viewvc/xml/site/targets/index.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/index.html (original) +++ xml/site/targets/index.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

@@ -221,10 +218,6 @@

-AxKit - XML-based web publishing, in mod_perl

- -

- Crimson - A Java XML parser derived from the Sun Project X Parser. (in hibernation) Modified: xml/site/targets/legal.html URL: http://svn.apache.org/viewvc/xml/site/targets/legal.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/legal.html (original) +++ xml/site/targets/legal.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/library.html URL: http://svn.apache.org/viewvc/xml/site/targets/library.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/library.html (original) +++ xml/site/targets/library.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/mail.html URL: http://svn.apache.org/viewvc/xml/site/targets/mail.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/mail.html (original) +++ xml/site/targets/mail.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/management.html URL: http://svn.apache.org/viewvc/xml/site/targets/management.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/management.html (original) +++ xml/site/targets/management.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/mirrors.html URL: http://svn.apache.org/viewvc/xml/site/targets/mirrors.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/mirrors.html (original) +++ xml/site/targets/mirrors.html Mon Aug 17 19:05:16 2009 @@ -110,9 +110,6 @@

Xindice

-AxKit -

Hibernated Projects

@@ -284,7 +281,7 @@

-AxKit - KEYS +AxKit (RETIRED) - KEYS

Modified: xml/site/targets/mission.html URL: http://svn.apache.org/viewvc/xml/site/targets/mission.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/mission.html (original) +++ xml/site/targets/mission.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@
Xindice
-
-AxKit -

Hibernated Projects

Modified: xml/site/targets/overview.html URL: http://svn.apache.org/viewvc/xml/site/targets/overview.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/overview.html (original) +++ xml/site/targets/overview.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/roles.html URL: http://svn.apache.org/viewvc/xml/site/targets/roles.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/roles.html (original) +++ xml/site/targets/roles.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/source.html URL: http://svn.apache.org/viewvc/xml/site/targets/source.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/source.html (original) +++ xml/site/targets/source.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/svn.html URL: http://svn.apache.org/viewvc/xml/site/targets/svn.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/svn.html (original) +++ xml/site/targets/svn.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

Modified: xml/site/targets/whoweare.html URL: http://svn.apache.org/viewvc/xml/site/targets/whoweare.html?rev=805095&r1=805094&r2=805095&view=diff ============================================================================== --- xml/site/targets/whoweare.html (original) +++ xml/site/targets/whoweare.html Mon Aug 17 19:05:16 2009 @@ -109,9 +109,6 @@

Xindice

-AxKit -

Hibernated Projects

--------------------------------------------------------------------- To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r805094 - in /xml/site/src/documentation/content/xdocs: index.xml mirrors.html

2009-08-17T19:04:50Z

Author: jeremias
Date: Mon Aug 17 19:04:50 2009
New Revision: 805094

URL: http://svn.apache.org/viewvc?rev=805094&view=rev
Log:
https://issues.apache.org/jira/browse/ATTIC-36:
AxKit is being retired to the Attic.
Submitted by: Greg Reddin 

Modified:
    xml/site/src/documentation/content/xdocs/index.xml
    xml/site/src/documentation/content/xdocs/mirrors.html

Modified: xml/site/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/xml/site/src/documentation/content/xdocs/index.xml?rev=805094&r1=805093&r2=805094&view=diff
==============================================================================
--- xml/site/src/documentation/content/xdocs/index.xml (original)
+++ xml/site/src/documentation/content/xdocs/index.xml Mon Aug 17 19:04:50 2009
@@ -46,8 +46,6 @@
         
         
           
-            AxKit - XML-based
web publishing, in mod_perl 
-          
             Crimson
- A Java XML parser derived from the Sun Project X Parser. (in
               hibernation)
           

Modified: xml/site/src/documentation/content/xdocs/mirrors.html
URL: http://svn.apache.org/viewvc/xml/site/src/documentation/content/xdocs/mirrors.html?rev=805094&r1=805093&r2=805094&view=diff
==============================================================================
--- xml/site/src/documentation/content/xdocs/mirrors.html (original)
+++ xml/site/src/documentation/content/xdocs/mirrors.html Mon Aug 17 19:04:50 2009
@@ -151,7 +151,7 @@
             
 	  	  
 
-	    AxKit - KEYS
+	    AxKit (RETIRED) - KEYS
           
 			
 				Version 1.6.2 - tar.gz



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r739013 - /xml/site/targets/commons/

2009-01-29T21:03:59Z

Author: jeremias
Date: Thu Jan 29 21:03:58 2009
New Revision: 739013

URL: http://svn.apache.org/viewvc?rev=739013&view=rev
Log:
Ignore "dist" directory.

Modified:
    xml/site/targets/commons/   (props changed)

Propchange: xml/site/targets/commons/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Thu Jan 29 21:03:58 2009
@@ -0,0 +1 @@
+dist



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r739011 - /xml/site/targets/graphics/

2009-01-29T21:00:29Z

Author: jeremias
Date: Thu Jan 29 21:00:29 2009
New Revision: 739011

URL: http://svn.apache.org/viewvc?rev=739011&view=rev
Log:
Removed obsolete content from pre-Forrest times.

Removed:
    xml/site/targets/graphics/


---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r739010 - /xml/site/targets/resources/

2009-01-29T20:59:05Z

Author: jeremias
Date: Thu Jan 29 20:59:04 2009
New Revision: 739010

URL: http://svn.apache.org/viewvc?rev=739010&view=rev
Log:
Removed obsolete content from pre-Forrest times.

Removed:
    xml/site/targets/resources/


---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r739007 - in /xml/site/targets: ./ crimson/

2009-01-29T20:50:06Z

Author: jeremias
Date: Thu Jan 29 20:50:06 2009
New Revision: 739007

URL: http://svn.apache.org/viewvc?rev=739007&view=rev
Log:
Adding some ignores.

Modified:
    xml/site/targets/   (props changed)
    xml/site/targets/crimson/   (props changed)

Propchange: xml/site/targets/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Thu Jan 29 20:50:06 2009
@@ -0,0 +1,2 @@
+dist
+mail

Propchange: xml/site/targets/crimson/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Thu Jan 29 20:50:06 2009
@@ -0,0 +1 @@
+dist



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r730565 - /xml/site/targets/xalan/index.html

2009-01-01T16:43:12Z

Author: jeremias
Date: Thu Jan  1 08:43:12 2009
New Revision: 730565

URL: http://svn.apache.org/viewvc?rev=730565&view=rev
Log:
Added file from /www/xml.apache.org/xalan to version control

Added:
    xml/site/targets/xalan/index.html

Added: xml/site/targets/xalan/index.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xalan/index.html?rev=730565&view=auto
==============================================================================
--- xml/site/targets/xalan/index.html (added)
+++ xml/site/targets/xalan/index.html Thu Jan  1 08:43:12 2009
@@ -0,0 +1,14 @@
+Xalan-Java version 1
+
+
+
+
+
+    Xalan-Java 1 is no longer supported.
+


+Please see Xalan-Java 2 instead for the latest
Java XSLT processor.


+Alternately, please see Xalan-C++ if you
want a C version of the XSLT processor for multiple platforms.
+ 
+
+
+
\ No newline at end of file



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r730564 - in /xml/site/targets: xalan-c/ xalan-c/apidocs/ xalan-c/graphics/ xalan-c/images/ xalan-c/resources/ xalan-j/ xalan-j/apidocs/ xalan-j/compat_apidocs/ xalan-j/design/ xalan-j/graphics/ xalan-j/resources/ xalan-j/xsltc/ xalan/ xala...

2009-01-01T16:38:29Z

Author: jeremias
Date: Thu Jan  1 08:38:27 2009
New Revision: 730564

URL: http://svn.apache.org/viewvc?rev=730564&view=rev
Log:
Remove outdated Xalan website content from SVN. Xalan shall move their website to their subdomain.

Removed:
    xml/site/targets/xalan-c/apidocs/
    xml/site/targets/xalan-c/commandline.html
    xml/site/targets/xalan-c/extensions.html
    xml/site/targets/xalan-c/faq.html
    xml/site/targets/xalan-c/getstarted.html
    xml/site/targets/xalan-c/graphics/
    xml/site/targets/xalan-c/images/
    xml/site/targets/xalan-c/index.html
    xml/site/targets/xalan-c/overview.html
    xml/site/targets/xalan-c/readme.html
    xml/site/targets/xalan-c/resources/
    xml/site/targets/xalan-c/samples.html
    xml/site/targets/xalan-c/usagepatterns.html
    xml/site/targets/xalan-j/apidocs/
    xml/site/targets/xalan-j/commandline.html
    xml/site/targets/xalan-j/compat_apidocs/
    xml/site/targets/xalan-j/design/
    xml/site/targets/xalan-j/dtm.html
    xml/site/targets/xalan-j/extensions.html
    xml/site/targets/xalan-j/extensionslib.html
    xml/site/targets/xalan-j/faq.html
    xml/site/targets/xalan-j/getstarted.html
    xml/site/targets/xalan-j/graphics/
    xml/site/targets/xalan-j/index.html
    xml/site/targets/xalan-j/overview.html
    xml/site/targets/xalan-j/readme.html
    xml/site/targets/xalan-j/resources/
    xml/site/targets/xalan-j/samples.html
    xml/site/targets/xalan-j/todo.html
    xml/site/targets/xalan-j/trax.html
    xml/site/targets/xalan-j/usagepatterns.html
    xml/site/targets/xalan-j/whatsnew.html
    xml/site/targets/xalan-j/xsltc/
    xml/site/targets/xalan-j/xsltc_usage.html
    xml/site/targets/xalan/apidocs/
    xml/site/targets/xalan/c-apidocs/
    xml/site/targets/xalan/design/
    xml/site/targets/xalan/graphics/
    xml/site/targets/xalan/index.html
    xml/site/targets/xalan/resources/


---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r730531 - in /xml/site/targets: .htaccess security/

2009-01-01T11:42:26Z

Author: jeremias
Date: Thu Jan  1 03:42:26 2009
New Revision: 730531

URL: http://svn.apache.org/viewvc?rev=730531&view=rev
Log:
XML Security went TLP as Santuario.

Removed:
    xml/site/targets/security/
Modified:
    xml/site/targets/.htaccess

Modified: xml/site/targets/.htaccess
URL: http://svn.apache.org/viewvc/xml/site/targets/.htaccess?rev=730531&r1=730530&r2=730531&view=diff
==============================================================================
--- xml/site/targets/.htaccess (original)
+++ xml/site/targets/.htaccess Thu Jan  1 03:42:26 2009
@@ -17,3 +17,6 @@
 Redirect permanent /dist/xmlrpc/ http://www.apache.org/dyn/closer.cgi/ws/xmlrpc/
 Redirect permanent /xmlrpc/ http://ws.apache.org/xmlrpc/
 RedirectMatch ^/xerces-c/download.html http://xml.apache.org/xerces-c/download.cgi
+
+# Projects previously under the XML project which have gone TLP
+Redirect permanent /security/ http://santuario.apache.org/



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r730529 - in /xml/site/targets: xerces-c/ xerces-j/ xerces-p/ xerces2-j/

2009-01-01T11:36:09Z

Author: jeremias
Date: Thu Jan  1 03:36:08 2009
New Revision: 730529

URL: http://svn.apache.org/viewvc?rev=730529&view=rev
Log:
Xerces sites have migrated to their own subdomain. htaccess is in place for redirects.

Removed:
    xml/site/targets/xerces-c/
    xml/site/targets/xerces-j/
    xml/site/targets/xerces-p/
    xml/site/targets/xerces2-j/


---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r730527 [2/2] - /xml/site/targets/

2009-01-01T11:20:56Z

Modified: xml/site/targets/roles.html
URL: http://svn.apache.org/viewvc/xml/site/targets/roles.html?rev=730527&r1=730526&r2=730527&view=diff
==============================================================================
--- xml/site/targets/roles.html (original)
+++ xml/site/targets/roles.html Thu Jan  1 03:20:54 2009
@@ -80,7 +80,7 @@
     |breadtrail
     +-->
 
-The Apache Software Foundation >
The Apache XML Project
+The Apache Software Foundation >
XML at the ASF
 
 
-
+
+
+

Modified: xml/site/targets/source.html URL: http://svn.apache.org/viewvc/xml/site/targets/source.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/source.html (original) +++ xml/site/targets/source.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/svn.html URL: http://svn.apache.org/viewvc/xml/site/targets/svn.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/svn.html (original) +++ xml/site/targets/svn.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/whoweare.html URL: http://svn.apache.org/viewvc/xml/site/targets/whoweare.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/whoweare.html (original) +++ xml/site/targets/whoweare.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

--------------------------------------------------------------------- To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r730527 [1/2] - /xml/site/targets/

2009-01-01T11:20:56Z

Author: jeremias
Date: Thu Jan  1 03:20:54 2009
New Revision: 730527

URL: http://svn.apache.org/viewvc?rev=730527&view=rev
Log:
Automatic publish from forrestbot

Modified:
    xml/site/targets/communication.html
    xml/site/targets/contact.html
    xml/site/targets/decisions.html
    xml/site/targets/guidelines.html
    xml/site/targets/index.html
    xml/site/targets/legal.html
    xml/site/targets/library.html
    xml/site/targets/mail.html
    xml/site/targets/management.html
    xml/site/targets/mirrors.html
    xml/site/targets/mission.html
    xml/site/targets/overview.html
    xml/site/targets/roles.html
    xml/site/targets/source.html
    xml/site/targets/svn.html
    xml/site/targets/whoweare.html

Modified: xml/site/targets/communication.html
URL: http://svn.apache.org/viewvc/xml/site/targets/communication.html?rev=730527&r1=730526&r2=730527&view=diff
==============================================================================
--- xml/site/targets/communication.html (original)
+++ xml/site/targets/communication.html Thu Jan  1 03:20:54 2009
@@ -80,7 +80,7 @@
     |breadtrail
     +-->
 
-The Apache Software Foundation > The Apache XML Project
+The Apache Software Foundation > XML at the ASF
 
 
-
+
+
+

Modified: xml/site/targets/contact.html URL: http://svn.apache.org/viewvc/xml/site/targets/contact.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/contact.html (original) +++ xml/site/targets/contact.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/decisions.html URL: http://svn.apache.org/viewvc/xml/site/targets/decisions.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/decisions.html (original) +++ xml/site/targets/decisions.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/guidelines.html URL: http://svn.apache.org/viewvc/xml/site/targets/guidelines.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/guidelines.html (original) +++ xml/site/targets/guidelines.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

About

Welcome

-News -

-Mission -

Guidelines

+XML-related products

ASF Sponsorship Program @@ -110,56 +104,17 @@ ASF Thanks

XML Federation

Local Projects

-Axis -

-Batik -

-Cocoon -

-Forrest -

-FOP -

-Santuario -

-SOAP -

-Xalan -

-Xerces -

-XMLBeans -

-XML-RPC -

Local Projects

-XML Commons -

Xindice

AxKit

Hibernated Projects

Xerces Java 1

@@ -170,17 +125,8 @@ Crimson

Community

-Who We Are -

-Credits -

Resources

Downloads

@@ -194,8 +140,8 @@ Gump

Information

Get Involved

@@ -221,7 +167,9 @@ -

+ +

Modified: xml/site/targets/index.html URL: http://svn.apache.org/viewvc/xml/site/targets/index.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/index.html (original) +++ xml/site/targets/index.html Thu Jan 1 03:20:54 2009 @@ -5,7 +5,7 @@ -xml.apache.org +XML at The Apache Foundation @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

xml.apache.org

XML at The Apache Foundation

-Welcome to the Apache XML Project -

XML at The Apache Foundation

-Anyone Can Participate +Remaining local projects +

- - - -

Welcome to the Apache XML Project

+ + +

XML at The Apache Foundation

- The goals of the Apache XML Project (part of - The Apache Software Foundation) - are: -

- to provide commercial-quality standards-based XML solutions that are - developed in an open and cooperative fashion, -
- to provide feedback to standards bodies (such as IETF and W3C) from an - implementation perspective, and -
- to be a focus for XML-related activities within Apache projects -

+ The Apache XML Project used to be the home for many XML-related + subprojects, many of which have moved to top-level project status recently + or are currently in migration. The Apache XML Project slowly transforms + into an place where you can find pointers to XML-related projects here + in The Apache Foundation Foundation. +

- The Apache XML Project used to be the home for many XML-related - subprojects, many of which have moved to top-level project status - recently or are currently in migration. The Apache XML Project slowly - transforms into an place where you can find pointers to XML-related - projects here in the Apache Software Foundation. The remaining subprojects - directly under the supervision of the XML PMC are: -

+ Until we have a local up-to-date list, please find a + + list of XML-related products within + The Apache Foundation Foundation on the "Projects website" + . +

+ +

Remaining local projects

+ The remaining subprojects directly under the supervision of the XML PMC are: +

- -AxKit - XML-based web publishing, in mod_perl -
- -Crimson - A Java XML parser derived from the Sun Project X Parser. (in hibernation) - + +AxKit - XML-based web publishing, in mod_perl
+ +Crimson - A Java XML parser derived from the Sun Project X Parser. (in + hibernation) +
- -Xang - Rapid development of dynamic server pages, in JavaScript (in hibernation) - + +Xang - Rapid development of dynamic server pages, in JavaScript (in + hibernation) +
+ +Xindice - A native XML database.

Xindice

- -XML Commons - focussed on common code and guidelines for XML projects -
- -XML Security - Java and C++ implementations of the XML signature and - encryption standards -

- - - - -

Anyone Can Participate

- The xml.apache.org Project is composed of developers from all - around the world, both individuals and engineers from major corporations. - All interested developers are welcome to join and participate. Learn more - about how to get involved. -

- - -

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/library.html URL: http://svn.apache.org/viewvc/xml/site/targets/library.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/library.html (original) +++ xml/site/targets/library.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/mail.html URL: http://svn.apache.org/viewvc/xml/site/targets/mail.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/mail.html (original) +++ xml/site/targets/mail.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/management.html URL: http://svn.apache.org/viewvc/xml/site/targets/management.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/management.html (original) +++ xml/site/targets/management.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/mirrors.html URL: http://svn.apache.org/viewvc/xml/site/targets/mirrors.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/mirrors.html (original) +++ xml/site/targets/mirrors.html Thu Jan 1 03:20:54 2009 @@ -81,7 +81,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

Modified: xml/site/targets/mission.html URL: http://svn.apache.org/viewvc/xml/site/targets/mission.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/mission.html (original) +++ xml/site/targets/mission.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

About

Welcome

-News -

Mission

-Guidelines +XML-related products

ASF Sponsorship Program @@ -110,56 +104,17 @@ ASF Thanks

XML Federation

Local Projects

-Axis -

-Batik -

-Cocoon -

-Forrest -

-FOP -

-Santuario -

-SOAP -

-Xalan -

-Xerces -

-XMLBeans -

-XML-RPC -

Local Projects

-XML Commons -

Xindice

AxKit

Hibernated Projects

Xerces Java 1

@@ -170,17 +125,8 @@ Crimson

Community

-Who We Are -

-Credits -

Resources

Downloads

@@ -194,8 +140,8 @@ Gump

Information

Get Involved

@@ -221,7 +167,9 @@ -

+ +

Modified: xml/site/targets/overview.html URL: http://svn.apache.org/viewvc/xml/site/targets/overview.html?rev=730527&r1=730526&r2=730527&view=diff ============================================================================== --- xml/site/targets/overview.html (original) +++ xml/site/targets/overview.html Thu Jan 1 03:20:54 2009 @@ -80,7 +80,7 @@ |breadtrail +-->

-The Apache Software Foundation > The Apache XML Project +The Apache Software Foundation > XML at the ASF

+ +

--------------------------------------------------------------------- To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r730526 - in /xml/site: ./ src/documentation/content/xdocs/index.xml src/documentation/content/xdocs/site.xml src/documentation/skinconf.xml

2009-01-01T11:18:38Z

Author: jeremias
Date: Thu Jan  1 03:18:37 2009
New Revision: 730526

URL: http://svn.apache.org/viewvc?rev=730526&view=rev
Log:
Updated XML website.
Reduced it to lower maintenance pressure (I hope noone objects).
Added a self-updating ApacheCon ad.

Modified:
    xml/site/   (props changed)
    xml/site/src/documentation/content/xdocs/index.xml
    xml/site/src/documentation/content/xdocs/site.xml
    xml/site/src/documentation/skinconf.xml

Propchange: xml/site/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Thu Jan  1 03:18:37 2009
@@ -7,3 +7,4 @@
 build
 .classpath
 .project
+work

Modified: xml/site/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/xml/site/src/documentation/content/xdocs/index.xml?rev=730526&r1=730525&r2=730526&view=diff
==============================================================================
--- xml/site/src/documentation/content/xdocs/index.xml (original)
+++ xml/site/src/documentation/content/xdocs/index.xml Thu Jan  1 03:18:37 2009
@@ -15,475 +15,51 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-
-xml.apache.org
-
-
-       Welcome to the Apache XML Project
-    
-     The goals of the Apache XML Project (part of 
-     The Apache Software Foundation)
-     are:
-    
-    
-      
-        to provide commercial-quality standards-based XML solutions that are
-        developed in an open and cooperative fashion,
-      
-      
-        to provide feedback to standards bodies (such as IETF and W3C) from an
-        implementation perspective, and
-      
-      
-        to be a focus for XML-related activities within Apache projects
-      
-    
-    
-      The Apache XML Project used to be the home for many XML-related

-      subprojects, many of which have moved to top-level project status 
-      recently or are currently in migration. The Apache XML Project slowly 
-      transforms into an place where you can find pointers to XML-related 
-      projects here in the Apache Software Foundation. The remaining subprojects
-      directly under the supervision of the XML PMC are:
-    
-    
-      
-        AxKit - XML-based web publishing, in mod_perl
-      
-      
-        Crimson - A Java XML parser derived from the Sun Project X Parser.
(in hibernation)
-      
-      
-        Xang - Rapid development of dynamic server pages, in JavaScript
(in hibernation)
-      
-      
-        Xindice - A native XML database.
-      
-      
-        XML Commons - focussed on common code and guidelines for XML
projects
-      
-      
-        XML Security - Java and C++ implementations of the XML signature
and
-        encryption standards
-      
-    
-  
-  
-      
-  
-    Anyone Can Participate
-    
-      The xml.apache.org Project is composed of developers from all
-      around the world, both individuals and engineers from major corporations.
-      All interested developers are welcome to join and participate. Learn more
-      about how to get involved.
-    
-  
-
-  
-
-
+  
+

Modified: xml/site/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/xml/site/src/documentation/content/xdocs/site.xml?rev=730526&r1=730525&r2=730526&view=diff
==============================================================================
--- xml/site/src/documentation/content/xdocs/site.xml (original)
+++ xml/site/src/documentation/content/xdocs/site.xml Thu Jan  1 03:18:37 2009
@@ -19,13 +19,17 @@
 
   
     
+    
+    
     "
     "
   
   
+  
 
   
-    
     
     
   
-
 
   
     
     
     
   
-    
+  
+  
 
   
     

Modified: xml/site/src/documentation/skinconf.xml
URL: http://svn.apache.org/viewvc/xml/site/src/documentation/skinconf.xml?rev=730526&r1=730525&r2=730526&view=diff
==============================================================================
--- xml/site/src/documentation/skinconf.xml (original)
+++ xml/site/src/documentation/skinconf.xml Thu Jan  1 03:18:37 2009
@@ -91,7 +91,7 @@
   favicon.ico
 
   
-  1999-2007
+  1999-2009
   The Apache Software Foundation.
   
   
     
-    
+    
     
   
 
@@ -259,13 +259,13 @@
       88
       31
     
-    
+    
+      ApacheCon
+      http://www.apache.org/events/current-event.html
+      http://apache.org/events/current-event-125x125.png
+      125
+      125
+    
     



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r712230 - in /xml/site/targets/xindice: changes.html changes.pdf changes.rss dev/todo.html dev/todo.pdf

2008-11-07T19:30:03Z

Author: vgritsenko
Date: Fri Nov  7 11:30:03 2008
New Revision: 712230

URL: http://svn.apache.org/viewvc?rev=712230&view=rev
Log:
update xindice website with latest

Modified:
    xml/site/targets/xindice/changes.html
    xml/site/targets/xindice/changes.pdf
    xml/site/targets/xindice/changes.rss
    xml/site/targets/xindice/dev/todo.html
    xml/site/targets/xindice/dev/todo.pdf

Modified: xml/site/targets/xindice/changes.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/changes.html?rev=712230&r1=712229&r2=712230&view=diff
==============================================================================
--- xml/site/targets/xindice/changes.html (original)
+++ xml/site/targets/xindice/changes.html Fri Nov  7 11:30:03 2008
@@ -204,6 +204,9 @@
 Introduction and explanation of symbols
 
 
+Version 1.2-dev (unreleased)
+
+
 Version 1.2m1 (Dec 1 2007)
 
 
@@ -229,7 +232,35 @@
 Changes are sorted chronologically with the most recent at the top. These symbols
denote the various action types:=add,
=fix, =remove, =update

- + +

Version 1.2-dev (unreleased)

+ + Update jetty to version 6.1.11. + Committed by VG.
+ + Update lucene-core library to version 2.4.0. + Committed by NS.
+ + Update lucene-core library to version 2.3.2. + Committed by NS.
+ + Fix implicitly declared namespace prefix "xml" in DOM implementation. + Committed by NS.
+ + Change IndexPattern format to allow to specify path to + element/attribute. + Committed by NS.

+ +

Version 1.2m1 (Dec 1 2007)

@@ -270,7 +301,7 @@

- +

Version 1.1 (May 9 2007)

@@ -445,7 +476,7 @@

- +

Version 1.1b4 (April 8 2004)

@@ -571,7 +602,7 @@

- +

Version 1.1b3 (December 30 2003)

@@ -674,7 +705,7 @@

- +

Version 1.1b (November 1 2002)

Xindice (1.2m1) Changeschanges.htmlXindice +Xindice (1.2-dev) Changeschanges.htmlXindice ( - 1.2m1 + 1.2-dev ) Changes en-us @@ -19,6 +19,44 @@ VG : + Update jetty to version 6.1.11. + + updatechanges.html update + by + NS + : + + Update lucene-core library to version 2.4.0. + + updatechanges.html update + by + NS + : + + Update lucene-core library to version 2.3.2. + + fixchanges.html fix + by + NS + : + + Fix implicitly declared namespace prefix "xml" in DOM implementation. + + addchanges.html add + by + NS + : + + Change IndexPattern format to allow to specify path to + element/attribute. + + + + updatechanges.html update + by + VG + : + Update XML-RPC library to the version 3.1. addchanges.html add @@ -848,57 +886,30 @@ VG : - Update XML-RPC library to the version 3.1. - addchanges.html add + Update jetty to version 6.1.11. + updatechanges.html update by NS : - Add full text indexer. It allows to search documents using Lucene - queries. Add lucene-core 2.2.0. - Thanks to Andy Armstrong. updatechanges.html update - by - VG - : - - Update commons-fileupload to version 1.2. Added (required by upload) - commons-io 1.3.2. - removechanges.html remove - by - VG - : - - Remove 'Ugly Browser', replaced by WebAdmin. - update - (bug 42684) - changes.html update - by - VG - (fixes bug 42684) - - : - - Use Java NIO to lock database on startup. - Thanks to Natalia Shilenkova. add - (bug 42478) - changes.html add + Update lucene-core library to version 2.4.0. + updatechanges.html update by - VG - (fixes bug 42478) - + NS : - Add WebAdmin to the Xindice core (from scratchpad). - Thanks to Natalia Shilenkova. updatechanges.html update + Update lucene-core library to version 2.3.2. + fixchanges.html fix by - VG + NS : - Minimum required Java version to build Xindice is now 1.4. - updatechanges.html update + Fix implicitly declared namespace prefix "xml" in DOM implementation. + addchanges.html add by - VG + NS : - Update commons-logging, Xerces, Xalan, xml-apis libraries. + Change IndexPattern format to allow to specify path to + element/attribute.

+
FullText Implement full text indexing and searching.
+ +Packaging Separate singe Xindice library into independent + server and client libraries. +
...

- +

Xindice 1.3 Release Plan

@@ -338,7 +344,7 @@

- +

Documentation

by Vladimir R. Bossicard, Vadim Gritsenko

- version 600166

@@ -60,13 +60,13 @@ +-->

- +

XML Security History

@@ -230,7 +230,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/index.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/index.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/index.html (original) +++ xml/site/targets/security/index.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Welcome to XML Security @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Welcome to XML Security

News

- + +

June 2008

+ Version 1.4.2 of the Java library has been released. This is mainly + a bugfix release but also contains a few new enhancements including + support for XML Canonicalization 1.1. +

+ Please see changelog for more + information. +

May 2007

- Version 1.4.1 of the Java library has been released. This a bugfix release that - contains a major bugfix to the canonicalization engine introduced in the 1.4 release. - It is recommended that 1.4 users upgrade to the new version as signatures containing - non ascii characters created by this library are not according to the standard, and will be only validated by 1.4 library. + Version 1.4.1 of the Java library has been released. This is a bugfix + release that contains a major bugfix to the canonicalization engine + introduced in the 1.4 release. It is recommended that 1.4 users + upgrade to the new version as signatures containing non ascii + characters created by this library are not according to the standard, + and will be only validated by 1.4 library.

- Please see changelog for more information. -

- + Please see changelog for more + information. +

January 2007

- Version 1.3.1 of the C++ library has been released. This release + Version 1.3.1 of the C++ library has been released. This release contains some minor bug fixes and initial updates for Xerces 3.0. It also provides a new automake based build on *NIX. - changelog for more information. -

- + changelog for more information. +

January 2007

- Version 1.4 of the Java library has been released. - The main changes for this version are: -

+ Version 1.4 of the Java library has been released. + The main changes for this version are: +

Implementation of the standard API JSR105

Refer to the - changelog for more information. -

- + changelog for more information. +

September 2006

- Version 1.3 of the C++ library has been released. This release + Version 1.3 of the C++ library has been released. This release features performance improvements and a complete message set for XKMS. - changelog for more information. -

- + changelog for more information. +

October 2005

- Version 1.3 of the Java library has been released. - This version provides : -

+ Version 1.3 of the Java library has been released. + This version provides : +

Better speed & memory utilization.
Bug fixes.

See the - changelog for more information. -

- + changelog for more information. +

July 2005

- Version 1.2.1 of the C++ library has been released. This minor + Version 1.2.1 of the C++ library has been released. This minor release fixes versioning problems in the Windows project files. See the - changelog for more information. -

- + changelog for more information. +

June 2005

- Version 1.2 of the C++ library has been released. - This version includes a number of bug fixes, together with + Version 1.2 of the C++ library has been released. + This version includes a number of bug fixes, together with a beta release of code to process and generate XKMS messages. See the - changelog for more information. -

- + changelog for more information. +

February 2005

- Version 1.2.1 of the Java library has been released. - This is a bugfix version, for more detail information see the - changelog. -

- + Version 1.2.1 of the Java library has been released. + This is a bugfix version, for more detail information see the + changelog. +

December 2004

- Version 1.2 of the Java library has been released. - This version provides : -

+ Version 1.2 of the Java library has been released. + This version provides : +

Better speed & memory utilization.
Easier JCE integration.

- +

April 2004

- Version 1.1 of the Java library has been released. - This version provides : -

+ Version 1.1 of the Java library has been released. + This version provides : +

Beta implementation of XML Encryption
Bug fixes to Signature implementation

- +

March 2004

- Version 1.1 of the C++ library has been released. Supporting - Xerces 2.5, 2.4 and 2.3 together with Xalan 1.6 and 1.7, this - version provides : -

+ Version 1.1 of the C++ library has been released. Supporting + Xerces 2.5, 2.4 and 2.3 together with Xalan 1.6 and 1.7, this + version provides : +

Beta implementation of XML Encryption
Improved support for Windows Crypto API
Bug fixes to Signature implementation

- +

August 2003

Version 1.00 of the C++ library is now released. This is the first @@ -307,29 +321,29 @@ but all mandatory parts of the the DSIG standard are implemented.

- This version supports Xerces 2.2 and 2.3 and Xalan 1.6. -

- + This version supports Xerces 2.2 and 2.3 and Xalan 1.6. +

May 2003

- The Beta 0.20 of the C++ library has now been released. Features: -

+ The Beta 0.20 of the C++ library has now been released. Features: +

Ability to use the Windows Crypto API as a crypto provider
Several minor bug fixes in transforms and UNIX build process

- +

February 2003

- The site has now been re-built using the new xml.apache.org standard, - using Forrest. -

+ The site has now been re-built using the new xml.apache.org standard, + using Forrest. +

- +

The Project

@@ -362,7 +376,10 @@

A Java library, which includes a mature Digital Signature - implementation. Encryption is currently under development.
A C++ library is also now available. Functionality is currently more basic than that provided by the Java library.

- +

@@ -60,13 +60,13 @@ +-->

- +

The Apache Software License, Version 2.0

@@ -389,7 +389,8 @@
 //  -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/linkmap.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/linkmap.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/linkmap.html (original) +++ xml/site/targets/security/linkmap.html Mon Jun 23 11:03:52 2008 @@ -1,11 +1,11 @@ - + - + -Site Linkmap +Site Linkmap Table of Contents @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Site Linkmap

- -

Site Linkmap Table of Contents

+ This is a map of the complete site and its structure. +

-XML Security _________________________ site +XML Security ___________________ site

-About _________________________ about +About ___________________ about

-Index _________________________ index +Index ___________________ index

-Download _________________________ download +Download ___________________ download

-FAQs _________________________ faq +FAQs ___________________ faq

-Who we are _________________________ who +Who we are ___________________ who

-Todo _________________________ todo +Todo ___________________ todo

-Changes _________________________ changes +Changes ___________________ changes

-History _________________________ history +History ___________________ history

-License _________________________ license +License ___________________ license

-Getting Involved _________________________ getting-involved +Getting Involved ___________________ getting-involved

-Contributing _________________________ contrib +Contributing ___________________ contrib

-SVN _________________________ SVN +SVN ___________________ SVN

-Mail lists _________________________ mail-lists +Mail lists ___________________ mail-lists

-Java _________________________ java +Java ___________________ java

-Index _________________________ index +Index ___________________ index

-Installation _________________________ installation +Installation ___________________ installation

-Examples _________________________ examples +Examples ___________________ examples

-FAQs _________________________ faq_j +FAQs ___________________ faq_j

-API Docs _________________________ api +API Docs ___________________ api

-Interoperability _________________________ interop +Interoperability ___________________ interop

-Gump results _________________________ gump +Gump results ___________________ gump

-Resolvermania _________________________ resolvers +Resolvermania ___________________ resolvers

-C++ _________________________ c +C++ ___________________ c

-Index _________________________ index +Index ___________________ index

-Installation _________________________ install +Installation ___________________ install

-FAQs _________________________ cfaq +FAQs ___________________ cfaq

-API Docs _________________________ external +API Docs ___________________ external

-Nightly API build _________________________ external +Nightly API build ___________________ external

-Tools _________________________ tools +Tools ___________________ tools

-Release Information _________________________ releases +Release Information ___________________ releases

-Credits _________________________ credits +Credits ___________________ credits

-Interoperability _________________________ interop +Interoperability ___________________ interop

-Programming _________________________ cprog -

-Signatures _________________________ signature +Programming ___________________ cprog

-Encryption _________________________ enc +Signatures ___________________ signature

-References _________________________ references -

-W3C XML DSig _________________________ xmldsig -
-W3C XML Enc _________________________ xmlenc -
-W3C XML XKMS _________________________ xmlxkms +Encryption ___________________ enc

-The XML Security page _________________________ christ-page +References ___________________ references

-W3C XML-Signature Syntax and Processing _________________________ xmldsig -
-XML-Signature Syntax and Processing, W3C Recommendation 12 February 2002 _________________________ xmldsig_java_supported -
-XML-Signature Syntax and Processing, W3C Recommendation 12 February 2002 _________________________ xmldsig_C_supported -
-XML Encryption Syntax and Processing, W3C Recommendation 10 December 2002 _________________________ xmlenc_java_supported -
-XML Encryption Syntax and Processing, W3C Recommendation 10 December 2002 _________________________ xmlenc_C_supported -
-W3C XML Encryption Syntax and Processing _________________________ xmlenc -
-C14N-supported _________________________ c14n +W3C XML DSig ___________________ xmldsig
-C14N tests _________________________ c14n-interop -
-XMLDSig XPath Filter 2.0 _________________________ xpath-filterv2 -
-XML Path Language (XPath) Version 1.0 _________________________ xpath -
-DOM _________________________ dom -
-DOM level 2 _________________________ dom2 -

-SAX _________________________ sax -
-SAX 2 _________________________ sax2 -

-Apache Xerces2 _________________________ xml4j-used +W3C XML Enc ___________________ xmlenc
-The Apache Software License, Version 1.1 _________________________ ApacheLicense -

-Ant _________________________ ant -
-Bugzilla (the Apache bug database) _________________________ bugzilla -
-XalanJ2 open bugs _________________________ buglist +W3C XML XKMS ___________________ xmlxkms

- - - - -

- -

-Handbook of Applied Cryptography _________________________ hac -
-Boucy Castle _________________________ bouncy -
-Java (TM) 2 Platform Standard Edition v1.4.0 _________________________ java -
-SUN java forum _________________________ javaforum -
-Java API for XML Parsing 1.0 _________________________ jaxp -
-ZVON _________________________ zvon -
-XMLFAQ _________________________ xmlfaq -
-Bean Scripting Framework (BSF) _________________________ bsf -
-EyeBrowseList _________________________ nagoya -
-Gmane _________________________ gmane -
-mailinglisthelp _________________________ mailhelp -
-mailinglistsubscribe _________________________ mailsub -
-mailinglistunsubscribe _________________________ mailunsub -
-Christian Geuer-Pollmann _________________________ geuerp -

- - - - - - -

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/mail-lists.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/mail-lists.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/mail-lists.html (original) +++ xml/site/targets/security/mail-lists.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + XML security mailing list @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

XML security mailing list

@@ -235,7 +235,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/todo.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/todo.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/todo.html (original) +++ xml/site/targets/security/todo.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Todo List @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Todo List

@@ -181,14 +181,10 @@ [C++ code] Implement NSS Crypto interface → MT -

-[Java-code] - Integrate JSR 105 - → SM

- +

medium

@@ -203,7 +199,7 @@

- +

low

@@ -234,7 +230,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/who.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/who.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/who.html (original) +++ xml/site/targets/security/who.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Who we are @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Who we are

@@ -236,7 +236,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. --------------------------------------------------------------------- To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r670690 [3/4] - in /xml/site/targets/security: ./ Java/ c/

2008-06-23T18:03:53Z

Modified: xml/site/targets/security/changes.html
URL: http://svn.apache.org/viewvc/xml/site/targets/security/changes.html?rev=670690&r1=670689&r2=670690&view=diff
==============================================================================
--- xml/site/targets/security/changes.html (original)
+++ xml/site/targets/security/changes.html Mon Jun 23 11:03:52 2008
@@ -1,11 +1,11 @@
-
+
 
 
 
 
-
+
 
-History of Changes
+History of Changes 
 
 
 
@@ -48,7 +48,7 @@
     +-->
 
 
-  
+  
                     
 
 
@@ -60,13 +60,13 @@
     +-->
 
 
-Home
+Home
 
 
-Java
+Java
 
 
-C++
+C++
 
 
 
-
+

- +

History of Changes

+ +

Introduction and explanation of symbols

Changes are sorted by "type" and then chronologically with the most recent at the top. These symbols denote the various action types:=add, =fix, =remove, =update

+ + + +

Version Java 1.4.2 (June 2008)

+ +

java_general

+ + Add support for more XMLDSig algorithms listed in RFC 4051 + Committed by SM. See Issue 44810.
+ + Add support for C14N 1.1 to Java implementation. + Committed by SM. Thanks to Sean Mullan. See Issue 42653.
+ + Library does not allow specify provider for private key operations. + Committed by SM. Thanks to Alon Bar-Lev. See Issue 43056.
+ + Method to disable XMLUtils.addReturnToElement. + Committed by SM. Thanks to Michael McIntosh. See Issue 42061.
+ + Add XMLCipher.encryptData method that takes serialized + data as parameter. + Committed by SM. Thanks to Vladmir Ionescu. See Issue 38668.
+ + DOMException is thrown at XMLSignature creation. + Committed by SM. Thanks to Giedrius Noreikis. See Issue 44999.
+ + Concurrent creation of a XMLSignature instance produces an + ArrayIndexOutOfBoundsException. Thanks to Giedrius Noreikis + Committed by RB. Thanks to Giedrius Noreikis. See Issue 44956.
+ + Concurrent invocation of KeyInfo.getX509Certificate() occasionally fails + Committed by RB. Thanks to Giedrius Noreikis. See Issue 44991.
+ + Switch order of XML Signature validation steps + Committed by SM. See Issue 44629.
+ + Regression when processing XPath transform (additional fix) + Committed by SM. See Issue 44617.
+ + XMLX509IssuerSerial.getIssuerName incorrectly escapes '#' in hex values + Committed by SM. See Issue 44586.
+ + XMLX509Certificate.getX509Certificate() results in certificate parsing + error. + Committed by SM. Thanks to Vishal Mahajan. See Issue 44205.
+ + When using xslt transformation there is problem with xalan newline. + Small refactor for ElementProxy to get rid of the state, it was an old + vestige that where taking space and obfuscating the code. + Committed by RB. Thanks to Matej Spiller. See Issue 44177.
+ + String comparisons using '==' causes validation errors with some parsers + Committed by RB. Thanks to Vishal Mahajan. See Issue 40897.
+ + XMLCipher loadEncryptedKey error. + Committed by SM. Thanks to Butler. See Issue 44102.
+ + No installed provider supports this key when checking a RSA signature + against a DSA key before RSA key. + Committed by SM. Thanks to Matthias Germann. See Issue 43239.
+ + Unnecessary namespace declarations on Signature children. + Committed by SM. Thanks to Brent Putnam. See Issue 43597.
+ + Problem with empty BaseURI in ResolverLocalFilesystem. + Committed by SM. Thanks to Frank Cornelis. See Issue 42865.
+ + Inclusive C14n doesn't always handle xml:space and xml:lang + attributes correctly + Committed by SM. See Issue 42230.
+ + Error when removing encrypted content in 1.4.1. + Committed by SM. Thanks to Julien Taupin, Daniele Gagliardi. See Issue 42866.
+ + ClassLoader issue causing NoSuchAlgorithmException loading + Provider Implementation. + Committed by SM. Thanks to James Washington. See Issue 42820.
+ + Improved logging in signature handling. Thanks to Wally Dennis. + Committed by SM. Thanks to Wally Dennis. See Issue 44863.

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Raul Benito Garcia (RB), Sean Mullan (SM).

This is a list of other contributors:
Alon Bar-Lev, Brent Putnam, Butler, Frank Cornelis, Giedrius Noreikis, James Washington, Julien Taupin, Daniele Gagliardi, Matej Spiller, Matthias Germann, Michael McIntosh, Sean Mullan, Vishal Mahajan, Vladmir Ionescu, Wally Dennis.

+ - + +

Version C++ 1.4.0 (November 2007)

+ +

c_rel

+ + Add const specifiers and methods to various classes + Committed by SC.
+ + Add better extraction of openssl build settings using pkg-config + Committed by SC.
+ + Fix exclusive c14n namespace bug (rev. 526939) + Committed by BL.
+ + Fix XSECnew macro to stop catching arbitrary errors and report + crypto exceptions instead of turning them into allocation errors + Committed by SC.
+ + Add various missing files to dist target + Committed by SC.

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL), Scott Cantor (SC).

+ + +

Version Java 1.4.1 (May 2007)

+ +

java_general

XML Security 1.4.0 does not build with IBM's JDK. - (SM) Thanks to Derek Morr. Fixes 41892.

41892

Cannot canonicalize with XSLT transform. - (SM) Thanks to Lijun Liao. Fixes 41927.

41927

Resolution of SAML 1.x ID attributes, incorrect namespace. - (SM) Thanks to Brent Putman. Fixes 41805.

41805

Two text nodes with the value '\n' in succession within <ds:SignedInfo> and <ds:X509IssuerSerial>. - (SM) Thanks to Lijun Liao. Fixes 41474.

41474

org.apache.xml.security.keys.content.KeyValue.getPublicKey() returns null for DSA key. - (SM) Thanks to Stepan Hrbacek. Fixes 41510.

41510

XMLCipher StackOverflowError. - (SM) Thanks to Marek Jablonski. Fixes 41573.

41573

Cannot specify dynamically a specific JCE Provider with the DSA Signature. - (SM) Thanks to Julien Pasquier. Fixes 41569.

41569

ECDSA signature value interoperability patch. - (RB) Thanks to Wolfgang Glas. Fixes 42239.

42239

Cannot generate signatures with the same key but different algorithms in sucession. - (RB) Thanks to Lijun Liao. Fixes 41520.

41520

Xml canonization - UTF-8 encoding issue in Xml security 1.4.0. - (RB) Thanks to Karol Rewera. Fixes 41462.

41462

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Raul Benito Garcia (RB), Sean Mullan (SM).

This is a list of other contributors:
Brent PutmanDerek Morr, Julien Pasquier, Karol Rewera, Lijun Liao, Marek Jablonski, Stepan Hrbacek, Wolfgang Glas.

+ - +

Version C++ 1.3.1 (January 2007)

+ +

c_rel

Initial support for API changes in Xerces 3.0 - (BL)
- - Refactor NIX build to use automake and libtool - (BL)
Fix bug in autoconf that would prevent proper detection of Xerces ability to set Id attributes - (BL)
Fix bug 40085 - incorrect OIDs on non SHA1 based RSA sigs - (BL)
Remove redundant code in SignedInfo that was preventing the loading of signatures with algorithms not hard coded - (BL)
Fix bug in Envelope transform - (BL)
Fix bug in DSIGXPathFilterExpr with non-initalised vars. Reported by Ralf "Sabo" Saborowski. - (BL)
+ + Refactor NIX build to use automake and libtool + Committed by BL.

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL).

- +

Version Java 1.4 (January 2007)

+ +

java_general

JSR 105 implementation. - (SM)
Add XMLCipher.encryptData method that takes serialized data as parameter - (SM) Fixes 38668.
- - Major optimizations for signatures that use node-set transformations(xpath,xpath2,etc), 20-40% speed-up. - (RB)
- - Major optimizations for signatures that use xpath2 transformation. - (RB)
- - Major optimizations in inclusive c14n when using xml:* attributtes. - (RB)
- - Memory footprint reduction: Less object creation. Reuse of "expensive" objects between - operations in the same thread. - (RB)
- - Minor Optimizations. Reuse the same Signature object if the key are identical. - (RB)

38668

NPE in ResolverDirectHTTP.engineCanResolve. - (SM) Thanks to Frank Cornelis. Fixes 40783.

40783

AxisSigner.java doesn't work out of the box - (RB) Thanks to Jean-Luc Cooke. Fixes 40360.

40360

Impossible to add X509 subelements for signing - (RB) Thanks to Jean-Luc Cooke. Fixes 40404.

40404

Base64 does not work in EBCDIC machines. - (RB) Thanks to ACastro. Fixes 40215.

40215

Subtree canonicalization produce incorrect results in certain cases. - (RB) Thanks to Bob Shanahan . Fixes 40032.

40032

Internal. Cannot sign-verify twice in the same thread with different XMLSignature instances. - (RB) Thanks to Ruchith Fernando. Fixes 40896.

40896

Internal. KeyResolverSpi derived classes require default constructor. - (RB) Thanks to Frank Cornelis. Fixes 40796.

40796

Different behaviour with NodeSet and RootNode with InclusiveNamespaces - (SM) Thanks to Pete Hendry. Fixes 37708.

37708

Signing throws an exception if custom resource resolver is registered - (SM) Thanks to Vishal Mahajan. Fixes 37456.

37456

Canonicalizer gets exception in many namespaces. - (RB) Thanks to katoy. Fixes 38655.

38655

Transform TRANSFORM_XPATH2FILTER subtract filter does not work correctly. - (RB) Thanks to Stefano Del Sal. Fixes 38444.

38444

X509CertificateResolver does not work in multithread environment - (RB) Thanks to Peter Bacik. Fixes 38605.

38605

XMLCipher-loadEncryptedKey() doesn't set the correct CarriedKeyName element. - (RB) Thanks to Yvan Hess. Fixes 39200.

39200

Findbugs reporting fixed. - (SM) Thanks to Sean Mullan. Fixes 39685.

39685

+ + Major optimizations for signatures that use node-set transformations(xpath,xpath2,etc), 20-40% speed-up. + Committed by RB.
+ + Major optimizations for signatures that use xpath2 transformation. + Committed by RB.
+ + Major optimizations in inclusive c14n when using xml:* attributtes. + Committed by RB.
+ + Memory footprint reduction: Less object creation. Reuse of "expensive" objects between + operations in the same thread. + Committed by RB.
+ + Minor Optimizations. Reuse the same Signature object if the key are identical. + Committed by RB.

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Raul Benito Garcia (RB), Sean Mullan (SM).

This is a list of other contributors:
ACastro, Bob Shanahan , Frank Cornelis, Jean-Luc Cooke, katoy, Pete Hendry, Peter Bacik, Ruchith Fernando, Sean Mullan, Stefano Del Sal, Vishal Mahajan, Yvan Hess.

- +

Version C++ 1.3 (September 2006)

+ +

c_rel

Implemented algorithm handlers for the digital signature classes, to provide algorithm extensibility - (BL)
Initial import of beta NSS crypto support - (MT)
Complete implementation of XKMS message set - (BL)
Methods to allow loading of encrypted data without doing decrypt and to process a decrypt/encrypt operation without replacing the original nodes - (BL)
Provide MS VC++ 2005 project files - (BL)
+ + Performance improvements in canonicalisation + Committed by BL.
+ + Fix memory leaks in OpenSSL wrapping code + Committed by BL.
+ + Provide some stability if the Apache keystore is corrupted under + Windows. + Committed by BL.
+ + Fix bug when encrypting small input docs + Committed by BL.
Update signature classes to pass in requested algorithms as URIs rather than enums. Enum based methods are now deprecated. - (BL)
Provide ability for calling application to define whether references are interlocking. - (BL)
Implement checks for broken OpenSSL support under Solaris 10 - (BL)
Add --with-xalan, --with-openssl, --with-xerces and --enable-warnerror flags in configure - (BL)
Configure now detects if Xalan is installed rather than having XALANCROOT being a pointer to the compile directory - (BL)
- - Performance improvements in canonicalisation - (BL)
- - Fix memory leaks in OpenSSL wrapping code - (BL)
- - Provide some stability if the Apache keystore is corrupted under - Windows. - (BL)
- - Fix bug when encrypting small input docs - (BL)

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL), Milan Tomic (MT).

- +

Version Java 1.3 (October 2005)

+ +

java_c14n

- - Add new msg id named decoding.divisible.four and fix bug in Base64 Transform to throw Base64DecodingExc with this msg id instead of "It should be dived by four". - (SM)
- - Removed http://www.nue.et-inf.uni-siegen.de/~geuer-pollmann/#xpathFilter transformation. - (RB)
- - Remove of PRNG, HexDump, X509CertificateValidator classes. - (RB)
- - Out of the box j2se 1.5 ready(no adding xalan in the classpath or endorsed if no - xpath transformation is needed) - (RB)
Performance improvement in C14n, due to changes in internal structure, and a non recursive algorithm. - (RB)
Reduce memory consumption in c14n. - (RB)

+ +

java_general

- - General small optimizations(b64 speed-ups, list instead of vector, etc...). - (RB)
Canonicalizing an empty node-set throws an ArrayIndexOutOfBoundsException. Also added new unit test for generating signatures. - (SM) Fixes 36044.

36044

Fixed NullPointerException bugs in engineCanonicalize. - (SM)
Fix bug when parsing reference lists during decryption; properly handle relative URIs and lists of more than one element. - (SM) Thanks to Clive Brettingham-Moore.
Make XMLCipher.encryptData(Document, Element, boolean) public so it can be used by applications. - (SM)
Error in CarriedKeyNameDefinition EncryptedKeyImpl. - (SM) Thanks to Julien Taupin. Fixes 35917.

35917

Change logging message in XMLCipher.decryptKey from info to debug level (too noisy for info level). - (SM)
Fix file descriptor leak in XMLSignatureInput. - (SM) Thanks to Rune Friis-Jensen. Fixes 35580.

35580

Fix NullPointerException in TransformXPathFilter2.engineTransform if XMLSignatureInput is a node-set (instead of an element subtree). - (SM)
Fix condition in ElementProxy.guaranteeThatElementInCorrectSpace(). - (SM) Thanks to bodiguillaume-dev@yahoo.fr.
Fix NullPointerException in log message emitted by ResolverDirectHTTP.engineCanResolve. - (SM)
Fix NullPointerException bug in ResolverXPointer.engineResolve; check if BaseURI is null before setting source URI. - (SM)
Fix NPE when an unknown transform algorithm is used. - (RB) Thanks to Lee Coomber. Fixes 34743.

34743

Removed system.err.println to a real log. - (RB) Thanks to Raymond Wong. Fixes 33936.

33936

Fix a bug in Xpath and Base64 transform is used together. - (RB) Thanks to Luda. Fixes 35919.

35919

Canonicalization of a DocumentFragment node always throws a c14n exception - (VM) Fixes 36638.

36638

KeyValue.getPublicKey does not work - (VM) Fixes 36639.

36639

Signature verification ignores the inclusive namespaces parameter of a excl c14n ds:CanonicalizationMethod - (VM) Fixes 36640.

36640

+ + Remove of PRNG, HexDump, X509CertificateValidator classes. + Committed by RB.
+ + Out of the box j2se 1.5 ready(no adding xalan in the classpath or endorsed if no + xpath transformation is needed) + Committed by RB.
+ + General small optimizations(b64 speed-ups, list instead of vector, etc...). + Committed by RB.

+ +

java_transformations

+ + Removed http://www.nue.et-inf.uni-siegen.de/~geuer-pollmann/#xpathFilter transformation. + Committed by RB.

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Raul Benito Garcia (RB), Sean Mullan (SM), Vishal Mahajan (VM).

This is a list of other contributors:
bodiguillaume-dev@yahoo.fr, Clive Brettingham-Moore, Julien Taupin, Lee Coomber, Luda, Raymond Wong, Rune Friis-Jensen.

- +

Version C++ 1.2.1 (July 2005)

+ +

c_rel

Add xklient "No Xalan" builds in VC 6.0 project files - (BL)
Fix version suffixes on DLL files in VC 6.0 "No Xalan" build. - (BL)
Add "No Xalan" support into VC 7.0 project files. - (BL)

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL).

- +

Version C++ 1.2.0 (June 2005)

+ +

c_rel

Implemented XKMS Message generation and processing - (BL)
Implemented command line XKMS tool for generating and dumping XKMS messages - (BL)
Add support for SHA224/256/384/512 (requires OpenSSL 0.9.8 Beta) - (BL)
Patch for Mac OS X compile - provided by Scott Cantor - See Bugzilla #34920 - (BL) Fixes 34920.

34920

Added complete KeyInfo handling for XENCEncryptedType - (MT)
- - Remove dynamic_casts and RTTI requirement - (BL)
- - Updates to compile against Xalan 1.9 - (BL)
- - Backport to compile with Xerces 2.1 - (BL)
- - Provided support for nominating namespace based Id attributes - (BL)
Remove MFC dependency and clean up memory debugging - (BL)
Support for DESTDIR as provided by Ville Skytta in Bugzilla 28520 - (BL) Fixes 28520.

28520

Update to Apache licence 2.0. - (MT)
Fix bug with NULL pointer when validating or signing empty reference lists - fix as suggested by Jesse Pelton on 23 March 2005 on security-dev - (BL)
Change to allow apps to calculate and obtain signed info hash - from Eckehard Hermann - see email of 2 March 2005 on security-dev - (BL)
Patch for long RSA keys provided by Michael Braunoeder to security-dev on 16 Nov 2005 - (BL)
Memory leak in OpenSSLCryptoBase64 reported by Jesse Pelton fixed. - (BL)
Move to internal Base64 decoder in a number of methods to handle non-wrapping data - (BL)
Resize buffer in OpenSSLCryptoKeyRSA for larger RSA keys - as submitted by Vadim Ismailov 3 December 2005 - (BL)
Remove redundant m_keyType class variable from OpenSSLCryptoKeyRSA as reported by Jesse Pelton on security-dev - (BL)
Don't throw an exception when an RSA decrypt fails during sig validation - this is a failed validate, not an error - (BL)
Shutdown OpenSSL properly - as suggested by Jesse Pelton in e-mail to security-dev on 9 March 2005 - (BL)
Changed scope of WinCapiCryptoKey::importKey() from private to public. It returns key now, instead of void. - (BL)
Fix problem in Windows CAPI where XSEC doesn't work if user doesn't have admin rights. - (BL)
Bug fix in Windows CAPI code for some W2K machines - reported by Andrzej Matejko 4/5/2004 - (BL)
Fix build on non WINCAPI systems, as reported by Milan Tomic on 22/4/2004 - (MT)
New constructor added to WinCapiX509 - (MT)
Fixed Bug in encode() XSCryptCryptoBase64. - (BL)
Fix bug in XPathFilter transform when checking if an attribute is in the input node set. - (BL)
Fix bug in in UTF transcoder for counting of transcoded characters (count characters not bytes) reported by Milan Tomic - (BL)
Move function definitions in the Windows BinInput stream class to static to avoid conflicts with Xerces. As suggested by Jesse Pelton on 2 Feb 2005 in security-dev - (BL)
Fix to stop re-use of derived key encrypting key when decrypting multiple elements in a document - (BL)
Fix to ignore encryption exceptions during a private key decrypt - (BL)
+ + Remove dynamic_casts and RTTI requirement + Committed by BL.
+ + Updates to compile against Xalan 1.9 + Committed by BL.
+ + Backport to compile with Xerces 2.1 + Committed by BL.
+ + Provided support for nominating namespace based Id attributes + Committed by BL.

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL), Milan Tomic (MT).

- +

Version Java 1.2.1 (February 2005)

+ +

build

- Clean unused jar (xmlParserAPI.jar,etc) and check and stored new versions. - (RB)

+ +

external-libs

- Clean unused build*.xml files. - (RB)
Generated the dist jar with version (i.e. xmlsec-1.2.1.jar instead of plain xmlsec.jar) - (RB)

+ +

java_general

Fix a memory leak when using xpath or using ResourceResolver and not hitting getElementByIdUsingDOM() - (RB) Thanks to Sylvain Dusart. Fixes 32836.

32836

- Fix erroneous creation/verification when using XPath2Filter and inclusive c14n.(RB)
- Library now throws an exception when asked to sign/verify an inexistent fragment.(RB) Thanks to Raymond Wong. Fixes 23554.

23554

- Restore reset behaviour as default when reusing Canonicalizers(but an append one can still be used).(RB)
- Fix a bug when using base64transformation and external resources.(RB) Thanks to Sean Mullan. Fixes 33393.

33393

Fix a bug when passing XMLsignatureInput(InputStream) streams that don't acknowledge reset() as expected. - (RB)
Added i14n Base64 error message. - (RB) Thanks to Sean Mullan. Fixes 32996.

32996

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Raul Benito Garcia (RB).

This is a list of other contributors:
Raymond Wong, Sean Mullan, Sylvain Dusart.

- +

Version Java 1.2 (December 2004)

+ +

java_c14n

Rework the canonicalization for speed-up common cases - (RB)

+ +

java_csp

- General memory footprint improvements - (RB)

+ +

java_general

- General speed optimizations - (RB)
- Update the JCE algorith mechanism - (VM)

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Raul Benito Garcia (RB), Vishal Mahajan (VM).

- +

Version C++ 1.10 (March 2004)

+ +

c_rel

@@ -769,13 +1006,19 @@
Initial implementation of pluggable algorithm handlers

- (BL) + Committed by BL. + +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL).

- +

Version C++ 1.00 (July 2003)

+ +

c_rel

@@ -790,13 +1033,19 @@
Various bug fixes

- (BL) + Committed by BL. + +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL).

- +

Version C++ 0.20 (May 2003)

+ +

c_rel

@@ -809,53 +1058,81 @@
Various bug fixes

- (BL) + Committed by BL. + +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL).

- +

Version Java 1.0.5 (unreleased)

+ +

docs

Ported the docs to Forrest
- (KW)

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Karel Wouters (KW).

- +

Version C++ 0.10 (unreleased)

+ +

c_rel

First release of a Beta for the C++ library.
- (BL)

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Berin Lautenbach (BL).

- +

Version Java 1.0.4 (15 July 2002)

+ +

java_csp

-
Java - People who did not install Xalan properly under JDK 1.4.0 now - get a more specific error message.
- (CGP)

Java - We use the most recent version of the BouncyCastle JCE now.

+ +

java_jdk

-
Java - We use the most recent version of the BouncyCastle JCE now.
- (CGP)

Java - People who did not install Xalan properly under JDK 1.4.0 now + get a more specific error message.

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Christian Geuer-Pollmann (CGP).

- +

Version Java 1.0.3 (unknown)

+ +

java_exc_c14n

@@ -866,7 +1143,11 @@
Canonicalization is written completely new: it's about 5-80 times faster than the implementation in version 1.0.2. It's highly recommended to upgrade to the new version.
- (CGP)

+ +

java_xpath2

Java - Added support for @@ -875,10 +1156,32 @@
- (CGP)

+ +

Contributors to this release

We thank the following people for their contributions to this release.

This is a list of all people who participated as committers:
Christian Geuer-Pollmann (CGP).

+ +

All Committers

This is a list of all people who have ever participated + as committers on this project.

Christian Geuer-Pollmann (CGP)
Berin Lautenbach (BL)
Axl Mattheus (AXL)
Erwin van der Koogh (EK)
Karel Wouters (KW)
Raul Benito Garcia (RB)
Vishal Mahajan (VM)
Milan Tomic (MT)
Sean Mullan (SM)
Scott Cantor (SC)

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/contrib.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/contrib.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/contrib.html (original) +++ xml/site/targets/security/contrib.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Contributing to XML-Security @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Contributing to XML-Security

@@ -239,7 +239,7 @@

- +

Subversion (SVN) Usage Overview

@@ -261,7 +261,7 @@ how to get a local copy of the source.

- +

Subversion Committer with HTTPS access

@@ -287,7 +287,7 @@

- +

Procedure for Raising Development Issues

@@ -296,7 +296,7 @@ patches. So that everyone can be productive, it is important to know which method is appropriate for a certain situation and how to go about it without confusion. This section explains when to use the developer - mailing list the bug database. + mailing list or the bug database.

Research your topic thoroughly before beginning to discuss a new @@ -334,7 +334,7 @@ enough and the readers eyes glazed over.

- +

Contribution Notes and Tips

@@ -356,7 +356,7 @@

- Start new threads with new Subject for new topics, rather than + Start new threads with a new Subject for new topics, rather than reusing the previous Subject line.

@@ -464,7 +464,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/download.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/download.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/download.html (original) +++ xml/site/targets/security/download.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Downloading the Libraries @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Downloading the Libraries

@@ -185,7 +185,7 @@

Validating Distribution Signatures

- All distributions are provided with signature .sig files. + All distributions are provided with signature .asc files. These contain PGP signatures for the related distribution. You should validate these using the keys found in the @@ -197,13 +197,13 @@

 % pgpk -a KEYS
-% pgpv xml-security-bin-1_2_1.zip.sig
+% pgpv xml-security-bin-1_4_2.zip.asc
   or
 % pgp -ka KEYS
-% pgp xml-security-bin-1_2_1.zip.sig
+% pgp xml-security-bin-1_4_2.zip.asc
   or
 % gpg --import KEYS
-% gpg --verify xml-security-bin-1_2_1.zip.sig
+% gpg --verify xml-security-bin-1_4_2.zip.asc

@@ -239,7 +239,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/faq.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/faq.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/faq.html (original) +++ xml/site/targets/security/faq.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Frequently Asked Questions @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Frequently Asked Questions

Questions

@@ -216,11 +216,10 @@

- The best place to start is W3C XML-Signature Syntax and Processing . Links on XML - security in general can be found on The XML Security Page . + The best place to start is W3C XML-Signature Syntax and Processing .

- +

2.3. Where can I learn about XML Encryption?

@@ -229,11 +228,10 @@

- The best place to start is W3C XML Encryption Syntax and Processing. Links on XML - security in general can be found on The XML Security Page. + The best place to start is W3C XML Encryption Syntax and Processing.

- +

2.4. Where can I learn about Cryptography in general?

@@ -249,9 +247,9 @@ "Learn XYZ in 21 days"-book

- +

3. XMLDSig questions

- +

3.1. What is the enveloped transform?

@@ -297,7 +295,7 @@ untouched.

- +

3.2. What's the difference between C14N and ExclC14N?

@@ -346,7 +344,8 @@ // -->

svn commit: r670690 [2/4] - in /xml/site/targets/security: ./ Java/ c/

2008-06-23T18:03:53Z

Modified: xml/site/targets/security/c/prog_enc.html
URL: http://svn.apache.org/viewvc/xml/site/targets/security/c/prog_enc.html?rev=670690&r1=670689&r2=670690&view=diff
==============================================================================
--- xml/site/targets/security/c/prog_enc.html (original)
+++ xml/site/targets/security/c/prog_enc.html Mon Jun 23 11:03:52 2008
@@ -1,9 +1,9 @@
-
+
 
 
 
 
-
+
 
 XML Encryption Programming
 
@@ -48,7 +48,7 @@
     +-->
 
 
-  
+  
                     
 
 
@@ -60,13 +60,13 @@
     +-->
 
 
-Home
+Home
 
 
-Java
+Java
 
 
-C++
+C++
 
 
 
-
+

- +

XML Encryption Programming

@@ -547,7 +547,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/c/programming.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/c/programming.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/c/programming.html (original) +++ xml/site/targets/security/c/programming.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + XML Signature Programming @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

XML Signature Programming

@@ -175,7 +175,7 @@ The rest of this section provides a very high level overview on how to use the library for signing and verificataion of signatures.

Note

Full API documentation for the current official release can be found @@ -298,7 +298,7 @@ made using Commented C14n canonicalisation, and a HMAC-SHA1 signature.

Warning

The XSECProvider class still "owns" the DSIGSignature object. @@ -336,7 +336,7 @@ The macro MAKE_UNICODE_STRING is defined within the library header files and is used to transcode local code page strings.

Note

There is no need to insert the reference object into the DOM structure. @@ -381,7 +381,7 @@ person to re-implement the XSECCrypto code to use any cryptographic provider required.

Note

Once the key is passed to the signature it is owned by the signature. @@ -665,7 +665,8 @@ // -->

Modified: xml/site/targets/security/c/releases.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/c/releases.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/c/releases.html (original) +++ xml/site/targets/security/c/releases.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Release Information @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Release Information

Changes

- This section describes the changes that have occurred between the - various releases of the library + Please see the CHANGELOG that accompanies the software for a history + of changes.

- -

Version 1.2.0

- Version 1.2 provides bug fixes to signature and encryption, and - provides support for XKMS message generation and processing. -

- Changes from version 1.1.0 include : -

Classes to generate and process XKMS messages
A client tool - xklient - to communicate - queries to an XKMS server and print the results to stdout. -
Multiple bug fixes
Support for SHA-512/384 when using a beta of OpenSSL - 0.9.8
Updated to support Xerces 2.6 and Xalan 1.8/9

- -

Version 1.1.0

- Version 1.1 provides bug fixes to signature functionality + - beta support for XML Encryption. -

- Changes from version 1.0.0 include : -

Beta implementation of XML Encryption, using an interface - similar to that used in the Apache Java xml-security library
Fix for bug where large text elements would be truncated during - canonicalisation
Provision of a cipher tool that can be used to encrypt - and decrypt XML documents
Updated and improved the Windows Crypto API interface
Other bug fixes to signature functionality
Updated to support Xerces 2.4/2.5 and Xalan 1.7

- -

Changes from 0.10 - 1.00

- Version 1.00 is the first release of the library considered basically - stable. The interface is fairly simple, but all the mandatory - requirements of the XML Digital Signature standard, canonicalised - XML, exclusive canonicalised XML and XPath-Filter2 are implemented. -

- Changes from version 0.20 include : -

Implementation of remaining KeyInfo elements (SPKIData, - PGPData and MgmtData
Re-implementation of XSECXPathNodeList using a binary search - to speed up list searches
Support for Intel Compiler 6.0 on - Linux and Forte CC (CC 5.4) on Solaris
Limited support (i.e. without Xalan integration for NetBSD, - FreeBSD and Cygwin
A number of minor bug fixes

- -

Changes from 0.10 - 0.20

- Includes a number of bug-fixes and a first cut at a provider for the - Windows Crypto API. -

- -

Beta release 0.10

- The current release of the xml-security-c library is a beta of the - XML Digital Signature code, and is the first version of the library - produced within Apache's XML project. -

- Previous versions were created within Sourceforge as the - xml-security-c project at that site. -

- -

Changes from 0.03-0.10

- The following changes occurred between versions 0.03 and 0.10 : -

A threadTest tool, which is primarily used to show - how multiple threads can access the library under Windows
Windows and UNIX URI Resolvers, based on the Xerces resolver, - but which can handle HTTP re-directs
Completed a basic level of API documentation
Reviewed library to ensure usage of UTF-16 internally
Closed a number of memory-leaks caused by exceptions being - thrown

- -

Changes from 0.02-0.03

- The following changes occurred between 0.02->0.03 -

A txfmout tool to output the transformed references
Updates to templatesign to support KeyInfo elements - and RSA signatures
Library support for RSA signatures
API support form manipulating KeyInfo elements
Pluggable KeyInfo Resolvers (to allow an application to supply - an object that will resolve a given KeyInfo to a key)
Pluggable URI resolvers
API support for creating references and transformations
Re-written Makefiles for *NIX
Improved API docs
Envelope Transform that no longer uses XPath transforms (much - quicker)
Uses new Xerces DOMNode objects - has made for significant - speed improvements

- -

Changes from 0.01-0.02

Signing functionality
Update C14n canonicalisation
Exclusive Canonicalisation
Basic ability to create a signature via the API (rather than just - from an XML template file
SHA-1 HMAC support
Basic Documentation of core API
A templatesign tool

- - -

Future Release Plans

A number of items are planned for after the 1.0 major release.

XML Encryption Support
decoupled, pluggable interface for transforms and signature types. - Currently these are hard coded into the library, so it is not - possible for calling applications to "plug-in" their own signature - types or transforms
Implement a SAX based canonicaliser for situations where an XML - document needs to be read in and directly canonicalised (i.e. where - the signature is not part of the document being processed
Improved KeyInfo resolver interface leading to...
XKMS client support
Implementation of libgcrypt as a crypto provider
Support for PGP/GPG key based signatures (using libgcrypt and - gpgme)
Bring the API in-line with JCP 105 (if appropriate)
Eventually (the GRAND PLAN) an XKMS server implementation
Implementation of a core set of encryption primitives to allow - decoupling from OpenSSL for "light" applications

@@ -390,7 +182,8 @@ // -->

Modified: xml/site/targets/security/c/tools.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/c/tools.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/c/tools.html (original) +++ xml/site/targets/security/c/tools.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Tools @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Tools

@@ -237,7 +237,8 @@ // -->

--------------------------------------------------------------------- To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r670690 [1/4] - in /xml/site/targets/security: ./ Java/ c/

2008-06-23T18:03:53Z

Author: mullan
Date: Mon Jun 23 11:03:52 2008
New Revision: 670690

URL: http://svn.apache.org/viewvc?rev=670690&view=rev
Log:
Update for 1.4.2 Java release.

Modified:
    xml/site/targets/security/Java/api.html
    xml/site/targets/security/Java/examples.html
    xml/site/targets/security/Java/faq.html
    xml/site/targets/security/Java/index.html
    xml/site/targets/security/Java/installation.html
    xml/site/targets/security/Java/interop.html
    xml/site/targets/security/Java/resolver.html
    xml/site/targets/security/c/credits.html
    xml/site/targets/security/c/faq.html
    xml/site/targets/security/c/index.html
    xml/site/targets/security/c/installation.html
    xml/site/targets/security/c/interop.html
    xml/site/targets/security/c/prog_enc.html
    xml/site/targets/security/c/programming.html
    xml/site/targets/security/c/releases.html
    xml/site/targets/security/c/tools.html
    xml/site/targets/security/changes.html
    xml/site/targets/security/contrib.html
    xml/site/targets/security/download.html
    xml/site/targets/security/faq.html
    xml/site/targets/security/history.html
    xml/site/targets/security/index.html
    xml/site/targets/security/license.html
    xml/site/targets/security/linkmap.html
    xml/site/targets/security/mail-lists.html
    xml/site/targets/security/todo.html
    xml/site/targets/security/who.html

Modified: xml/site/targets/security/Java/api.html
URL: http://svn.apache.org/viewvc/xml/site/targets/security/Java/api.html?rev=670690&r1=670689&r2=670690&view=diff
==============================================================================
--- xml/site/targets/security/Java/api.html (original)
+++ xml/site/targets/security/Java/api.html Mon Jun 23 11:03:52 2008
@@ -1,9 +1,9 @@
-
+
 
 
 
 
-
+
 
 Java API Documentation
 
@@ -48,7 +48,7 @@
     +-->
 
 
-  
+  
                     
 
 
@@ -60,13 +60,13 @@
     +-->
 
 
-Home
+Home
 
 
-Java
+Java
 
 
-C++
+C++
 
 
 
-
+

- +

Java API Documentation

@@ -186,7 +186,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/Java/examples.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/Java/examples.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/Java/examples.html (original) +++ xml/site/targets/security/Java/examples.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Java Examples @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Java Examples

@@ -155,7 +155,7 @@ the src_samples/ directory to give interested users a first starting point to jump-start with XML Signature.

Note

The samples divide into two groups: Samples that create and @@ -196,7 +196,8 @@ // -->

Modified: xml/site/targets/security/Java/faq.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/Java/faq.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/Java/faq.html (original) +++ xml/site/targets/security/Java/faq.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Frequently Asked Questions - Java @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Frequently Asked Questions - Java

Questions

@@ -178,75 +178,8 @@

2. Questions about this package

- +

2.1. - I'm using Crimson, but it throws Exceptions. Why? -

-^ -

- Crimson is not supported at the moment. The main reason is that - Crimson did not support the - org.w3c.dom.traversal.TreeWalker interface in the - past. Additionally, it does not support the - org.apache.xerces.dom.DocumentImpl.putIdentifier(String ID, - Element e) functionality where Xerces allows us to enable ID - attributes during document generation. -

- Use Apache Xerces - instead of Crimson. -

- -

2.2. - What's up with the Bouncy Castle CSP? / Where is my CSP? -

-^ -

- There is no JCE bundled together with this - distribution. This is because the Apache Project web site is hosted - in the US where some export restrictions apply to the cryptographic - primitives. -

- The nice guys from the Legion of Bouncy - Castle where so helpful to supply their JCE in a simple JAR - package so that we can simply fetch it during the compilation process - and put it into the libs/ directory. When you use the - ant makefile build.xml and simply say ant - compile or ant get-jce, ant tries - to fetch this JAR from the australian server. After that step, the - compilation works completely. -

- The ant make tools initiates an automated download of the - BouncyCastle JCE. The file is downloaded into the libs/ - directory and a "bc-" is prepended to the filename. This is - done because we want the provider name (bc means BouncyCastle) being - visible in the JAR's filename. -

Note

- The fact that we use Bouncy in this project does not mean - that you must use it, it's only the default. If you take a - look at the configuration - src/org/apache/xml/security/resource/config.xml, you'll - notice the sections which do integrate these alternative JCEs. -

- More information can be found in the Installation section. -

- -

2.3. How do I enable/turn off logging?

@@ -273,8 +206,8 @@

- -

2.4. + +

2.2. What is the meaning of BaseURI?

@@ -319,8 +252,8 @@ say URI="http://www.acme.com/index.html".

- -

2.5. + +

2.3. How do I use the package to generate and verify a signature?

@@ -331,7 +264,7 @@ Checkout the samples in src_samples/org/apache/xml/security/samples/signature/.

Note

The samples divide into two groups: Samples that create and @@ -341,9 +274,9 @@

- -

2.6. - I'm using SUN JDK v1.4.0 or v1.4.1 and it get some exceptions. Any clues? + +

2.4. + I'm using SUN JDK v1.4.0 or v1.4.1 and I get some exceptions. Any clues?

^ @@ -365,7 +298,7 @@ "endorsed" directory does not exist: you'll have to create it by hand.

Warning

Putting this JAR to another location like lib/ext WILL NOT WORK.

@@ -374,8 +307,8 @@ Unofficial JAXP FAQ .

- -

2.7. + +

2.5. I get a NullPointerException, and I don't know what's wrong.

@@ -398,8 +331,8 @@ any problem you have because of incorrect hehaviour of Xalan.

- -

2.8. + +

2.6. I sign a document and when I try to verify using the same key, it fails

@@ -448,7 +381,8 @@ // -->

Modified: xml/site/targets/security/Java/index.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/Java/index.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/Java/index.html (original) +++ xml/site/targets/security/Java/index.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + The Java section @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

The Java section

- + +

Version 1.4.2 Released

+ Version 1.4.2 of the Java library has been released. This is mainly + a bugfix release but also contains a few new enhancements including + support for XML Canonicalization 1.1. +

+ +

Version 1.4.1 Released

+ Version 1.4.1 of the Java library has been released. This is a bugfix + release that contains a major bugfix to the canonicalization engine + introduced in the 1.4 release. It is recommended that 1.4 users upgrade + to the new version as signatures containing non ascii characters created + by this library are not according to the standard, and will be only + validated by 1.4 library. +

- +

Version 1.4 Released

- Version 1.4 of the Java library has been released. - The main changes for this version are: -

+ Version 1.4 of the Java library has been released. + The main changes for this version are: +

Implementation of the standard API JSR105
Rewritten c14n that increases performance for signature - with node-set transformations.
Memory footprint reduction and several bugfixes

Refer to the - changelog for more information. -

+ changelog for more information. +

- +

Overview of the Java Library

@@ -205,7 +217,7 @@

- +

Old News

@@ -228,7 +240,7 @@

- +

JDK 1.4 issues

@@ -261,9 +273,10 @@ // -->

- +

@@ -60,13 +60,13 @@ +-->

- +

Installation - Java

@@ -164,7 +164,7 @@ an out-of-the-box JDK1.4 (e.g. on Windows 2000), the "endorsed" directory does not exist: you'll have to create it by hand.

Warning

Putting this JAR to another location like lib/ext WILL @@ -184,8 +184,8 @@

Prerequisites

- Make sure you get the Jakarta Ant Tool from - http://jakarta.apache.org/ant/ + Make sure you get the Ant Tool from + http://ant.apache.org/

@@ -277,7 +277,7 @@

- +

Playing around with the examples

@@ -365,60 +365,6 @@

- - - -

Where is my JCE?

- There is no JCE bundled together with this - distribution. Living in Germany, I had no problem to include the JCE in - this software package but then I realized that the Apache Project is - hosted in the US where some export restrictions apply to the - cryptographic primitives. -

- Well, how do we solve this problem? The nice guys from the Bouncy Castle where so - helpful to supply the JAR that you need to create HMAC integrity checks - on their web site. When you use the ant makefile build.xml - and simply say ant compile or ant get-jce, - ant tries to fetch this JAR from the australian - server. After that step, the compilation works completely. -

- The ant make tools initiates an automated download of the BouncyCastle - JCE. The file is downloaded into the libs/ directory and a "bc-" is - prepended to the filename. This is done because we want the provider - name (bc means BouncyCastle) being visible in the JAR's filename. -

- If you are a little paranoid like all security people and don't want - ant to make automated downloads or your firewall doesn't permit it - (preventing programs "phoning home"), look in the - ./build.xml file for the properties called -

-	<property name="jce.download.file" value="jce-jdk13-124.jar />
-	<property name="jce.download" 
-	          value="http://www.bouncycastle.org/download/${jce.download.file}" />
-	<property name="lib.jce" value="${libs}/bc-${jce.download.file}" />
-

- Here you can see that the file - jce-jdk13-124.jar - is downloaded and stored in the location ./libs/bc-jce-jdk13-124.jar - -

- If you do this by hand (pointing you favourite web browser and download - it yourself), simply put a "bc-" in front of the filename - and put it to ./libs/, then ant won't try to make a - download. -

Modified: xml/site/targets/security/Java/interop.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/Java/interop.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/Java/interop.html (original) +++ xml/site/targets/security/Java/interop.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Java Interoperability @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Java Interoperability

@@ -242,7 +242,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/Java/resolver.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/Java/resolver.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/Java/resolver.html (original) +++ xml/site/targets/security/Java/resolver.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Resolver-Mania @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Resolver-Mania

@@ -315,7 +315,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/c/credits.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/c/credits.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/c/credits.html (original) +++ xml/site/targets/security/c/credits.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Credits @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Credits

@@ -208,7 +208,8 @@ // -->

+ Copyright © + 2002-2006 The Apache Software Foundation. Modified: xml/site/targets/security/c/faq.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/c/faq.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/c/faq.html (original) +++ xml/site/targets/security/c/faq.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + Frequently Asked Questions - C++ @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

Frequently Asked Questions - C++

Questions

@@ -321,7 +321,7 @@ be searched. However it is recommended that these methods not be used, and DOM attributes of Type=ID be used.

Warning

In version 1.1 and above, the library defaults to searching for Id @@ -381,7 +381,8 @@ // -->

Modified: xml/site/targets/security/c/index.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/c/index.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/c/index.html (original) +++ xml/site/targets/security/c/index.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + C++ Library Documentation @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

C++ Library Documentation

- -

Version 1.3.1 Released

+ +

Version 1.4.0 Released

The Apache XML Security team are proud to announce the release - of version 1.3.1 of the xml-security-c library. This release - provides some bug fixes and an updated Automake based build on - Linux/Solaris/BSD. + of version 1.4.0 of the xml-security-c library. This release + provides more bug fixes, improved automake and RPM packaging, + and better error reporting.

This version also provides initial support for Xerces 3.0. If @@ -199,7 +199,20 @@

Old News

- + +

Version 1.3.1 Released

+ The Apache XML Security team are proud to announce the release + of version 1.3.1 of the xml-security-c library. This release + provides some bug fixes and an updated Automake based build on + Linux/Solaris/BSD. +

+ This version also provides initial support for Xerces 3.0. If + you are building for the 3.0 library under Windows, you will need + to change the Xerces library (in link includes) to xerces_3?.lib. +

Version 1.3 Released

The Apache XML Security team are proud to announce the release @@ -217,7 +230,7 @@ See changes.html for more information.

- +

Version 1.2 Released

The Apache XML Security team are proud to announce the release @@ -240,7 +253,7 @@ See changes.html for more information.

- +

News - March 2004

Version 1.1 of the C++ library has been released. Supporting @@ -256,7 +269,7 @@

Bug fixes to Signature implementation

- +

May 2003

Beta 0.2 has been released. It covers : @@ -277,7 +290,7 @@ Beta 0.2 is has been tested with Xerces-C v2.2 and the newly released Xalan-C v1.5.

- +

February 2003

The C++ library has now been fully transferred into the Apache XML @@ -298,7 +311,7 @@

XML Encryption (to be added post 1.00 release)

- +

News - August 2003

Version 1.00 of the library has now been released. It features : @@ -342,9 +355,10 @@ // -->

- +

@@ -60,13 +60,13 @@ +-->

- +

Installing the C++ Library

@@ -165,9 +165,8 @@ is also required if XPath and/or XSLT transformations are required.

- Version 1.2.0 of the library has been tested with version 2.5 and 2.6 - of Xerces-C, version 1.9 of Xalan-C and Version 0.9.6 (and above) of - OpenSSL. + Version 1.4.0 of the library has been tested with version 2.8 + of Xerces-C, and Version 0.9.7 (and above) of OpenSSL.

@@ -183,92 +182,42 @@ .

- This project's CVS repository can be checked out through anonymous - (pserver) CVS with the following instruction set. The module you wish - to check out must be specified as the modulename. When prompted for a - password for anonymous, simply enter "anoncvs" without quotes: + This project's SVN repository can be checked out directly from + https://svn.apache.org/repos/asf/xml/security/trunk/c

cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login
-	password: anoncvs
-	cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout
-	xml-security
-

A HTTP interface to browse the sources online is available via - http://cvs.apache.org/viewcvs.cgi/xml-security/ + http://svn.apache.org/viewvc/xml/security/trunk/c/

- +

Building for UNIX

XML-Security-C is currently fully supported on Linux, FreeBSD and Solaris. It is partially supported (in cases where Xalan is not required) on NetBSD and Cygwin. It has been built and - tested using GNU gcc 3.x, gcc 2.95.4, Forte C++ 5.4 (Solaris) and - GNU make. + tested using GNU gcc 3.x/4.x, Sun Workshop (Solaris), and GNU make.

Note

- The UNIX XML-Security-C build process has changed radically since - beta 0.0.2 as the Makefiles and configure scripts have been completely - rewritten. -

- +

Set up the Environment

- The build process has been automated as much as possible. To - start the process, three environment variables can be set : -

-XERCESCROOT - points to the base of your Xerces distribution
-XALANCROOT - points to the base of your Xalan distribution
-OPENSSL - points to the base of your OpenSSL distribution

- For example (on my Debian Linux box under Bash) : -

-export XERCESCROOT=~/prog/extlibs/xerces-c-src2_6_0
-export XALANCROOT=~/prog/extlibs/xalan-c-src1_9/c
-export OPENSSL=~/prog/extlibs/openssl-0.9.7g
-

- If these environment variables are not set, configure will try to - find the necessary include and library files in the system directories. - The configure script is created through autoconf so you - can also tell your compiler where to find these things via - the CXXFLAGS and LDFLAGS environment variables. + The build process has been automated as much as possible to rely on + standard configure and make commands and not environment variables.

Note

- As of version 1.3.1 the Xerces and OpenSSL directories can be - defined on the configure command line - see below. -

If configure cannot find anything for Xalan, it will assume that you are not interested in XPath or XSLT support and will compile XSEC without linking to Xalan. Any attempt to use these features will raise an exception in the library.

- +

Configure

- Now go to the $XSECCROOT directory and run the command + Now go to the root directory and run the command ./configure. This will create the necessary makefiles and header files necessary to build the package.

@@ -293,7 +242,7 @@ --enable-debug cause the library to be built with symbols -

Note

Using the --without-xalan option will automatically mean @@ -302,7 +251,7 @@ perform these without going through an XPath transform).

- +

Compile

Assuming the output of the above command looks reasonable simply @@ -328,14 +277,14 @@

- You will need to set up your LD_LIBRARY_PATH environment + You may need to set up your LD_LIBRARY_PATH environment variable to ensure ld.so will find the new shared libraries.

Finally - you can use make clean and make distclean to remove all binaries and libraries (former) and build scripts (latter)

- +

Install

@@ -346,16 +295,16 @@

- +

Building for Windows

XML-Security-C has been built and tested on Microsoft's Visual C++ 6.0 - compiler only. (VC++ .NET support is currently being worked on.) - The following subsections briefly describe how to + and 2005 compilers. The following subsections briefly describe how to rebuild the library, tools and samples using the supplied workspaces. + The specific information is for VC6, but the process for 2005 is similar.

Note

As of version 0.2, the library can be built without OpenSSL on a @@ -364,7 +313,7 @@ but should work.

- +

Setup Directories

The workspace and project files provided do not make any assumptions @@ -377,17 +326,17 @@ setup below (replacing D:\PROG\CLIB\.. with the appropriate path on your system).

Similarly the library directories will need to be added to. Note that in the example below, I use both Debug and Release libraries for Xalan and Xerces. As provided, the workspace projects link to the debug libraries for XSEC Debug and Release for XSEC Release.

- +

Configure

If you are using Xalan and OpenSSL, no configuration is required when @@ -421,7 +370,7 @@ project. These are the same as the normal debug or release builds, but the Xalan library is not linked in.

- +

Build Library and Tools

The main workspace (for VC 6.0) is found in : @@ -434,7 +383,7 @@ project. (The library is xsec_lib.) Project files for VC++ 7.0 and 8.0 also exist in the appropriate Project directories.

Note

Note that as of version 1.3.1, Xerces 3.0 is supported. However @@ -472,7 +421,8 @@ // -->

Modified: xml/site/targets/security/c/interop.html URL: http://svn.apache.org/viewvc/xml/site/targets/security/c/interop.html?rev=670690&r1=670689&r2=670690&view=diff ============================================================================== --- xml/site/targets/security/c/interop.html (original) +++ xml/site/targets/security/c/interop.html Mon Jun 23 11:03:52 2008 @@ -1,9 +1,9 @@ - + - + C++ Interoperability @@ -48,7 +48,7 @@ +--> @@ -60,13 +60,13 @@ +-->

- +

C++ Interoperability

@@ -183,7 +183,8 @@ // -->

--------------------------------------------------------------------- To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r603113 - /xml/site/targets/xindice/.htaccess

2007-12-11T01:43:59Z

Author: vgritsenko
Date: Mon Dec 10 17:43:55 2007
New Revision: 603113

URL: http://svn.apache.org/viewvc?rev=603113&view=rev
Log:
point to latest

Modified:
    xml/site/targets/xindice/.htaccess

Modified: xml/site/targets/xindice/.htaccess
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/.htaccess?rev=603113&r1=603112&r2=603113&view=diff
==============================================================================
--- xml/site/targets/xindice/.htaccess (original)
+++ xml/site/targets/xindice/.htaccess Mon Dec 10 17:43:55 2007
@@ -1,2 +1,2 @@
 Redirect permanent /xindice/dist/ http://xml.apache.org/xindice/download.cgi
-Redirect /xindice/api/ /xindice/1.1/api/
+Redirect /xindice/api/ /xindice/1.2/api/



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r602298 - /xml/site/targets/xindice/.htaccess

2007-12-08T02:11:40Z

Author: vgritsenko
Date: Fri Dec  7 18:11:38 2007
New Revision: 602298

URL: http://svn.apache.org/viewvc?rev=602298&view=rev
Log:
redirect from old api url to new location

Modified:
    xml/site/targets/xindice/.htaccess

Modified: xml/site/targets/xindice/.htaccess
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/.htaccess?rev=602298&r1=602297&r2=602298&view=diff
==============================================================================
--- xml/site/targets/xindice/.htaccess (original)
+++ xml/site/targets/xindice/.htaccess Fri Dec  7 18:11:38 2007
@@ -1 +1,2 @@
 Redirect permanent /xindice/dist/ http://xml.apache.org/xindice/download.cgi
+Redirect /xindice/api/ /xindice/1.1/api/



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r602295 - /xml/site/targets/xindice/api/

2007-12-08T02:02:02Z

Author: vgritsenko
Date: Fri Dec  7 18:02:01 2007
New Revision: 602295

URL: http://svn.apache.org/viewvc?rev=602295&view=rev
Log:
delete javadoc api from svn

Removed:
    xml/site/targets/xindice/api/


---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r602294 [10/10] - in /xml/site/targets/xindice: ./ 1.0/ 1.1/ 1.1/howto/ 1.2/ 1.2/howto/ dev/ skin/ skin/images/

2007-12-08T02:01:42Z

Modified: xml/site/targets/xindice/dev/index.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/dev/index.pdf?rev=602294&r1=602293&r2=602294&view=diff
==============================================================================
Binary files - no diff available.

Modified: xml/site/targets/xindice/dev/news.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/dev/news.html?rev=602294&r1=602293&r2=602294&view=diff
==============================================================================
--- xml/site/targets/xindice/dev/news.html (original)
+++ xml/site/targets/xindice/dev/news.html Fri Dec  7 18:01:36 2007
@@ -64,10 +64,13 @@
 Home
 
 
-How-Tos
+1.0
 
 
-1.0
+1.1
+
+
+1.2-Dev
 
 
 Dev
@@ -108,40 +111,43 @@
 Dev Zone
 
 
-Overview
+Overview
 
 
 News
 
 
-Todo
+Todo
 
 
-Resources
+Documentation
 
 
-Bug Database
+Xindice Internals
 
 
-Test Coverage
+Xindice Wiki
 
 
-Historical Coverage
+Contributing Documentation
+
+
+Updating Website
 
 
-Documentation
+Resources
 
 
-Xindice Internals
+Wiki
 
 
-Xindice Wiki
+Bug Database
 
 
-Contributing Documentation
+Test Coverage
 
 
-Updating Website
+Historical Coverage
 
 
 

Modified: xml/site/targets/xindice/dev/site-updating.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/dev/site-updating.html?rev=602294&r1=602293&r2=602294&view=diff
==============================================================================
--- xml/site/targets/xindice/dev/site-updating.html (original)
+++ xml/site/targets/xindice/dev/site-updating.html Fri Dec  7 18:01:36 2007
@@ -64,10 +64,13 @@
 Home
 
 
-How-Tos
+1.0
 
 
-1.0
+1.1
+
+
+1.2-Dev
 
 
 Dev
@@ -108,40 +111,43 @@
 Dev Zone
 
 
-Overview
+Overview
 
 
-News
+News
 
 
-Todo
+Todo
 
 
-Resources
-
+Documentation
+
 
-Bug Database
+Xindice Internals
 
 
-Test Coverage
+Xindice Wiki
 
 
-Historical Coverage
+Contributing Documentation
+
+
+Updating Website
 
 
-Documentation
-
+Resources
+
 
-Xindice Internals
+Wiki
 
 
-Xindice Wiki
+Bug Database
 
 
-Contributing Documentation
+Test Coverage
 
-
-Updating Website
+
+Historical Coverage
 
 
 
@@ -332,7 +338,7 @@
 by Vadim Gritsenko
 
 
-          version 530610
+          version 564064
 
 
 
-
-Home
-
 
-How-Tos
+Home
 
 
 1.0
 
 
+1.1
+
+
+1.2-Dev
+
+
 Dev
 
 
@@ -126,25 +129,166 @@
 Download
 
 
-Documentation
+Community
 
 
-Administrator Guide
+Contributing
+
+
+Who we are
+
+
+Mailing lists
+
+
+Code Repository
+
+
+Bug database
+
+
+Resources
+
+
+Wiki
+
+
+Related links
+
+
+XML:DB Initiative
+
+
+Overview
+
+
+Overview
+
+
+Changes
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+FAQ
+
+
+Resources
+
+
+XML:DB Initiative
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+XPath Guide
 
 
-User Guide
+FAQ
 
 
-Developer Guide
+Wiki
+
+
+Javadocs
+
+
+How-Tos
+
+
+Overview
+
+Compilation
+
+
+Unix
+
+
+Windows
+
+
+Installation
+
+
+Tomcat How-to
+
+
+Upgrading
+
+
+From 1.1b1 and up
+
+
+From 1.0
+
+
+
+Resources
+
+
+Wiki
+
+
+XML:DB Initiative
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
 
 
-Commandline Tool Guide
+User Guide
 
 
-XPath Guide
+Developer Guide
 
 
-FAQ
+Tool Guide
+
+
+XPath Guide
+
+
+FAQ
 
 
 Wiki
@@ -153,33 +297,87 @@
 Javadocs
 
 
-Community
-
+How-Tos
+
 
-Contributing
+Overview
 
+Compilation
+
 
-Who we are
+Unix
 
 
-Mailing lists
+Windows
 
+
+Installation
+
 
-Code Repository
+Tomcat How-to
 
+
+Upgrading
+
 
-Bug database
+From 1.1b1 and up
 
+
+From 1.0
 
-Resources
-
+
+
+Resources
+
 
-Related links
+Wiki
 
 
 XML:DB Initiative
 
 
+Dev Zone
+
+
+Overview
+
+
+News
+
+
+Todo
+
+
+Documentation
+
+
+Xindice Internals
+
+
+Xindice Wiki
+
+
+Contributing Documentation
+
+
+Updating Website
+
+
+Resources
+
+
+Wiki
+
+
+Bug Database
+
+
+Test Coverage
+
+
+Historical Coverage
+
+
 
 
 
@@ -229,6 +427,7 @@
 
 
   
+  
 
 
 Project  ___________________  menu
@@ -277,94 +476,126 @@
   
 
 
-Documentation  ___________________  menu
+Community  ___________________  menu
 
 
     
 
 
-Administrator Guide  ___________________  item
+Contributing  ___________________  item
 
 
     
 
 
-User Guide  ___________________  item
+Who we are  ___________________  item
 
 
     
 
 
-Developer Guide  ___________________  item
+Mailing lists  ___________________  item
 
 
     
 
 
-Commandline Tool Guide  ___________________  item
+Code Repository  ___________________  item
 
 
     
 
 
-XPath Guide  ___________________  item
+Bug database  ___________________  item
 
 
+  
+
+
+  
+
+
+Resources  ___________________  menu
+
+
     
 
 
-FAQ  ___________________  item
+Wiki  ___________________  item
 
 
     
 
 
-Wiki  ___________________  item
+Related links  ___________________  item
 
 
     
 
 
-Javadocs  ___________________  item
+XML:DB Initiative  ___________________  item
 
 
   
 
 
+
+  
   
 
 
-Community  ___________________  menu
+Overview  ___________________  menu
 
 
-    
+     
 
 
-Contributing  ___________________  item
+Overview  ___________________  menu-item
 
 
-    
+     
 
 
-Who we are  ___________________  item
+Changes  ___________________  menu-item
 
 
-    
+  
+
+
+  
 
 
-Mailing lists  ___________________  item
+Documentation  ___________________  menu
+
+
+     
+
+
+Administrator Guide  ___________________  menu-item
 
 
-    
+     
 
 
-Code Repository  ___________________  item
+User Guide  ___________________  menu-item
 
 
-    
+     
 
 
-Bug database  ___________________  item
+Developer Guide  ___________________  menu-item
+
+
+     
+
+
+Tool Guide  ___________________  menu-item
+
+
+     
+
+
+FAQ  ___________________  menu-item
 
 
   
@@ -376,22 +607,447 @@
 Resources  ___________________  menu
 
 
+     
+
+
+XML:DB Initiative  ___________________  menu-item
+
+
+  
+
+
+
+  
+  
+
+
+Overview  ___________________  menu
+
+
     
 
 
-Related links  ___________________  item
+Overview  ___________________  menu-item
+
+
+  
+
+
+  
+
+
+Documentation  ___________________  menu
+
+
+    
+
+
+Administrator Guide  ___________________  menu-item
 
 
     
 
 
-XML:DB Initiative  ___________________  item
+User Guide  ___________________  menu-item
+
+
+    
+
+
+Developer Guide  ___________________  menu-item
+
+
+    
+
+
+Tool Guide  ___________________  menu-item
+
+
+    
+
+
+XPath Guide  ___________________  menu-item
+
+
+    
+
+
+FAQ  ___________________  menu-item
+
+
+    
+
+
+Wiki  ___________________  menu-item
+
+
+    
+
+
+Javadocs  ___________________  menu-item
 
 
   
 
 
-
+  
+
+
+How-Tos  ___________________  menu
+
+
+    
+
+
+Overview  ___________________  menu-item
+
+
+    
+
+
+Compilation  ___________________  menu
+
+
+      
+
+
+Unix  ___________________  menu-item
+
+
+      
+
+
+Windows  ___________________  menu-item
+
+
+    
+
+
+    
+
+
+Installation  ___________________  menu
+
+
+      
+
+
+Tomcat How-to  ___________________  menu-item
+
+
+    
+
+
+    
+
+
+Upgrading  ___________________  menu
+
+
+      
+
+
+From 1.1b1 and up  ___________________  menu-item
+
+
+      
+
+
+From 1.0  ___________________  menu-item
+
+
+    
+
+
+  
+
+
+  
+
+
+Resources  ___________________  menu
+
+
+    
+
+
+Wiki  ___________________  menu-item
+
+
+    
+
+
+XML:DB Initiative  ___________________  menu-item
+
+
+  
+
+
+
+  
+  
+
+
+Overview  ___________________  menu
+
+
+    
+
+
+Overview  ___________________  menu-item
+
+
+  
+
+
+  
+
+
+Documentation  ___________________  menu
+
+
+    
+
+
+Administrator Guide  ___________________  menu-item
+
+
+    
+
+
+User Guide  ___________________  menu-item
+
+
+    
+
+
+Developer Guide  ___________________  menu-item
+
+
+    
+
+
+Tool Guide  ___________________  menu-item
+
+
+    
+
+
+XPath Guide  ___________________  menu-item
+
+
+    
+
+
+FAQ  ___________________  menu-item
+
+
+    
+
+
+Wiki  ___________________  menu-item
+
+
+    
+
+
+Javadocs  ___________________  external
+
+
+  
+
+
+  
+
+
+How-Tos  ___________________  menu
+
+
+    
+
+
+Overview  ___________________  menu-item
+
+
+    
+
+
+Compilation  ___________________  menu
+
+
+      
+
+
+Unix  ___________________  menu-item
+
+
+      
+
+
+Windows  ___________________  menu-item
+
+
+    
+
+
+    
+
+
+Installation  ___________________  menu
+
+
+      
+
+
+Tomcat How-to  ___________________  menu-item
+
+
+    
+
+
+    
+
+
+Upgrading  ___________________  menu
+
+
+      
+
+
+From 1.1b1 and up  ___________________  menu-item
+
+
+      
+
+
+From 1.0  ___________________  menu-item
+
+
+    
+
+
+  
+
+
+  
+
+
+Resources  ___________________  menu
+
+
+    
+
+
+Wiki  ___________________  menu-item
+
+
+    
+
+
+XML:DB Initiative  ___________________  menu-item
+
+
+  
+
+
+
+  
+  
+
+
+Dev Zone  ___________________  menu
+
+
+    
+
+
+Overview  ___________________  menu-item
+
+
+    
+
+
+News  ___________________  menu-item
+
+
+    
+
+
+Todo  ___________________  menu-item
+
+
+  
+
+
+  
+
+
+Documentation  ___________________  menu
+
+
+    
+
+
+Xindice Internals  ___________________  menu-item
+
+
+    
+
+
+Xindice Wiki  ___________________  menu-item
+
+
+    
+
+
+Contributing Documentation  ___________________  menu-item
+
+
+    
+
+
+Updating Website  ___________________  menu-item
+
+
+  
+
+
+  
+
+
+Resources  ___________________  menu
+
+
+    
+
+
+Wiki  ___________________  menu-item
+
+
+    
+
+
+Bug Database  ___________________  menu-item
+
+
+    
+
+
+Test Coverage  ___________________  menu-item
+
+
+    
+
+
+Historical Coverage  ___________________  menu-item
+
+
+  
+
+
+
+  
+  
 
 
 

Modified: xml/site/targets/xindice/linkmap.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/linkmap.pdf?rev=602294&r1=602293&r2=602294&view=diff
==============================================================================
Binary files - no diff available.

Modified: xml/site/targets/xindice/mail.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/mail.html?rev=602294&r1=602293&r2=602294&view=diff
==============================================================================
--- xml/site/targets/xindice/mail.html (original)
+++ xml/site/targets/xindice/mail.html Fri Dec  7 18:01:36 2007
@@ -64,10 +64,13 @@
 Home
 
 
-How-Tos
+1.0
 
 
-1.0
+1.1
+
+
+1.2-Dev
 
 
 Dev
@@ -126,35 +129,8 @@
 Download
 
 
-Documentation
-
-
-Administrator Guide
-
-
-User Guide
-
-
-Developer Guide
-
-
-Commandline Tool Guide
-
-
-XPath Guide
-
-
-FAQ
-
-
-Wiki
-
-
-Javadocs
-
-
-Community
-
+Community
+
 
 Contributing
 
@@ -171,8 +147,11 @@
 Bug database
 
 
-Resources
-
+Resources
+
+
+Wiki
+
 
 Related links
 
@@ -240,10 +219,8 @@
 
         
 
-          
-FAQs
-        
-
+          FAQs (1.1, 1.2)
+        
         
 Mailing list archives - a veritable goldmine of Xindice-specific information - if you know where to look!
       
@@ -251,7 +228,7 @@
 
 
     
-
+
 Xindice Users
 
 
@@ -275,7 +252,7 @@
 
 
     
-
+
 Xindice Dev
 
 
@@ -299,7 +276,7 @@
 
   
 
-          version 513115
+          version 598482
 
 
+
+apache > xml.apache > xindice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+                    
+
+
+
+
+
+
+Home
+
+
+1.0
+
+
+1.1
+
+
+1.2-Dev
+
+
+Dev
+
+
+
+
+

+ +

+ + +

+ +

+ + +

+ + + + + +

+ +

+
+ PDF +

Xindice 1.1 Developer Guide

+Introduction to Programming Xindice +
- +Accessing the Server +
  - +API's +
  +
- +Introducing the XML:DB XML Database API +
- +Setting up Your Build Environment +
- +Preparing the Server For the Examples +
- +Diving in With an Example Program +
  - +Simple XML:DB Example Program +
  +
- +Accessing Xindice Remotely +
+
+Managing Documents +
- +Creating a Collection +
  - +Creating a Collection +
  +
- +Working with Documents +
  - +Example Document +
  - +Adding an XML File to the Database +
  - +Retrieving an XML Document from the Database +
  - +Deleting an XML Document from the Database +
  +
+
+Using XPath to Query the Database +
- +Introduction +
- +Using the XML:DB Java API +
  - +Querying with XPath +
  +
+
+Using XUpdate to Modify the Database +
- +Introduction +
  - +Basic XUpdate Insert Command +
  +
- +XUpdate Commands +
- +XUpdate Node Construction +
- +Using the XML:DB API for XUpdate +
  - +Using XUpdate to modify the database +
  +
+
+Storing metadata +
- +Enabling metadata +
- +Using metadata +
- +Sample metadata code +
+
+Example Application +
- +Address Book +
+
+Experimental Features +

+ +

Note

+ If you notice incorrectness in this documentation, please + notify Xindice community. Your feedback + will help create better documentation. +

+ + +

Introduction to Programming Xindice

+ +

Accessing the Server

+ The Xindice server can be accessed either programmatically through + the server's APIs, or from the command line using the provided + command line tools. This document covers programmatic access, + for more information on using the command line interface please + refer to the Xindice Users Guide. +

+ +

API's

+ Xindice currently offers three layers of APIs that can be used to + develop applications. +

+ +XML:DB XML Database API used to develop + Xindice applications in Java. This is the primary API used to + develop applications and it will be given the most coverage in + this manual. Xindice provides two implementations of the XML:DB + API. One is built on top of the Xindice XML-RPC API, and another + embeds Xindice within the same JVM. Xindice currently implements + the May 07, 2001 draft of the XML:DB API. This API will change + slightly in the future to track the development of the XML:DB API. +
+ +Xindice XML-RPC API used when accessing Xindice + from a language other then Java. The XML-RPC API is built on top + of the Core Server API. XML-RPC implementation is provided by + Apache Web Services Project. +
+ Core Server API is the internal Java API of the core + database engine. This API is used to build the XML-RPC API and + embedded XML:DB API. This is the lowest level API and is only + available to software running in the same Java VM as the + database engine itself. +

+ The most common API for end user applications is the XML:DB XML + Database API that was developed by the + XML:DB Initiative. + This API is a vendor neutral API intended to make it possible to build + applications that will work with more then one XML database + without too much difficulty. This is similar to the capabilities + provided by JDBC for relational databases. More information about this + API can be found on the XML:DB Initiative web site, + http://xmldb-org.sourceforge.net. Most + programming examples in this manual will use the XML:DB API. The + Xindice implementation of the API is a Core Level 1 implementation. +

+ The Xindice server also exposes a XML-RPC API that is used to + implement the XML:DB API. The XML-RPC API will mainly be of + interest to those who want to access Xindice from a language other + then Java. Any language that supports a XML-RPC should be + able to utilize the services of the Xindice server via the XML-RPC + API. This document does not cover development with the XML-RPC API + as the XML:DB API is the preferred mechanism for developing Xindice + applications. If you are developing applications in Java you can + safely ignore the existence of this API. The XML-RPC API will be + covered in a seperate document to be written at a later time. +

+ The final API for Xindice is the Core Server API. +

+ +

Introducing the XML:DB XML Database API

+ XML:DB API is being developed by the + XML:DB Initiative to + facilitate the development of applications that function with + minimal change on more then one XML database. This is roughly + equivalent to the functionality provided by JDBC or ODBC for + providing access to relational databases. Xindice provides an + implementation of the XML:DB API that also serves as the primary + programming API for Xindice. +

+ The XML:DB API is based around the concept of collections that store + resources. A resource can be an XML Document, a binary blob or + some type that is not currently defined. Collections can be arranged + in a hierarchical fashion. This makes the architecture very similar + to that of a typical Windows or UNIX file system. What is different + however, is that collections also expose services that allow you to + do things such as query XML documents using XPath or update resources in a + transactionally secure manner. +

+ The XML:DB API defines several levels of interoperability called + Core Levels in XML:DB terminology. The Xindice implementation of the + API is a complete Core Level 1 implementation plus implementations of + some of the optional services. +

+ Required Core 1 services supported by Xindice include. +

+ +XPathQueryService - Enables execution of XPath + queries against the database. +

+ Optional Core 1 services supported by Xindice include. +

+ +XUpdateQueryService - Enables execution of XUpdate + queries against the database. +
+ +CollectionManagementService - Provides basic + facilities to create and remove collections. +

+ In addition to Core Level 1 support the Xindice implementation also + supports a few added services that are specific to Xindice. These + services exist because the functionality is necessary to fully + utilize all the capabilities provided by Xindice. However, they are + proprietary to Xindice and will not function unchanged on other XML + databases. +

+ The following services are currently provided by Xindice and are not + part of the common XML:DB API. +

+ +DatabaseInstanceManager - Provides the ability to + control the operation of the server programatically. +
+ +CollectionManager - Provides the ability to create + and configure collection instances within the server. This is a + much more functional version of CollectionManagementService + that will only work with Xindice. +

+ While this guide aims to provide some useful examples and to guide + you in the process of getting to know how to program Xindice it is + also useful to know that there is a good source of example code within + the server it self. The Xindice command line tools are built 100% on + the XML:DB API and provide a pretty comprehensive set of examples in + how to use the API. This is especially true when it comes to the Xindice + specific services that are included with the server. The source code + for all the command line tools can be found in + xindice/java/src/org/apache/xindice/tools/command. +

+ +

Setting up Your Build Environment

+ Before you can build applications for Xindice you need to make sure you + have your build environment properly setup. This mainly consists of + making sure that you have the proper VM version and a properly + configured CLASSPATH. +

+ To build applications for Xindice you can use JDK 1.3 or 1.4. JDK 1.2 + and below will not work. If you have more than one Java VM installed + make sure that your JAVA_HOME environment variable and + PATH environment variable both include the correct path. +

+ Once you have your Java VM properly configured you need to add a few + jar files to your CLASSPATH. The following list of + jars are required and should be made available on your + CLASSPATH. All required jars can be found in + xindice/java/lib + +

+ +xindice.jar - contains the main Xindice classes + that are used by the client API. +
+ +xmldb-common.jar, xmldb-api.jar, + xmldb-api-sdk.jar, xmldb-xupdate.jar + - contain implementations of the XML:DB API and XUpdate API. +
+ +xml-apis.jar - contains Java XML APIs. +
+ +xerces.jar - contains the Xerces XML parser. +
+ +xalan.jar - contains the Xalan XSLT engine. +
+ +commons-logging.jar - contains the Jakarta Commons + Logging package. +

+ +

Preparing the Server For the Examples

+ Before we get to some example code, we need to do a little work to setup the + server. Don't worry nothing hard. +

+ First we need to make sure the addressbook collection exists. If you followed + the install instructions completely you should have already created this, + but if not you should do so now. To find out if the collection exists you + can run: +

  xindice lc -c /db

+ If you don't see 'addressbook' listed in the result then you need to create + the collection. To create it just run: +

  xindice ac -c /db -n addressbook

+ Now that we have the collection, we can add a few example documents + so that we have something to play with. You can find the examples in your + Xindice installation in the directory + java/examples/guide/xml. Run these commands to add + the documents. +

+  cd $XINDICE_HOME/java/examples/guide/xml
+  xindice ad -c /db/addressbook -f address1.xml -n address1
+  xindice ad -c /db/addressbook -f address2.xml -n address2
+

+ If you're on Windows you'll need to adjust the path in the cd command + for your platform. Most of the examples in the manual will be written for + UNIX but will work fine in Windows if you just replace / with \ and + $XINDICE_HOME with %XINDICE_HOME%. +

+ That wasn't so bad and now we're set to look at some example code. +

+ +

Diving in With an Example Program

+ +

Simple XML:DB Example Program

+ This example simply executes an XPath query against a + collection, retrieves the results as text and prints them out. +

+ You can find the source code for this example in + Xindice/java/examples/guide/src/org/apache/xindice/examples/Example1.java +

+package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+public class Example1 {
+
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+
+    String uri = "xmldb:xindice:///db/addressbook";
+    col = DatabaseManager.getCollection(uri);
+
+    String xpath = "//person[fname='John']";
+    XPathQueryService service =
+      (XPathQueryService) col.getService("XPathQueryService", "1.0");
+    ResourceSet resultSet = service.query(xpath);
+    ResourceIterator results = resultSet.getIterator();
+    while (results.hasMoreResources()) {
+      Resource res = results.nextResource();
+      System.out.println((String) res.getContent());
+    }
+  } catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  } finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+
+}
+

+ Before diving into the gory detail of what this program is doing, let's + run it and see what we get back. +

+ If you have a binary build of Xindice the examples are already built + and you can run this example by typing. +

+  cd $XINDICE_HOME/java/examples/guide
+  ./run org.apache.xindice.examples.Example1
+

+ If all goes well, you should see a result that looks something like this. +

<?xml version="1.0"?>
+<person xmlns:src="http://xml.apache.org/xindice/Query"
+        src:col="/db/addressbook" src:key="address1">
+  <fname>John</fname>
+  <lname>Smith</lname>
+  <phone type="work">563-456-7890</phone>
+  <phone type="home">534-567-8901</phone>
+  <email type="home">jsmith@somemail.com</email>
+  <email type="work">john@lovesushi.com</email>
+  <address type="home">34 S. Colon St.</address>
+  <address type="work">9967 W. Shrimp Ave.</address>
+</person>
+

+ Now that we've seen the result, let's dive in and look at the code in + detail. While this isn't the simplest possible example program to start + with it does a nice job of showing all the basic techniques used when + building applications with the XML:DB API. +

+ To begin the program imports several XML:DB packages. +

+  import org.xmldb.api.base.*;
+  import org.xmldb.api.modules.*;
+  import org.xmldb.api.*;
+

+ These import the basic classes required by the API. + import org.xmldb.api.base.*; is the base API module + and is required for all XML:DB applications. + import org.xmldb.api.*; imports the all + important DatabaseManager class which is the + entry point into the API. + import org.xmldb.api.modules.*; brings in the + optional modules defined for the API. In this case the module we're + interested in is XPathQueryService. +

+ Before we can use the API we need to create and register the + database driver we want to use. In this case since we're writing for + Xindice we use org.apache.xindice.client.xmldb.DatabaseImpl + for our driver and register it with the DatabaseManager + +

+String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+Class c = Class.forName(driver);
+
+Database database = (Database) c.newInstance();
+DatabaseManager.registerDatabase(database);
+

+ Now that our driver is registered we're ready to retrieve the + collection that we want to work with. +

+String uri = "xmldb:xindice:///db/addressbook";
+Collection col =
+  DatabaseManager.getCollection(uri);
+

+ In the XML:DB API collections are retrieved by calling + getCollection and handing it a URI that specifies the + collection we want. The format of this URI will vary depending on + the database implementation being used but will always begin with + xmldb: and be followed by a database specific database + name, xindice: in the case of Xindice. +

+ The rest of the URI is a path used to locate the collection you want + to work with. This path begins with the name of the root collection + for the Xindice instance that you are trying to connect with. All + Xindice instances must have a unique name for the root collection. The + reason for this is that the name of the root collection is also the + name of the database instance and that name is what the Xindice server + uses to register itself with the naming service. In all examples in + this guide the root collection is called db. This + is the default name used for a newly installed instance of Xindice. If + you have more then one instance of Xindice running that you must be + sure to change the names on all other instances so that they are + unique. + Once you do this you can switch between the instances by simply + changing the first component of the path. +

+  xindice:///db/news
+  xindice:///db2/news
+

+ These paths will switch between a Xindice server with a root collection + of db and one of db2. These instances could be on the same machine or + on two completely different machines and to your application there is + no significant difference. +

+ After the root collection name the rest of the URI simply consists of + the path to locate the collection you want to work with. +

+ Now that we have a reference to the collection that we want to work + with we need to get a reference to the XPathQueryService + service for that collection. +

+String xpath = "//person[fname='John']";
+XPathQueryService service =
+(XPathQueryService) col.getService("XPathQueryService", "1.0");
+ResourceSet resultSet = service.query(xpath);
+

+ Services provide a way to extend the functionality of the XML:DB + API as well as enabling the definition of optional functionality. + In this case the XPathQueryService is an optional + part of Core Level 0 but is a required part of Core Level 1. + Since Xindice provides a Core Level 1 XML:DB API implementation the + XPathQueryService is available. +

+ To retrieve a service you must know the name of the service that + you want as well as the version. Services define their own custom + interfaces so you must cast the result of the getService() call to + the appropriate service type before you can call its methods. The + XPathQueryService defines a method + query() that takes an XPath string as an argument. + Different services will define different sets of methods. +

+ Now that we have an XPathQueryService reference + and have called the query() method we get a + ResourceSet containing the results. Since we just + want to print out the results of the query, we need to get an + iterator for our results and then use it to print out the results. +

+ResourceIterator results = resultSet.getIterator();
+while (results.hasMoreResources()) {
+    Resource res = results.nextResource();
+    System.out.println((String) res.getContent());
+}
+

+ Resources are another important concept within the XML:DB API. Since + XML can be accessed with multiple APIs and since an XML database + could potentialy store more the one type of data, resources provide + an abstract way to access the data in the database. The Xindice + implementation only supports XMLResource but other vendors may + support additional resource types as well. +

+ XMLResource provides access to the underlying XML data as either + text, a DOM Node or via SAX ContentHandlers. In our example we're + simply working with the content as text but we could just as easily + have called getContentAsDom() to get the content + as a DOM Node. Since we just want to print the XML out to the screen + it is easier to just work with text. +

+ The final element about our example program worth noting is the + finally clause. +

+finally {
+    if (col != null) {
+        col.close();
+    }
+}
+

+ The finally clause closes the collection that we created earlier. + This is vitally important and should never be overlooked. Closing + the collection releases all the resources consumed by the + collection. In the Xindice implementation this will make sure that the + CORBA resources are released properly. Failure to properly call + close on the collection will result in a + resource leak within the server. +

+ +

Accessing Xindice Remotely

+ By default Xindice assumes that the client and server are running on + the same machine, and the server is running on port 8888. In most + configurations this will not be the case so it will be necessary to + include the hostname and port of the server where Xindice is running + in your URIs. The port you use is the port that the servlet engine is + listening on. The port setting configuration depends on the servlet + engine you use. Xindice comes pre-configured with the Jetty servlet + engine running on port 8888, so URL used by default is + xmldb:xindice://localhost:8888. + To access the collection /db/addressbook on host xml.apache.org port + 8000 the URI would look something like this + xmldb:xindice://xml.apache.org:8000/db/addressbook. All + examples in this document assume that server uses default configuration. +

+ If you are having problems accessing Xindice remotely this may be the + result of the Xindice deployment in the non-standard servlet context + name. Xindice assumes that the server will be deployed under + /xindice servlet context. To do this, you just need to rename + Xindice WAR file to xindice.war, and deploy this renamed WAR + file. Alternatively, you need to specify system property + xindice.xmlrpc.service-location, or set property + service-location on the Database XML:DB object + right after its creation. +

+ + +

Managing Documents

+ In this chapter we'll look at using the XML:DB API to manage documents + within the Xindice server. As part of this we'll look at some sample code + that could be used to manage the data used by the AddressBook example + application included with the server and discussed in more detail later. +

+ When looking at managing documents with the XML:DB API the first thing + we need to confront is that the API doesn't actually work directly with + documents. It works with what the API calls resources that are an + abstraction of a document. This abstraction allows you to work with the same + document as either text, a DOM tree or SAX events. This is important to + understand as the use of resources runs as a common thread throughout the + XML:DB API. The XML:DB API actually defines more then one type of resource + however Xindice does not implement anything beyond XMLResource. +

+ +

Creating a Collection

+ Before we can work with any data in the database we need to create + a collection to hold our data. + While we could easily create this collection using the command line + tools it will be more fun to see how you might do this from your own + program. This will also show you a quick example of using the Xindice + specific CollectionManager service to manage + collections. This guide doesn't go into detail about using this + service but you can find lots of examples by looking at the source + code to the command line tool commands in the package + org/apache/xindice/tools/commands. +

+ The collection we want to create will be named + mycollection and will be a child of the root + collection. +

+ +

Creating a Collection

+package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+// For the Xindice specific CollectionManager service
+import org.apache.xindice.client.xmldb.services.*;
+
+import org.apache.xindice.xml.dom.*;
+
+public class CreateCollection {
+
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    String uri = "xmldb:xindice:///db/";
+    col =
+      DatabaseManager.getCollection(uri);
+
+    String collectionName = "mycollection";
+    CollectionManager service =
+      (CollectionManager) col.getService("CollectionManager", "1.0");
+
+    // Build up the Collection XML configuration.
+    String collectionConfig =
+      "<collection compressed=\"true\" " +
+      "            name=\"" + collectionName + "\">" +
+      "   <filer class=\"org.apache.xindice.core.filer.BTreeFiler\"/>" +
+      "</collection>";
+
+    service.createCollection(collectionName,
+      DOMParser.toDocument(collectionConfig));
+
+    System.out.println("Collection " + collectionName + " created.");
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+

+ With this example you can see a basic example of how to create the + CollectionManager service and use it to create + the collection. This service is proprietary to Xindice so if you use + it in your application you will not be able to port it to another + server. However, if you have the need to create collections within + your programs this is currently the most powerful way to do it. +

+ The trickiest part of creating a collection is creating the + proper XML configuration to hand to the + createCollection method. This XML + is the exact same thing that is placed into the system.xml file. + At this time these XML configurations are not documented so to + see what they need to be you should look for examples in system.xml + and the source code for the command line tools. Future versions of + this documentation will cover this area in more detail. +

+ +

Working with Documents

+ Now that we have a collection to store our data, we need to add + some data to it. We could use the command line tools + to do this but since we want to learn how the XML:DB API works we'll + look at how we can do this in a program that we write. +

+ For our examples in this chapter we'll work with some very simple + XML files that could be used to represent a person in an + address book. Later in the guide we'll look at an example + application that implements the actual address book functionality. + Each address book entry is stored in a seperate XML file. +

+ +

Example Document

+  <person>
+    <fname>John</fname>
+    <lname>Smith</lname>
+    <phone type="work">563-456-7890</phone>
+    <phone type="home">534-567-8901</phone>
+    <email type="home">jsmith@somemail.com</email>
+    <email type="work">john@lovesushi.com</email>
+    <address type="home">34 S. Colon St.</address>
+    <address type="work">9967 W. Shrimp Ave.</address>
+  </person>
+

+ If we store this example XML into a file we can then load it into + our addressbook collection using a simple program. +

+ +

Adding an XML File to the Database

+package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+import java.io.*;
+
+public class AddDocument {
+
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    String data = readFileFromDisk(args[0]);
+
+    XMLResource document =
+      (XMLResource) col.createResource(null, "XMLResource");
+    document.setContent(data);
+    col.storeResource(document);
+    System.out.println("Document " + args[0] + " inserted");
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+
+public static String readFileFromDisk(String fileName) throws Exception {
+  File file = new File(fileName);
+  FileInputStream insr = new FileInputStream(file);
+
+  byte[] fileBuffer = new byte[(int)file.length()];
+
+  insr.read(fileBuffer);
+  insr.close();
+
+  return new String(fileBuffer);
+}
+}
+

+ Much of this program is similar to what we've already seen in our + other XML:DB programs. Really the only difference is the code to add + the document. +

+ Documents are added to the server by first creating a new resource + implementation from a collection, + setting its content and then storing the resource to the collection. + The type of resource that is created is an XMLResource this can be + used to store XML as either text, a DOM Node or a SAX + ContentHandler. +

+ If you had your content already in a DOM tree you could also add + the document as a DOM. +

+XMLResource document = (XMLResource) col.createResource(null, "XMLResource");
+document.setContentAsDOM(doc); // doc is a DOM document
+col.storeResource(document);
+

+ The only difference here is that you must have the document as a DOM + Document already and then call setContentAsDOM(). From + there the resource works the same as always. +

+ One thing to note is that a resource must be stored in the same + collection from which it was originally created. +

+ +

Retrieving an XML Document from the Database

+package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+import java.io.*;
+
+public class RetrieveDocument {
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    XMLResource document = (XMLResource) col.getResource(args[0]);
+    if (document != null) {
+      System.out.println("Document " + args[0]);
+      System.out.println(document.getContent());
+    }
+    else {
+      System.out.println("Document not found");
+    }
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+

+ +

Deleting an XML Document from the Database

+package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+import java.io.*;
+
+public class DeleteDocument {
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    Resource document = col.getResource(args[0]);
+    col.removeResource(document);
+    System.out.println("Document " + args[0] + " removed");
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+

+ + +

Using XPath to Query the Database

+ +

Introduction

+ Xindice currently supports XPath as a query language. In many + applications XPath is only applied at the document level but in + Xindice XPath queries are executed at the collection level. This + means that a query can be run against multiple documents and the + result set will contain all matching nodes from all documents + in the collection. + The Xindice server also support the creation of indexes on + particular XPaths to speed up commonly used XPath queries. +

+ +

Using the XML:DB Java API

+ The XML:DB API defines operations for searching single documents as + well as collections of XML documents using XPath. These operations + are exposed through the XPathQueryService. In order to query single + documents you use the queryResource() method and to query + an entire collection you use the query() method. +

+ +

Querying with XPath

+ This example simply executes an XPath query against a + collection, retrieves the results as text and prints them out. +

+ You can find the source code for this example in + Xindice/java/examples/guide/src/org/apache/xindice/examples/Example1.java +

+package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+public class Example1 {
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    String xpath = "//person[fname='John']";
+    XPathQueryService service =
+      (XPathQueryService) col.getService("XPathQueryService", "1.0");
+    ResourceSet resultSet = service.query(xpath);
+    ResourceIterator results = resultSet.getIterator();
+    while (results.hasMoreResources()) {
+      Resource res = results.nextResource();
+      System.out.println((String) res.getContent());
+    }
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+

TODO: cover namespace support

+ + +

Using XUpdate to Modify the Database

+ +

Introduction

+ XUpdate is a specification under development by the XML:DB Initiative + to enable simpler updating of XML documents. It is useful within the + context of an XML database as well as in standalone implementations + for general XML applications. XUpdate gives you a declarative method + to insert nodes, remove nodes, and change nodes within an XML + document. The syntax is specified in the + + XUpdate working draft available on the XML:DB Initiative website. +

+ The XUpdate implementation in Xindice is based around the + Lexus XUpdate implementation that was developed by the + Infozone Group. +

+ The general model around XUpdate is to use an + xupdate:modifications + container to batch a series of XUpdate commands. All commands + will be performed in series against either a single XML document or + an entire collection of XML documents as specified by the developer. +

+ Execution of XUpdate commands is performed in two phases. First + selecting a node set within the document or collection and then + applying a change to the selected nodes. +

+ +

Basic XUpdate Insert Command

+<xupdate:modifications version="1.0"
+  xmlns:xupdate="http://www.xmldb.org/xupdate">
+
+<xupdate:insert-after select="/addresses/address[1]" >
+
+<xupdate:element name="address">
+<xupdate:attribute name="id">2</xupdate:attribute>
+<fullname>John Smith</fullname>
+<born day='2' month='12' year='1974'/>
+<country>Germany</country>
+</xupdate:element>
+
+</xupdate:insert-after>
+</xupdate:modifications>
+

+ +

XUpdate Commands

+ +xupdate:insert-before - Inserts a new node in document order before the selected node. +
+ +xupdate:insert-after - Inserts a new node in document order after the selected node. +
+ +xupdate:update - Replaces all child nodes of the selected node with the specified nodes. +
+ +xupdate:append - Appends the specified node to the content of the selected node. +
+ +xupdate:remove - Remove the selected node +
+ +xupdate:rename - Renames the selected node +
+ +xupdate:variable - Defines a variable containing a node list that can be reused in later operations. +

+ +

XUpdate Node Construction

+ +xupdate:element - Creates a new element in the document. +
+ +xupdate:attribute - Creates a new attribute node + associated with an xupdate:element. +
+ +xupdate:text - Creates a text content node in the document. +
+ +xupdate:processing-instruction - Creates a + processing instruction node in the document. +
+ +xupdate:comment - Creates a new comment node in the + document. +

+ +

Using the XML:DB API for XUpdate

+ The XML:DB API provides an XUpdateQueryService to enable executing + XUpdate commands against single documents or collections of + documents. To update a single document you use the + updateResource() method and to apply the updates + to an entire collection you use the update() method. +

+ The next example program applies a set of XUpdate modifications to + an entire collection of data. It first removes all elements that + match the XPath + /person/phone[@type = 'home'] + and then adds a new entry after all elements that match the XPath + /person/phone[@type = 'work'] + +

+ +

Using XUpdate to modify the database

+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+/**
+* Simple XML:DB API example to update the database.
+*/
+public class XUpdate {
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    String xupdate = "<xu:modifications version=\"1.0\"" +
+      "      xmlns:xu=\"http://www.xmldb.org/xupdate\">" +
+      "   <xu:remove select=\"/person/phone[@type = 'home']\"/>" +
+      "   <xu:update select=\"/person/phone[@type = 'work']\">" +
+      "       480-300-3003" +
+      "   </xu:update>" +
+      "</xu:modifications>";
+
+    XUpdateQueryService service =
+      (XUpdateQueryService) col.getService("XUpdateQueryService", "1.0");
+    service.update(xupdate);
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode + " " +
+    e.getMessage());
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+

+ + +

Storing metadata

+ Xindice allows a developer to store metadata that is associated with + any collection or document. Metadata is data that is associated with + a document or collection but is not part of that document or collection. + For example, a filesystem lists the last modified time of a file or + directory. That last modified time is metadata about the file or directory. +

+ Within Xindice, when metadata is turned on, each document and collection + has a MetaData object associated with it. The MetaData object is composed + of three sections and is represented in XML like this: +

+  <meta>
+    <system type="doc">
+      <attr name="created" value="10128378882" />
+      <attr name="modified" value="10128378882" />
+    </system>
+    <attrs>
+      <attr name="key" value="value"/>
+      <attr name="foo" value="bar"/>
+    </attrs>
+    <custom>
+      <myspecial>
+        any <valid /> xml
+      </myspecial>
+    </custom>
+  </meta>
+

+ The first section is enclosed by the <system> element and is controlled + by the core of Xindice. It currently tracks the type of resource referenced, + creation time and last modification time of the resource. The <system> + element has an attribute "type" which is either "doc" for document or "col" + for collection. Within the <system> element are <attr> elements. + Each <attr> element has two attributes, name and value. The creation + and modification times are stored in individual <attr> elements. + The value of these attributes are recorded as milliseconds since midnight + Jan 1, 1970 (just as System.currentTimeMills() ). +

+ The second section is a map of key-value pairs and is enclosed by the <attrs> element. Each key-value + pair is represented in a single <attr> element. The key-value pairs are completely controlled by the user. You + can add or remove any key-value pair in this section. Note that the map is from Object to Object, so you + can store any object your application requires. +

+ The third section is a custom XML document. This too is completely controlled + by the user. The only prerequisite is that the document stored is well-formed + XML. +

+ +

Enabling metadata

+ To turn on metadata storage in Xindice, edit the system.xml configuration + file and set the "use-metadata" attribute of the root-collection element to + "on". Restart your container, and metadata storage will be enabled. +

+ If properly configured, when you restart your container, you will see a + log message that looks like this: +

+  Dec 30, 2002 10:21:51 AM org.apache.xindice.core.Database setConfig
+  INFO: Meta information initialized
+

Note

+ This example is from the output of Tomcat. The output from other + containers might look different, but the message ("Meta information + initialized") should be identical. +

+ +

Using metadata

+ How you use metadata is really up to you, the application developer. + There are many potential uses depending on your application. One + example is a content management system in which each document has a + series of states through which it must pass. The states might be + controlled by a finite state machine, but each document's current + state would be stored in the metadata associated with it. +

+ +

Sample metadata code

+ Currently the metadata accessors are implemented as non-standard meta + information service which can be obtained via XML:DB API (name + "MetaService", version "1.0"), and it also available via the XML-RPC code. +

+ The Xindice XML-RPC server has four metadata related methods: + GetCollectionMeta, GetDocumentMeta, SetCollectionMeta, SetDocumentMeta. + Here's quick perl script which creates a collection and then dumps out + its metadata contents, and then sets some values inside the metadata. +

+#!/usr/local/bin/perl -w
+
+use strict;
+use Frontier::Client;
+use Data::Dumper;
+
+my($server,$result,$url);
+
+$url = 'http://localhost:8888/xindice';
+$server = Frontier::Client->new('url'=>$url,'debug'=>0);
+
+## try listing the collections
+## look at org/apache/xindice/server/rpc/messages/*.java
+## for the 'message' possibilities.  The parameters are there as well.
+
+my $colname = 'ninemetatest';
+my $args = {};
+
+#first, add the collection directly under the /db root.
+$args->{'message'} = 'CreateCollection';
+$args->{'collection'} = '/db';
+$args->{'name'} = $colname;
+$result = $server->call('run',$args);
+
+## now get the collection's meta
+$args = {};
+$args->{'message'} = 'GetCollectionMeta';
+$args->{'collection'} = '/db/'.$colname;
+$result = $server->call('run',$args);
+
+## this should print out the xml for the
+## collection's metadata.
+print Dumper($result);
+
+
+## now add some stuff to the metadata
+my $meta=<<EOF;
+<?xml version="1.0"?>
+    <meta>
+        <!-- since the system is controlled by
+          Xindice, this doesn't matter...
+        -->
+        <system type="col">
+            <attr name="created" value="1" />
+            <attr name="modified" value="5" />
+        </system>
+        <attrs>
+            <attr name="test" value="added" />
+        </attrs>
+        <custom>
+              <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+                  <test>the rdf example</test>
+              </rdf:RDF>
+        </custom>
+    </meta>
+EOF
+$args = {};
+$args->{'message'} = 'SetCollectionMeta';
+$args->{'collection'} = '/db/'.$colname;
+$args->{'meta'} = $meta;
+$result = $server->call('run',$args);
+
+## this should print out the xml for the
+## collection's revised metadata.
+print Dumper($result);
+

Fixme (dviner)

+ Make this example java instead of perl. +

Note

Metadata is currently only exposed in the XML-RPC accessor.

+ + +

Example Application

+ +

Address Book

+ The address book example is a simple servlet based application + constructued using Xindice. For more information on this example look + in the Xindice/java/examples/addressbook directory. +

+ TODO: Add more detail about building servlet applications. +

+ + + +

Experimental Features

+ There are a couple of features in Xindice that are definitely + experimental. These features can be interesing to explore to see some + things that could be useful in future versions of Xindice but they should + not be considered complete or stable. +

+ +

+by Kimbro Staken, Dave Viner +

+ + version 598114 +

+ +

+ + + Propchange: xml/site/targets/xindice/1.2/guide-developer.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: xml/site/targets/xindice/1.2/guide-developer.html ------------------------------------------------------------------------------ svn:keywords = Id Revision Author Date Added: xml/site/targets/xindice/1.2/guide-developer.pdf URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/guide-developer.pdf?rev=602294&view=auto ============================================================================== Binary file - no diff available. Propchange: xml/site/targets/xindice/1.2/guide-developer.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf --------------------------------------------------------------------- To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r602294 [5/10] - in /xml/site/targets/xindice: ./ 1.0/ 1.1/ 1.1/howto/ 1.2/ 1.2/howto/ dev/ skin/ skin/images/

2007-12-08T02:01:42Z

Added: xml/site/targets/xindice/1.1/howto/upgrading-one-one.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/howto/upgrading-one-one.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/howto/upgrading-one-one.html (added)
+++ xml/site/targets/xindice/1.1/howto/upgrading-one-one.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,448 @@
+
+
+
+
+
+
+
+Xindice Release 1.1b1 Through 1.1b4 Upgrading How-To
+
+
+
+
+
+
+
+
+
+
+
+
+apache > xml.apache > xindice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+                    
+
+
+
+
+
+
+Home
+
+
+1.0
+
+
+1.1
+
+
+1.2-Dev
+
+
+Dev
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+              
+           
+
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+XPath Guide
+
+
+FAQ
+
+
+Wiki
+
+
+Javadocs
+
+
+How-Tos
+
+
+Overview
+
+Compilation
+
+
+Unix
+
+
+Windows
+
+
+Installation
+
+
+Tomcat How-to
+
+
+Upgrading
+
+
+From 1.1b1 and up
+
+
+From 1.0
+
+
+
+Resources
+
+
+Wiki
+
+
+XML:DB Initiative
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+        PDF
+
+Xindice Release 1.1b1 Through 1.1b4 Upgrading How-To
+
+
+
+Intended audience
+
+
+Prerequisites
+
+
+Upgrade Steps
+
+
+Overview
+
+
+Procedure
+
+
+Alternate Procedure
+
+
+
+
+
+
+Intended audience
+
+
+      This How-to is aimed at developers or administrator performing
+      upgrade of one of 1.1 beta releases of Xindice to the final 1.1 release.
+    
+
+
+Prerequisites
+
+
+      Shutdown. Shutdown the database before starting upgrade process.
+    
+
+      Backup. Always back up your database before starting an upgrade.
+    
+
+
+Upgrade Steps
+
+
+Overview
+
+        All Xindice 1.1 beta releases are utilising same configuration files and backward
+        compatible with the Xindice 1.1 final release. The areas where betas are different
+        are:
+      
+
+        
+
+          Changes to BTreeFiler and HashFiler. BTreeFiler has been changed to address
+          incorrect handling of numeric indexes (see Bug #19203). HashFiler has been changed
+          to address inefficient hash function implementation. Due to these changes,
+          existing databases should be upgraded to the latest format using supplied
+          database rebuild utility.
+        
+        
+
+          Changes to release packaging. Since Xindice 1.1, there are only two releases
+          are being shipped: source and binary. Binary release includes both xindice.war file
+          ready for deployment, as well as xindice.jar for embedded applications.
+        
+        
+
+          Changes to Xindice scripts. Xindice now comes with two main commands, xindice
+          and xindiced. First one is a Xindice command line tool, and second provides
+          a way to start Xindice database with embedded HTTP server (Jetty).
+        
+      
+
+
+Procedure
+
+        Upgrade procedure consists of the following:
+      
+
+        
+
+          Install Xindice 1.1 release.
+        
+        
+
+          Point XINDICE_HOME environment variable to the Xindice installation directory.
+        
+        
+
+          Copy existing database over to XINDICE_HOME/db. (Alternatively, set environment
+          variable XINDICE_DB_HOME to point to directory which contains db directory.)
+        
+        
+
+          In the shell, execute

+          (Unix):
+          +      cd $XINDICE_HOME
+      ./bin/xindice_rebuild rebuild db
+          (Windows):
+          +      cd %XINDICE_HOME%
+      bin\xindice_rebuild rebuild db
+          (If using XINDICE_DB_HOME variable, substitute 'db' with '$XINDICE_DB_HOME/db'.)
+        
+        
+
+          Check tool output for any problems. If any of the collections or indices could
+          not be rebuilt to new format, do not panic - just follow an alternate approach
+          outlined below.
+        
+        
+
+          Test resulting database using command line tool.
+        
+      
+
+
+Alternate Procedure
+
+        If any of the collections or indices could not be converted to new format,
+        follow these steps. To migrate collections over to the new database:
+      
+
+        
+
+          Start old Xindice database (using backed up data files).
+        
+        
+
+          Export all documents from affected collections (replace <name> with
+          collection path):

+          (Unix):
+          +      mkdir export
+      ./bin/xindiceadmin export -c /db/<name> -f export
+          (Windows):
+          +      mkdir export
+      bin\xindiceadmin export -c /db/<name> -f export
+        
+
+        
+
+          Stop old Xindice database.
+        
+        
+
+          Start new database.
+        
+        
+
+          Recreate collections in the new database.
+        
+        
+
+          Delete corrupted collections from new database using command line tool. This
+          should also remove all data files and index files of these collections.
+        
+        
+
+          Import all documents into the new database:

+          (Unix):
+          +      ./bin/xindice import -c /db -f export/<name>
+          (Windows):
+          +      bin\xindice import -c /db -f export\<name>
+        
+
+        
+
+          Create all indexes which were present in the old database.
+        
+      
+
+
+        For indices which can not be converted:
+      
+
+        
+
+          Start new database.
+        
+        
+
+          Drop corrupted indices.
+        
+        
+
+          Recreate indices anew.
+        
+      
+
+If you run into problems, don't worry.  Be sure to send feedback so that we can improve these documents for the next person.
+
+
+by Vadim Gritsenko
+
+
+          version 598506
+
+
+ 
+
+
+
+
+
+
+
+        Copyright ©
+         2001-2007 The Apache Software Foundation.
+
+
+
+

Propchange: xml/site/targets/xindice/1.1/howto/upgrading-one-one.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.1/howto/upgrading-one-one.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.1/howto/upgrading-one-one.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/howto/upgrading-one-one.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.1/howto/upgrading-one-one.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf

Added: xml/site/targets/xindice/1.1/index.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/index.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/index.html (added)
+++ xml/site/targets/xindice/1.1/index.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,268 @@
+
+
+
+
+
+
+
+Apache Xindice 1.1 Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+apache > xml.apache > xindice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+                    
+
+
+
+
+
+
+Home
+
+
+1.0
+
+
+1.1
+
+
+1.2-Dev
+
+
+Dev
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+              
+           
+
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+XPath Guide
+
+
+FAQ
+
+
+Wiki
+
+
+Javadocs
+
+
+How-Tos
+
+
+Overview
+
+Compilation
+
+
+Unix
+
+
+Windows
+
+
+Installation
+
+
+Tomcat How-to
+
+
+Upgrading
+
+
+From 1.1b1 and up
+
+
+From 1.0
+
+
+
+Resources
+
+
+Wiki
+
+
+XML:DB Initiative
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+        PDF
+
+Apache Xindice 1.1 Documentation
+
+
+
+Apache Xindice 1.1 Documentation
+
+
+
+    
+
+Apache Xindice 1.1 Documentation
+
+
+        Here you can read archived documentation for the Apache
+        Xindice 1.1 release. Use left navigation bar to browse 1.1 documentation,
+        or click on the Back button to return to the main site.
+      
+
+  
+
+          version 596928
+
+
+ 
+
+
+
+
+
+
+
+        Copyright ©
+         2001-2007 The Apache Software Foundation.
+
+
+
+
+
+
+

Propchange: xml/site/targets/xindice/1.1/index.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.1/index.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.1/index.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/index.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.1/index.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf

Added: xml/site/targets/xindice/1.2/faq.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/faq.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.2/faq.html (added)
+++ xml/site/targets/xindice/1.2/faq.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,465 @@
+
+
+
+
+
+
+
+Frequently Asked Questions
+
+
+
+
+
+
+
+
+
+
+
+
+apache > xml.apache > xindice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+                    
+
+
+
+
+
+
+Home
+
+
+1.0
+
+
+1.1
+
+
+1.2-Dev
+
+
+Dev
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+              
+           
+
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+XPath Guide
+
+
+FAQ
+
+
+Wiki
+
+
+Javadocs
+
+
+How-Tos
+
+
+Overview
+
+Compilation
+
+
+Unix
+
+
+Windows
+
+
+Installation
+
+
+Tomcat How-to
+
+
+Upgrading
+
+
+From 1.1b1 and up
+
+
+From 1.0
+
+
+
+Resources
+
+
+Wiki
+
+
+XML:DB Initiative
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+        PDF
+
+Frequently Asked Questions
+
+
+
+Questions
+
+
+1. What is Xindice?
+
+
+2. What is Xindice not?
+
+
+3. Why not use a relational database?
+
+
+4. Why not use an object database?
+
+
+5. Why not use a full-text indexing engine?
+
+
+6. What query languages do you support?
+
+
+7. Is your XPath implementation fully compliant?
+
+
+8. Which JDK should I use?
+
+
+9. 
+      The XML:DB API is missing something, what should I do?
+    
+
+
+10. 
+      My 5 megabyte file is crashing the command line, help?
+    
+
+
+11. XML parser conflict
+
+
+12. 
+      Where is my database?
+    
+
+
+
+
+
+
+Questions
+
+
+1. What is Xindice?
+
+        Xindice is an open source Native XML Database.  It stores and indexes
+        compressed XML documents in order to provide that data to a client
+        application with very little server-side processing overhead.  It
+        also provides functionality that is unique to XML data, which can't
+        easily be reproduced by relational databases.
+      
+
+2. What is Xindice not?
+
+        Xindice is not a persistent DOM implementation.  It was not designed
+        to store and manage single monster sized documents, where one
+        document is treated as a set of mini documents.  It was
+        specifically designed for managing many small to medium sized
+        documents.
+      
+
+3. Why not use a relational database?
+
+        XML documents are organized as tree structures.  Relational
+        databases organize data in a tabular, or grid-like fashion, and
+        use relational linking in order to expose hierarchical constraints
+        on the data.  Unfortunately, while it's generally very easy to map
+        relational data into XML, trying to map XML, which can be very
+        complex and freeform, into relational data can be incredibly
+        difficult and lossy.
+      
+
+4. Why not use an object database?
+
+        Object database are tightly coupled with the applications that
+        they serve, and are not generally considered to be client/server
+        databases.  Typically, the objects that they manage can only be
+        deserialized and used by the programming language that created
+        them.  While object graphs like DOM trees can be persisted in
+        object databases, the number of objects that are produced for a
+        a large collection of XML documents can become a serious
+        performance and resource bottleneck.
+      
+
+5. Why not use a full-text indexing engine?
+
+        Full text indexing engines are very fast and appropriate for
+        performing broad queries across a set of documents.  The
+        drawbacks to using them for XML applications is that creating
+        an inverted index causes you to lose document context, requiring
+        very intensive post-processing to isolate the document nodes
+        that are being managed.  Xindice provides efficient indexing of
+        element and attribute values in addition to the ability to
+        return and manage aggregated document fragments.
+      
+
+6. What query languages do you support?
+
+        Xindice supports XPath and XUpdate.  XPath is the W3C's XML
+        Pathing language, and is a very powerful way of selecting sets of
+        nodes from documents in a collection.  XUpdate is the XML:DB
+        Initiative's updating language, and is very flexible in its ability
+        to update sets of documents that meet specific XPath criteria.
+      
+
+7. Is your XPath implementation fully compliant?
+
+        Our XPath implementation is the Apache Software Foundation's Xalan
+        library.  Xindice provides indexing mechanisms and query
+        optimization facilities to augment the performance of collection
+        level XPath queries, but Xalan ultimately has the final say in
+        any query.
+      
+
+8. Which JDK should I use?
+
+        Minimum required JDK version is 1.4, Xindice will also work with
+        versions 1.5 and 1.6. 
+      
+
+9. 
+      The XML:DB API is missing something, what should I do?
+    
+
+        The XML:DB API is being designed be the XML:DB Initiative, and
+        so its interfaces and classes are predetermined by that group.
+        If you have any questions or would like to help further define
+        the standard API for XML databases, please visit
+        http://xmldb-org.sourceforge.net.
+      
+
+10. 
+      My 5 megabyte file is crashing the command line, help?
+    
+
+        See FAQ #2.  Xindice wasn't designed for monster documents,
+        rather, it was designed for collections of small to medium
+        sized documents.  The best thing to do in this case would be to
+        look at your 5 megabyte file, and determine whether or not it's
+        a good candidate for being sliced into a set of small documents.
+        If so, you'll want to extract the separate documents and add
+        them to a Xindice collection individually.  A good example of
+        this, would be a massive document of this form:
+      
++  <cars>
+     <car>
+        <make>Boyoda</make>
+        <model>Cordova</model>
+        <year>1989</year>
+     </car>
+     <car>
+        <make>Frod</make>
+        <model>Tortorus</model>
+        <year>1990</year>
+     </car>
+     ...
+  </cars>
+      
+
+        In this case, it makes more sense to split the file into
+        several <car/> documents instead of a
+        single <cars/> document.
+      
+
+11. XML parser conflict
++  org/w3c/dom/DOMException
+    at org.Xindice.xml.dom.NodeImpl.<clinit>(NodeImpl.java:86)
+    at java.lang.Class.forName0(Native Method)
+    at java.lang.Class.forName(Class.java:120)
+    at org.apache.xerces.parsers.DOMParser.setDocumentClassNa
+    ...
+      
+
+        This is also a common error one will encounter, and usually is
+        related to having more than one version of the Xerces XML Parser
+        on your CLASSPATH.  Before running Xindice or any client programs,
+        be sure that the Xerces Jar file that is included in the Xindice
+        distribution is the first Xerces Jar file on your CLASSPATH.
+      
+
+12. 
+      Where is my database?
+    
+
+        Since Xindice 1.1 the database is running under an application
+        server (e.g. Tomcat). The database configuration is located at
+        [your webapps directory]/xindice/WEB-INF/system.xml (assuming
+        of course that your war was unpacked by the container). 
+      
+
+        Xindice configuration, by default, uses "./db" as the database
+        location, which is assumed as a path relative to the webapp's 
+        /WEB-INF location. This means that usually the database will 
+        be located at [your webapps directory]/xindice/WEB-INF/db. 
+      
+
+        This behaviour can be overridden in two ways: either by editing
+        /WEB-INF/system.xml and setting an absolute path as the "dbroot"
+        attribute of the "root-collection" tag, or by setting the Java
+        property "xindice.db.home" to a path that will be the parent for
+        the "./db" directory. As an example, setting the property on the
+        command line with a value of "/var/xindice" 
+        (-Dxindice.db.home=/var/xindice) will mean that the database will
+        be found at /var/xindice/db.
+      
+
+
+
+ 
+
+
+
+
+
+
+
+        Copyright ©
+         2001-2007 The Apache Software Foundation.
+
+
+
+

Propchange: xml/site/targets/xindice/1.2/faq.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.2/faq.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.2/faq.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/faq.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.2/faq.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf

Added: xml/site/targets/xindice/1.2/guide-administrator.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/guide-administrator.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.2/guide-administrator.html (added)
+++ xml/site/targets/xindice/1.2/guide-administrator.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,625 @@
+
+
+
+
+
+
+
+Xindice 1.1 Administration Guide
+
+
+
+
+
+
+
+
+
+
+
+
+apache > xml.apache > xindice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+                    
+
+
+
+
+
+
+Home
+
+
+1.0
+
+
+1.1
+
+
+1.2-Dev
+
+
+Dev
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+              
+           
+
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+XPath Guide
+
+
+FAQ
+
+
+Wiki
+
+
+Javadocs
+
+
+How-Tos
+
+
+Overview
+
+Compilation
+
+
+Unix
+
+
+Windows
+
+
+Installation
+
+
+Tomcat How-to
+
+
+Upgrading
+
+
+From 1.1b1 and up
+
+
+From 1.0
+
+
+
+Resources
+
+
+Wiki
+
+
+XML:DB Initiative
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+        PDF
+
+Xindice 1.1 Administration Guide
+
+
+
+
+Database Administration
+
+
+Managing Collections
+
+
+Adding a Collection
+
+
+Deleting a Collection
+
+
+Listing the Collections
+
+
+
+
+Managing Indexes
+
+
+Adding an Index
+
+
+Indexing both Elements and Attributes
+
+
+
+
+
+
+Server Administration
+
+
+Installing the Server
+
+
+Starting the Server
+
+
+Starting the Server on UNIX
+
+
+Starting the Server on Windows
+
+
+
+
+Stopping the Server
+
+
+Stopping the Server on UNIX
+
+
+Stopping the Server on Windows
+
+
+
+
+Backing up Your Data
+
+
+Backing up the server
+
+
+Restoring the Data
+
+
+
+
+Exporting the Contents of the Database
+
+
+Exporting the database
+
+
+Importing the database
+
+
+
+
+
+
+
+    
+
+Database Administration
+
+
+        Database administration of Xindice is accomplished from the command
+        line using the xindice command. This command
+        allows you to view and alter the database configuration on the fly
+        on a running system.
+        
+      
+
+Managing Collections
+
+
+Adding a Collection
+
+            Adds a collection named products under the collection /db/data.
+          
+xindice add_collection -c /db/data -n products
+
+Deleting a Collection
+
+            Deletes the collection named products from the collection /db/data.
+          
+xindice delete_collection -c /db/data/products
+
+Listing the Collections
+
+            This will display a list of all child collections
+            under the collection /db/data
+          
+xindice list_collections -c /db/data
+
+Managing Indexes
+
+          The Xindice indexing system allows you to define indexes to speed
+          performance on commonly used XPath queries. If no indexes are defined
+          you can still execute queries but performance will suffer because
+          the query engine will need to scan the entire collection to create
+          the result node-set.
+        
+
+          Indexes can be added using the xindice command.
+        
+
+Adding an Index
+
+            Using this simple XML file you might want to index the product_id
+            element because searches for products by product_id are common.
+          
++  <?xml version="1.0"?>
+  <product>
+    <product_id>120320</product_id>
+    <description>Glazed Ham</description>
+  </product>
+          
+
+            This can be accomplished by running the following command.
+            This will create an index named idindex on all product_id
+            elements in the collection /db/data/catalog.
+          
++  xindice add_indexer -c /db/data/catalog -n idindex -p product_id
+          
+
+            Once this is done the query engine will now use this index to
+            help resolve XPath queries that involve restriction on the
+            value of the product_id element.
+          
+
+          The -p parameter to the command specifies the pattern to use in the
+          index. These patterns are used by the Indexing system to determine
+          best-fit and match-based Indexers for queries and index updating.
+          The pattern used MUST resemble the following scheme.
+        
+ 
+  Pattern      Description
+  ===========  ====================================================
+  elem         The value of the named element
+  elem@attr    The value of the attribute for the named element
+  *            The value for all elements
+  *@attr       The value of the named attribute for all elements
+  elem@*       The value of all attributes for the named element
+  *@*          The value of all attributes for all elements
+        
+
+          Note: In order to index a namespace other than the default
+          namespace, you must prepend your pattern components with a
+          URI placed in square brackets.  Example:
+        
++  [http://www.world.org/People]person
+  *@[http://www.world.org/People]id
+  [http://www.world.org/People]person@[http://www.world.org/People]id
+        
+
+          Do not include a prefix in these patterns, as the indexing
+          system, like most Namespace processing applications, processes
+          namespaced elements and attributes independently of the prefix
+          that is used.
+        
+
+Indexing both Elements and Attributes
+
+            Because the patterns recognize either an element or an attribute,
+            and not both, in order to index all element and attribute values
+            in a collection, you'd have to create two index entries. The *
+            pattern will index all elements and the *@* pattern will index
+            all attributes of all elements.
+          
++  xindice add_indexer -c /db/data/catalog -n idindex -p '*'
+  xindice add_indexer -c /db/data/catalog -n idindex -p '*@*'
+          
+
+          Excessive use of wildcard indexes can adversely affect the 
+          performance of the indexing system. Best practice would be to use
+          specific element or attribute indexes whenever possible, and only
+          define wildcard indexes when it is absolutely necessary.
+        
+
+    
+
+Server Administration
+
+
+Installing the Server
+
+          Starting from 1.1, Xindice is not a standalone server anymore.
+          The server functions are now based on your favourite Servlet 2.2
+          (or 2.3) compliant Application Server. Xindice has been tested
+          and proven to work under both Tomcat and Jetty, but there is no
+          particular reason to expect malfunctions under other application
+          servers.
+        
+
+          Installation is then straightforward: just deploy the Xindice
+          WAR file (xindice-1.1b3.war) into your favourite
+          application server and you're ready to go. There are only two
+          minor points to be aware of:
+        
+
+          
+
+            The Xindice XML-RPC endpoint is configured in the client
+            as http://anyserver:anyport/xindice/. This
+            means that it's strongly advisable to deploy the Xindice
+            WAR file under a xindice context. This can be
+            easily accomplished under Tomcat by simply renaming the WAR
+            file to xindice.war or (in Tomcat 4.1.x) by
+            copying the file dist/xindice-1.1b3.xml under
+            the $TOMCAT_HOME/webapps directory. Note that
+            under some Tomcat versions you will need to start twice the
+            server the first time so that Tomcat can configure itself
+            properly.
+          
+          
+
+            You probably want to edit the Xindice configuration file
+            that resides under /WEB-INF/system.xml. This
+            file configures, among others, the physical location of the
+            database. By default, your data will be under
+            [your_unpacked_war_location]/WEB-INF/db, which
+            might not be a good idea for many users: leaving the
+            database as is will mean data loss if an upgrade takes place
+            inadvertently, since the directory will be overwritten.
+            Also, if your application server is not unpacking WARs,
+            Xindice won't be able to start.
+          
+        
+
+
+          Having the server packaged as a webapp means also that
+          starting and stopping Xindice is "just" a matter of
+          starting/stopping the application server.
+        
+
+Starting the Server
+
+          Assuming that you have installed Xindice under Tomcat, and that you
+          have TOMCAT_HOME environment variable pointing to Tomcat installation
+          directory.
+        
+
+Starting the Server on UNIX
++  cd $TOMCAT_HOME/bin
+  ./startup.sh
+          
+
+Starting the Server on Windows
++  cd %TOMCAT_HOME%\bin
+  startup.bat
+          
+
+Stopping the Server
+
+          To stop Xindice server, you just stop application server. Assuming
+          that you are using Tomcat.
+        
+
+Stopping the Server on UNIX
++  cd $TOMCAT_HOME/bin
+  ./shutdown.sh
+          
+
+Stopping the Server on Windows
++  cd %TOMCAT_HOME%\bin
+  shutdown.bat
+          
+
+Backing up Your Data
+
+Backing up the server
+
+            Just shutdown the application server and copy the db
+            directory structure somewhere else, e.g. using Tomcat and
+            the server version of Xindice with the default configuration:
+          
++  catalina.sh stop
+  cd $TOMCAT_HOME/webapps/xindice/WEB-INF 
+  cp -pr db /backup/db
+  catalina.sh start
+          
+
+Restoring the Data
+
+            Restoring the data is simply removing the current database and
+            reversing the backup process.
+            Again, using Tomcat, this will be something like:
+          
++  catalina.sh stop
+  cd $TOMCAT_HOME/webapps/xindice/WEB-INF 
+  rm -rf db
+  cp -pr /backup/db db
+  catalina.sh start
+          
+
+Exporting the Contents of the Database
+
+          Xindice includes tools to export data to a directory hierarchy
+          and to also import data from a directory hierarchy. Each directory
+          in the hierachy corresponds to a collection in Xindice. Each XML
+          document is stored in a separate file named with the key from the
+          database.
+        
+
+Exporting the database
+
+            This example assumes that the Xindice/bin directory
+            is in your path.
+          
++  xindice export -c /db/root -f /path/to/data
+          
+
+            The entire contents of the collection /db/root will be exported
+            to the directory /path/to/data.
+          
+
+Importing the database
+
+            This example assumes that the Xindice/bin directory
+            is in your path.
+          
+              
+  xindice import -c /db  -f /path/to/data/root              
+          
+
+            Each directory under /path/to/data will be used to create a
+            collection and all XML documents in the hierarchy will be
+            imported in to the database. You can also restrict the documents
+            that are imported by adding -i and the extension of the files
+            you want to import.
+          
+
+  
+
+by Kimbro Staken, Gianugo Rabellino
+
+
+          version 596932
+
+
+ 
+
+
+
+
+
+
+
+        Copyright ©
+         2001-2007 The Apache Software Foundation.
+
+
+
+

Propchange: xml/site/targets/xindice/1.2/guide-administrator.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.2/guide-administrator.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.2/guide-administrator.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/guide-administrator.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.2/guide-administrator.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r602294 [3/10] - in /xml/site/targets/xindice: ./ 1.0/ 1.1/ 1.1/howto/ 1.2/ 1.2/howto/ dev/ skin/ skin/images/

2007-12-08T02:01:42Z

Added: xml/site/targets/xindice/1.1/guide-tools.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-tools.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/guide-tools.html (added)
+++ xml/site/targets/xindice/1.1/guide-tools.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,1774 @@
+
+
+
+
+
+
+
+Xindice 1.1 Commandline Tool Guide
+
+
+
+
+
+
+
+
+
+
+
+
+apache > xml.apache > xindice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+                    
+
+
+
+
+
+
+Home
+
+
+1.0
+
+
+1.1
+
+
+1.2-Dev
+
+
+Dev
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+              
+           
+
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+XPath Guide
+
+
+FAQ
+
+
+Wiki
+
+
+Javadocs
+
+
+How-Tos
+
+
+Overview
+
+Compilation
+
+
+Unix
+
+
+Windows
+
+
+Installation
+
+
+Tomcat How-to
+
+
+Upgrading
+
+
+From 1.1b1 and up
+
+
+From 1.0
+
+
+
+Resources
+
+
+Wiki
+
+
+XML:DB Initiative
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+        PDF
+
+Xindice 1.1 Commandline Tool Guide
+
+
+
+
+Collection Management Commands
+
+
+Adding a Collection
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Creating a Top Level Collection
+
+
+Creating a Sub Collection Under an Existing Collection
+
+
+
+
+Deleting a Collection
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Deleting a Top Level Collection
+
+
+Deleting a Sub Collection
+
+
+
+
+List Collections
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Listing the Top Level Collections
+
+
+Listing a Sub Collection
+
+
+
+
+
+
+Document Management Commands
+
+
+Adding a Document
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Adding a document to a collection with a key of "stones"
+
+
+Adding a document to the root collection with an automatically generated key
+
+
+
+
+Adding Multiple Documents
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Adding all files from a directory to a collection
+
+
+Adding all files from a directory with an extension of ".xml" 
+
+
+
+
+Deleting a Document
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Deleting a Document from a collection
+
+
+
+
+Retrieving a Document
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Retrieving a document from a collection
+
+
+
+
+Importing a Directory Tree
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Importing all directories and documents
+
+
+Importing all directories and documents with an extension of ".xml" 
+
+
+
+
+Exporting a Directory Tree
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Creating a directory tree indentical to a collection
+
+
+
+
+
+
+Collection Indexer Actions
+
+
+Adding a Collection Indexer
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+
+            To create a collection index in the pebbles collection for
+            documents with a "rock" element
+          
+
+
+
+            To create a collection index in the boulder sub collection
+            for documents containing a rock elements with an attribute of "hard"
+          
+
+
+
+
+Deleting a Collection Indexer
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Delete a collecion index in the pebbles collection
+
+
+
+
+Listing Collection Indexers
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+To list all collection indexes from the pebbles collection  
+
+
+
+
+
+
+Xpath Query Actions
+
+
+Executing an Xpath Query against a Collection
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+
+            Run an Xpath query against all documents in the pebbles collection
+            with "rock" node that has the type attribute = "hard"
+          
+
+
+
+            Run an Xpath query against all documents in the pebbles collection
+            with "rock" node that has the type attribute = "hard" when the rock
+            element is in the namespace http://www.bedrock.com
+          
+
+
+
+
+
+
+Miscellaneous Actions
+
+
+Shutting down the server
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Shutdown the server
+
+
+
+
+Accessing online Help
+
+
+Summary:
+
+
+Parameters:
+
+
+Examples:
+
+
+Show online Help
+
+
+
+
+
+
+
+    
+
+Note
+
+      If you notice incorrectness in this documentation, please
+      notify Xindice community. Your feedback
+      will help create better documentation.
+    
+
+
+    
+
+Collection Management Commands
+
+
+Adding a Collection
+
+          Adds a new collection to the database. When adding a collection
+          under an existing collection hierarchy all parent collections must
+          already exist in the database.
+        
+
+Summary:
+
+          
+xindice add_collection -c (or context)
+                  -n (or name) [-v (or )]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              add_collection
+            
Abberviated-Action: 
+              ac
+            
Access Level: Admin
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to create the new
+                  collection.
+          
+          
+
+            
+-n The name of the collection to create
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Creating a Top Level Collection
++  xindice add_collection -c /db -n pebbles
+          
+
+Creating a Sub Collection Under an Existing Collection
++  xindice add_collection -c /db/pebbles -n boulder
+          
+
+Deleting a Collection
+
+          Deletes a collection or subcollection from the database. If deleting
+          a collection that has subcollections and documents they will also be
+          deleted.
+        
+
+Summary:
+
+          
+xindice delete_collection -c (or context)
+                  -n (or name)
+                  [-v (or )]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              delete_collection
+            
Abberviated-Action: 
+              dc
+            
Access Level: Admin
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to delete the collection.
+          
+          
+
+            
+-n The name of the collection to delete.
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Deleting a Top Level Collection
++  xindice delete_collection -c /db -n pebbles
+          
+
+Deleting a Sub Collection
++  xindice delete_collection -c /db/pebbles -n boulder
+          
+
+List Collections
+
+          List all collections under the collection context given.
+        
+
+Summary:
+
+          
+xindice list_collections -c (or context) [-v (or )]
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              list_collections
+            
Abberviated-Action: 
+              lc
+            
Access Level: User
+
+Parameters:
+
+          
+
+            
+-c The collection context under which all sub collections are listed
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Listing the Top Level Collections
++  xindice list_collections -c /db
+          
+
+Listing a Sub Collection
++  xindice list_collections -c /db/pebbles
+          
+
+
+    
+
+Document Management Commands
+
+
+Adding a Document
+
+          Adds a document to a collection or nested collection. Adding a
+          document requires two parameters - the collection it will be stored
+          under, and the file path to the document. If a document key is not
+          provided an auto-generated system key will be used for the document.
+          Documents cannot be added to collections that do not already exist.
+          When entering the file path be sure to include the path and file
+          extension.
+        
+
+Summary:
+
+          
+xindice add_document -c (or context)
+                  -f (or file path)
+                  [-n (or key to assign to document)]
+                  [-v (or )]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              add_document
+            
Abberviated-Action: 
+              ad
+            
Access Level: User
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to add the document
+          
+          
+
+            
+-f The complete file path to the document being added
+          
+          
+
+            
+-n The key to assign to the document
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Adding a document to a collection with a key of "stones"
++  xindice add_document -c /db/pebbles -f /tmp/stones.xml -n stones
+          
+
+Adding a document to the root collection with an automatically generated key
++  xindice add_document -c /db -f /tmp/bookmarks.xml
+          
+
+Adding Multiple Documents
+
+          Adds multiple documents to a collection or a nested collection. This
+          command requires two arguments: the collection to store the documents
+          under and the directory path containing the documents.  Documents can
+          be added to collections as well as subcollections as long as they
+          exist. Documents added will be assigned their file name as the
+          document key. The optional "extension" parameter can be used to
+          import documents with a certain file extension. Document keys are
+          shown as they are created.
+        
+
+Summary:
+
+          
+xindice add_multiple_documents -c (or context)
+                  -f (or Directory to use )
+                  [-e (or file extenstion )]
+                  [-v (or )]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              add_multiple_documents
+            
Abberviated-Action: 
+              addmultiple
+            
Access Level: User
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to add the documents
+          
+          
+
+            
+-f The path to the directory to import documents from
+          
+          
+
+            
+-e The file extension to use when importing documents
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Adding all files from a directory to a collection
++  xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs
+          
+
+Adding all files from a directory with an extension of ".xml" 
++  xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs -e xml
+          
+
+Deleting a Document
+
+          Deletes an existing document from a collection or nested collection
+          within the database.
+        
+
+Summary:
+
+          
+xindice delete_document -c (or context)
+                  -n (or document key)
+                  [-v (or )]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              delete_document
+            
Abberviated-Action: 
+              dd
+            
Access Level: User
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to delete the document
+          
+          
+
+            
+-n The key of the document to be deleted
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Deleting a Document from a collection
++  xindice delete_document -c /db/pebbles -n stones
+          
+
+Retrieving a Document
+
+               Retrieves an existing document from a collection or nested collection within the database.  The complete path where
+               the document will be stored is required.  If the file path passed in does not exist, it will be created .
+               If the file argument given already exists, it will be overwritten automatically.
+        
+
+Summary:
+
+          
+xindice retrieve_document -c (or context)
+                  -n (or document key)
+                  -f (or file path and name )
+                  [-v (or )]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              retrieve_document
+            
Abberviated-Action: 
+              rd
+            
Access Level: User
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to retrieve the document
+          
+          
+
+            
+-n The key of the document to be retrieved
+          
+          
+
+            
+-f The file path to store the document under
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Retrieving a document from a collection
++  xindice retrieve_document -c /db/pebbles -n stones -f /tmp/stones.xml
+          
+
+Importing a Directory Tree
+
+          Adds multiple documents into a collection or a nested collection
+          within the database, copying the directory structure into the
+          database as collections. This command is designed to take a
+          directory and create a collection from it's name. Directories
+          under the directory will also be created as collections,
+          duplicating the directory tree.  The files within the specified
+          directory are converted into Documents and then stored into the
+          newly created collection with their filenames as the document keys.
+          The optional "extension" parameter can be used to only import
+          documents with a certain file extension. If the collection name
+          used already exists it will be overwritten. Collection and document
+          keys will are shown as they are created.
+        
+
+Summary:
+
+          
+xindice import -c (or context)
+                  -f (or file path and name )
+                  [-e (or file extenstion )]
+                  [-v (or ) ]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              import
+            
Abberviated-Action: 
+              import
+            
Access Level: Admin
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to import the documents
+          
+          
+
+            
+-f The path to the documents being added
+          
+          
+
+            
+-e The file extension to use when importing documents
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Importing all directories and documents
++  xindice import -c /db/pebbles -f /tmp/flintstones
+          
+
+Importing all directories and documents with an extension of ".xml" 
++  xindice import -c /db/pebbles -f /tmp/flintstones -e xml
+          
+
+Exporting a Directory Tree
+
+          Creates an identical directory tree from a collection including any
+          subcollections. The directory tree will be created starting at the
+          directory passed in as an argument. This command requires the
+          collection which you are eporting and the directory to export to as
+          arguments.
+        
+
+Summary:
+
+          
+xindice export -c (or context) -f (or directory path) [-v (or )]
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              export
+            
Abberviated-Action: 
+              export
+            
Access Level: User
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to export the document tree
+          
+          
+
+            
+-f The directory to create the collection structure under
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Creating a directory tree indentical to a collection
++  xindice export -c /db/pebbles -f /tmp/pebbles
+          
+
+
+    
+
+Collection Indexer Actions
+
+
+Adding a Collection Indexer
+
+          Adds a new collection index or nested collection index to the
+          database. In order to add the collection index, the collection it is
+          being added to must already exist.  This command allows you to supply
+          optional parameters for setting the index page size, setting the
+          maximum key size for the index, and the index data type.
+        
+
+Summary:
+
+          
+xindice add_indexer
+                  -c (or context)
+                  -n (or index name )
+                  -p (or index pattern)
+                  [--pagesize (or pagesize)]
+                  [--maxkeysize (or max key size)]
+                  [-t (or  index type)]
+                  [-v (or )]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              add_indexer
+            
Abberviated-Action: 
+              ai
+            
Access Level: Admin
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to add the indexer
+          
+          
+
+            
+-n The name of the index being added
+          
+          
+
+            
+-p The pattern used to create the index
+          
+          
+
+            
+--maxkeysize The MaxKeySize for the index ( default: 0 = none )
+          
+          
+
+            
+--pagesize The PageSize for the index ( default: 4096)
+          
+          
+
+            
+-t
+                  The data type for the index to create.  Possible values are:
+                  string   Non-normalized string value
+            trimmed  Normalized (whitespace stripped) string value
+            short    16-bit signed short integer
+            int      32-bit signed integer
+            long     64-bit signed integer
+            float    32-bit floating point value
+            double   64-bit floating point value (XPath number)
+            byte     8-bit signed byte
+            char     16-bit signed character
+            boolean  8-bit boolean value
+            name     Store document keys that contain the pattern
+          
+
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+
+            To create a collection index in the pebbles collection for
+            documents with a "rock" element
+          
++  xindice add_indexer -c /db/pebbles -n rockindex -p rock
+          
+
+
+            To create a collection index in the boulder sub collection
+            for documents containing a rock elements with an attribute of "hard"
+          
++  xindice add_indexer -c /db/pebbles/boulder -n hardindex -p rock@hard
+          
+
+Deleting a Collection Indexer
+
+          Deletes a collection index or a nested collection index from the
+          database. Deleting an index requires the collection and index name.
+          If a collection index is deleted, the collection will still remain.
+        
+
+Summary:
+
+          
+xindice delete_indexer -c (or context) -n (or index name) [-v (or )]
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              delete_indexer  
+            
Abberviated-Action: 
+              di  
+            
Access Level: Admin  
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to delete the index
+          
+          
+
+            
+-n The name of the indexer being deleted
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Delete a collecion index in the pebbles collection
++  xindice delete_indexer -c /db/pebbles -n hardindex
+          
+
+Listing Collection Indexers
+
+          Lists all collection indexers or nested collection indexes in the
+          database. The listing of indexes works in a similar fashion to
+          listing collections
+        
+
+Summary:
+
+          
+xindice list_indexers -c (or context) [-v (or )]
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              list_indexers
+            
Abberviated-Action: 
+              li
+            
Access Level: Admin
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to list the indexers
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+To list all collection indexes from the pebbles collection  
++  xindice list_indexers -c /db/pebbles
+          
+
+
+    
+
+Xpath Query Actions
+
+
+Executing an Xpath Query against a Collection
+
+          Execute an Xpath query against a collection or nested collection. The
+          command requires two arguments: the collection to query against and
+          the query string to use.
+        
+
+Summary:
+
+          
+xindice xpath -c (or context) -q (or query) -s (or prefix=namespace) [-v (or )]
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              xpath
+            
Abberviated-Action: 
+              xpath
+            
Access Level: User
+
+Parameters:
+
+          
+
+            
+-c The collection context under which to execute the query
+          
+          
+
+            
+-q The query to execute against the collection
+          
+          
+
+            
+-s Semi-colon delimited list of namespaces for query
+            in the form prefix=namespace-uri
+          
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+
+            Run an Xpath query against all documents in the pebbles collection
+            with "rock" node that has the type attribute = "hard"
+          
++  xindice xpath -c /db/pebbles -q "/rock[@type='hard']"
+          
+
+
+            Run an Xpath query against all documents in the pebbles collection
+            with "rock" node that has the type attribute = "hard" when the rock
+            element is in the namespace http://www.bedrock.com
+          
++  xindice xpath -c /db/pebbles -s "br=http://www.bedrock.com" -q "/br:rock[@type='hard']"
+          
+
+
+    
+
+Miscellaneous Actions
+
+
+Shutting down the server
+Shutdown the Xindice server
+
+Summary:
+
+          
+xindice shutdown [-v (or )]
+          
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              shutdown
+            
Abberviated-Action: 
+              shutdown
+            
Access Level: Admin
+
+Parameters:
+
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Shutdown the server
++  xindice shutdown
+          
+
+Accessing online Help
+Show the online help
+
+Summary:
+
+          
+xindice help [-v (or )]
+        
+
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+          
+
+            
+
+            
+          
+
+        
+Action: 
+              help
+            
Abberviated-Action: 
+              help
+            
Access Level: User
+
+Parameters:
+
+          
+
+            
+-v Show verbose output
+          
+        
+
+
+Examples:
+
+Show online Help
++  xindice help
+          
+
+  
+
+by Jay Kalafus, Kimbro Staken
+
+
+          version 598114
+
+
+ 
+
+
+
+
+
+
+
+        Copyright ©
+         2001-2007 The Apache Software Foundation.
+
+
+
+

Propchange: xml/site/targets/xindice/1.1/guide-tools.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.1/guide-tools.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.1/guide-tools.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-tools.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.1/guide-tools.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf

Added: xml/site/targets/xindice/1.1/guide-user.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-user.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/guide-user.html (added)
+++ xml/site/targets/xindice/1.1/guide-user.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,764 @@
+
+
+
+
+
+
+
+Xindice 1.1 User Guide
+
+
+
+
+
+
+
+
+
+
+
+
+apache > xml.apache > xindice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+                    
+
+
+
+
+
+
+Home
+
+
+1.0
+
+
+1.1
+
+
+1.2-Dev
+
+
+Dev
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+              
+           
+
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+XPath Guide
+
+
+FAQ
+
+
+Wiki
+
+
+Javadocs
+
+
+How-Tos
+
+
+Overview
+
+Compilation
+
+
+Unix
+
+
+Windows
+
+
+Installation
+
+
+Tomcat How-to
+
+
+Upgrading
+
+
+From 1.1b1 and up
+
+
+From 1.0
+
+
+
+Resources
+
+
+Wiki
+
+
+XML:DB Initiative
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+        PDF
+
+Xindice 1.1 User Guide
+
+
+
+
+Getting Started with Xindice
+
+
+Introduction to XML Databases
+
+
+Apache Xindice
+
+
+
+
+Introduction to Xindice
+
+
+What Is Xindice
+
+
+Current Status
+
+
+Feature Summary
+
+
+Database Structure
+
+
+Collection Path Example
+
+
+Collection Path Referencing a Document
+
+
+Collection Path Referencing a remote Document
+
+
+
+
+Introducing the Command Line Tools
+
+
+
+
+Managing Documents
+
+
+Introduction
+
+
+Adding Documents
+
+
+Adding a Document With a Given Key
+
+
+Adding a Document Without a Key
+
+
+
+
+Retrieving Documents
+
+
+Retrieving a Document Using an ID
+
+
+
+
+Deleting Documents
+
+
+Deleting a document using an ID
+
+
+
+
+
+
+Querying the Database
+
+
+Executing an XPath query against a collection of XML documents
+
+
+
+
+
+      
+
+Note
+
+        If you notice incorrectness in this documentation, please
+        notify Xindice community. Your feedback
+        will help create better documentation.
+      
+
+
+      
+
+Getting Started with Xindice
+
+
+Introduction to XML Databases
+
+Apache Xindice
+
+
+      
+
+Introduction to Xindice
+
+
+What Is Xindice
+
+               The Xindice Core server is a database server designed from the
+               ground up to store XML data. The
+               Xindice server is what is termed by
+               the
+               XML:DB Initiative
+               as a Native XML Database. You could also refer to it as a
+               seamless XML database which might be an easier to understand
+               description.
+            
+
+               What this means is that to the largest extent possible you work
+               with XML tools and technologies when working with the data in the
+               server. All data that goes into and out of the server is XML. The
+               query language used is XPath and the programming APIs support DOM
+               and SAX. All things that should be familiar to a developer used
+               to using XML in their applications. When working with XML data and
+               Xindice there is no mapping between different data models. You simply
+               design your data as XML and store it as XML.
+            
+
+               What this gives you can be summed up in one word, flexibility. XML
+               provides an extremely flexible mechanism for modeling application
+               data and in many cases will allow you to model constructs that are
+               difficult or impossible to model in more traditional systems. This
+               model is a semi-structured model and for some applications it is
+               an essential component. By
+               using a native XML database such as Xindice to store this data you can
+               focus on building your applications and not worry about how the
+               complex XML construct maps to the underlying data store or trying
+               force a flexible data model into a rigid set of schema constraints.
+            
+
+               Ultimately though, Xindice is a tool. It will be right for some jobs
+               and completely wrong for others. The job it is best at is simply
+               storing XML data. In fact, that's all it does. If you have lots of
+               XML data then Xindice may just be the right tool. However, if your
+               data isn't XML or if you have the need for precise control over
+               the structure of the data you might be better off using another
+               database solution.
+            
+
+Current Status
+
+               Native XML database technology is a very new area and Xindice is very
+               much a project still in development.
+               The server currently supports storing well formed XML documents.
+               This means it does not have any schema that constrains what
+               can be placed into a document collection. This makes Xindice a
+               semi-structured database and provides tremendous
+               flexiblity in how you store your data, but, also means you give up
+               some common database functionality such as data
+               types.
+               In its current state Xindice is already a powerful tool for managing
+               XML data. However, there is still much that needs to be done.
+               Feedback and contributions are actively encouraged.
+            
+
+               This document attempts to
+               describe those features that are working and can be used today.
+               You should review the README file that is part of the Xindice
+               distribution for the most current status on the project.
+            
+
+Feature Summary
+
+               
+Document Collections: Documents are stored in
+               collections that can be queried as a whole. You can create
+               collections that contain just documents of the same type or you
+               can create a collection to store all your documents together.
+               The database doesn't care.
+            
+
+               
+XPath Query Engine: To query the Document
+               Collections you use XPath
+               as defined by the W3C. This provides a reasonably flexible mechanism
+               for querying documents by navigating and restricting the result tree
+               that is returned.
+            
+
+               
+XML Indexing: In order to improve the performance
+               of queries over large numbers of documents you can define indexes on
+               element and attribute values. This can dramatically speed up query
+               response time.
+            
+
+               
+XML:DB XUpdate Implementation: When you store XML
+               in the database you may want to be able to change that data without
+               retrieving the entire document. XUpdate is the mechanism to use when
+               you want to do server side updates of the data. It is an XML based
+               language for specifying XML modifications and allows those modifications
+               to be applied to entire document collections as well as single documents.
+            
+
+               
+Java XML:DB API Implementation: For Java programmers
+               Xindice provides an implementation of the XML:DB API. This API is
+               intended to bring portability to XML database applications just as
+               JDBC has done for relational databases. Most applications developed
+               for Xindice will use the XML:DB API.
+            
+
+               
+Command Line Management Tools: To aid the administrator
+               Xindice provides a full suite of command line driven management tools.
+               Just about everything you can do through the XML:DB API can also be
+               done from the command line.
+            
+
+               
+Modular Architecture: The Xindice server is
+               constructed in a very modular manner. This makes it easy to add and
+               remove components to tailor the server to a particular environment or
+               to embed it into another application.
+            
+
+Database Structure
+
+               The Xindice server is designed to store collections of XML documents.
+               Collections can be arranged in a hierarchy similar to that of a
+               typical UNIX or Windows file system.
+            
+
+               In Xindice the data store is rooted in a database instance that can
+               also be used as a document collection. This
+               database instance can then contain any number of child collections.
+               In a default install of Xindice the database instance is called
+               'db' and all collection paths will begin with /db. It is possible to
+               rename the database instance if desired though it is not necessary
+               to do so.
+            
+
+               Collections are referenced in a similar manner to how you
+               would work with a hierarchical file system.
+            
+
+Collection Path Example
+
+                  If you had a collection
+                  created under 'db' called my-collection and a collection under
+                  that called my-child-collection the path used when accessing the
+                  my-child-collection collection would be
+               
++  /db/my-collection/my-child-collection
+                  
+
+               Within collections there are several types of objects that can be
+               stored. You can store XML documents, XMLObjects and other
+               collections. Each of these objects can also be referenced via a
+               path.
+
+Collection Path Referencing a Document
+
+                  Extending the previous example by adding a document to
+                  my-child-collection named my-document it to could be
+                  referenced via a path.
+               
++  /db/my-collection/my-child-collection/my-document
+                  
+
+               There is one catch to this however. Since you can have more then one
+               object in a collection with the same name
+               there is an order of precedence that is applied when evaluating a
+               path. The order of precendence is collection followed by XMLObject
+               and then document. What this means is that if you have a document
+               and a collection with the same name you will not be able to retrieve
+               the document.
+            
+
+               You can also access collections on remote machines by specifying the host
+               and port of the server.
+            
+
+Collection Path Referencing a remote Document
+
+                  If the previous example was on a remote machine the path would look
+                  something like this.
+               
++  myhost.domain.com:8080/db/my-collection/my-child-collection/my-document
+                  
+
+                  This can also take the form of a Xindice URI.
+               
++  xindice://myhost.domain.com:8080/db/my-collection/my-child-collection/my-document
+                  
+
+Introducing the Command Line Tools
+
+               The Xindice server includes a command line program named
+               xindice that allows you to manage the
+               data stored in the server.
+               A complete list of available commands and more
+               detail about each command can be found in the
+               Command Line Tools Reference Guide.
+            
+
+               The
+               xindice tool is located in the
+               Xindice-Core/bin directory and it is
+               probably a good idea to add this directory to your PATH environment
+               variable. All examples in this manual will assume that the
+               Xindice-Core/bin directory is on the operating system path.
+            
+
+      
+
+Managing Documents
+
+
+Introduction
+
+               In many ways the Xindice database can be viewed as a simple file
+               store. This is of course a highly simplified view of things but
+               is a useful place to get started in learning the functionality of
+               the server.
+            
+
+               The Xindice server provides facilities to store, retrieve and
+               delete well formed XML documents.
+            
+
+Adding Documents
+
+
+Adding a Document With a Given Key
+
+                  The document fx102.xml will be added to the collection
+                  /db/data/products and will be stored under the key fx102.
+               
++  xindice add_document -c /db/data/products -f fx102.xml -n fx102
+                  
+
+Adding a Document Without a Key
+
+                  The document fx102.xml will be added to the collection
+                  /db/data/products. No key is provided so one will be generated
+                  automatically by the server. The generated key will look similar
+                  to this 0625df6b0001a5d4000bc49d0060b6f5
+               
++  xindice add_document -c /db/data/products -f fx102.xml
+                  
+
+Retrieving Documents
+
+               Documents can be retrieved from the database using the ID that
+               they were inserted under.
+            
+
+Retrieving a Document Using an ID
+
+                  The document identified by the key fx102 will be retrieved from
+                  the /db/data/products collection and stored in the file fx102.xml
+               
++  xindice retrieve_document -c /db/data/products -n fx102 -f fx102.xml
+                  
+
+Deleting Documents
+
+
+Deleting a document using an ID
+
+                  The document identified by the key fx102 will be removed from the
+                  collection /db/data/products.
+               
++  xindice delete_document -c /db/data/products -n fx102
+                  
+
+      
+
+Querying the Database
+
+
+            Xindice currently supports XPath as a query language. In many
+            applications XPath is only applied at the document level but in
+            Xindice XPath queries can be executed at either the document level
+            or the collection level. This
+            means that a query can be run against multiple documents and the
+            result set will contain all matching nodes from all documents
+            in the collection.
+            The Xindice server also supports the creation of indexes on
+            XML documents to speed up commonly used XPath queries. Please refer
+            to the
+            Administrators
+               Guide for more detail about configuring indexes.
+         
+
+            You can execute XPath queries against the database using the command
+            line tools and the result of the query will be displayed.
+         
+
+Executing an XPath query against a collection of XML documents
+
+               Here we assume we have a collection /db/data/products that contains
+               documents that are similar to the following.
+            
++  <?xml version="1.0"?>
+  <product product_id="120320">
+    <description>Glazed Ham</description>
+  </product>
+            
+
+               The XPath /product[@product_id="120320"] will be executed against
+               the collection /db/data/products and all matching product entries
+               will be returned.
+            
++  xindice xpath_query -c /db/data/products -q "/product[@product_id='120320']"
+            
+
+               The result of the query is an XPath node-set that contains one
+               node for each result. In this particular example there is only
+               one result and the node that matches is the root element so you
+               get back basically the whole document.
+            
+
+               To make it easy to link the result node back to the originating
+               document, Xindice adds a few attributes to the result. These attributes
+               are added in the Query namespace that has the URI
+               http://xml.apache.org/xindice/Query. The
+               col attribute specifies the collection where the document
+               can be found and the key attribute
+               provides the key of the original document. Using this information it
+               is possible to retrieve the original document that this node was
+               selected from for further processing.
+            
++  <product product_id="120320"
+           xmlns:src="http://xml.apache.org/xindice/Query"
+           src:col="/db/data/products" src:key="120320">
+    <description>Glazed Ham</description>
+  </product>
+            
+
+               If more then one result is found the results look something like
+               this. This could be the result of the query /product
+            
++  <product product_id="120320"
+           xmlns:src="http://xml.apache.org/xindice/Query"
+           src:col="/db/data/products" src:key="120320">
+    <description>Glazed Ham</description>
+  </product>
+  <product product_id="120321"
+           xmlns:src="http://xml.apache.org/xindice/Query"
+           src:col="/db/data/products" src:key="120321">
+    <description>Boiled Ham</description>
+  </product>
+  <product product_id="120322"
+           xmlns:src="http://xml.apache.org/xindice/Query"
+           src:col="/db/data/products" src:key="120322">
+    <description>Honey Ham</description>
+  </product>
+            
+
+            While it is certainly useful to be able to query from the command
+            line it is  probably more useful to be able to use the results of a
+            query in an application. For more information on building
+            applications for Xindice, please refer to the
+            Developers Guide.
+         
+
+
+      
+   
+
+by Kimbro Staken
+
+
+          version 598114
+
+
+ 
+
+
+
+
+
+
+
+        Copyright ©
+         2001-2007 The Apache Software Foundation.
+
+
+
+

Propchange: xml/site/targets/xindice/1.1/guide-user.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.1/guide-user.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.1/guide-user.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-user.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.1/guide-user.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

svn commit: r602294 [2/10] - in /xml/site/targets/xindice: ./ 1.0/ 1.1/ 1.1/howto/ 1.2/ 1.2/howto/ dev/ skin/ skin/images/

2007-12-08T02:01:42Z

Added: xml/site/targets/xindice/1.1/guide-developer.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-developer.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/guide-developer.html (added)
+++ xml/site/targets/xindice/1.1/guide-developer.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,1729 @@
+
+
+
+
+
+
+
+Xindice 1.1 Developer Guide
+
+
+
+
+
+
+
+
+
+
+
+
+apache > xml.apache > xindice
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+                    
+
+
+
+
+
+
+Home
+
+
+1.0
+
+
+1.1
+
+
+1.2-Dev
+
+
+Dev
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+              
+           
+
+
+
+Overview
+
+
+Overview
+
+
+Documentation
+
+
+Administrator Guide
+
+
+User Guide
+
+
+Developer Guide
+
+
+Tool Guide
+
+
+XPath Guide
+
+
+FAQ
+
+
+Wiki
+
+
+Javadocs
+
+
+How-Tos
+
+
+Overview
+
+Compilation
+
+
+Unix
+
+
+Windows
+
+
+Installation
+
+
+Tomcat How-to
+
+
+Upgrading
+
+
+From 1.1b1 and up
+
+
+From 1.0
+
+
+
+Resources
+
+
+Wiki
+
+
+XML:DB Initiative
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+        PDF
+
+Xindice 1.1 Developer Guide
+
+
+
+Introduction to Programming Xindice
+
+
+Accessing the Server
+
+
+API's
+
+
+
+
+Introducing the XML:DB XML Database API
+
+
+Setting up Your Build Environment
+
+
+Preparing the Server For the Examples
+
+
+Diving in With an Example Program
+
+
+Simple XML:DB Example Program
+
+
+
+
+Accessing Xindice Remotely
+
+
+
+
+Managing Documents
+
+
+Creating a Collection
+
+
+Creating a Collection
+
+
+
+
+Working with Documents
+
+
+Example Document
+
+
+Adding an XML File to the Database
+
+
+Retrieving an XML Document from the Database
+
+
+Deleting an XML Document from the Database
+
+
+
+
+
+
+Using XPath to Query the Database
+
+
+Introduction
+
+
+Using the XML:DB Java API
+
+
+Querying with XPath
+
+
+
+
+
+
+Using XUpdate to Modify the Database
+
+
+Introduction
+
+
+Basic XUpdate Insert Command
+
+
+
+
+XUpdate Commands
+
+
+XUpdate Node Construction
+
+
+Using the XML:DB API for XUpdate
+
+
+Using XUpdate to modify the database
+
+
+
+
+
+
+Storing metadata
+
+
+Enabling metadata
+
+
+Using metadata
+
+
+Sample metadata code
+
+
+
+
+Example Application
+
+
+Address Book
+
+
+
+
+Experimental Features
+
+
+
+    
+
+Note
+
+      If you notice incorrectness in this documentation, please
+      notify Xindice community. Your feedback
+      will help create better documentation.
+    
+
+    
+
+Introduction to Programming Xindice
+
+
+Accessing the Server
+
+          The Xindice server can be accessed either programmatically through
+          the server's APIs, or from the command line using the provided
+          command line tools. This document covers programmatic access,
+          for more information on using the command line interface please
+          refer to the Xindice Users Guide.
+        
+
+API's
+
+            Xindice currently offers three layers of APIs that can be used to
+            develop applications.
+          
+
+            
+
+               
+XML:DB XML Database API used to develop
+               Xindice applications in Java. This is the primary API used to
+               develop applications and it will be given the most coverage in
+               this manual. Xindice provides two implementations of the XML:DB
+               API. One is built on top of the Xindice XML-RPC API, and another
+               embeds Xindice within the same JVM. Xindice currently implements
+               the May 07, 2001 draft of the XML:DB API. This API will change
+               slightly in the future to track the development of the XML:DB API.
+            
+            
+
+               
+Xindice XML-RPC API used when accessing Xindice
+               from a language other then Java. The XML-RPC API is built on top
+               of the Core Server API. XML-RPC implementation is provided by
+               Apache Web Services Project.
+            
+            
+
+               Core Server API is the internal Java API of the core
+               database engine. This API is used to build the XML-RPC API and
+               embedded XML:DB API. This is the lowest level API and is only
+               available to software running in the same Java VM as the
+               database engine itself.
+            
+          
+
+
+          The most common API for end user applications is the XML:DB XML
+          Database API that was developed by the
+          XML:DB Initiative.
+          This API is a vendor neutral API intended to make it possible to build
+          applications that will work with more then one XML database
+          without too much difficulty. This is similar to the capabilities
+          provided by JDBC for relational databases. More information about this
+          API can be found on the XML:DB Initiative web site,
+          http://xmldb-org.sourceforge.net. Most
+          programming examples in this manual will use the XML:DB API. The
+          Xindice implementation of the API is a Core Level 1 implementation.
+        
+
+          The Xindice server also exposes a XML-RPC API that is used to
+          implement the XML:DB API. The XML-RPC API will mainly be of
+          interest to those who want to access Xindice from a language other
+          then Java. Any language that supports a XML-RPC should be
+          able to utilize the services of the Xindice server via the XML-RPC
+          API. This document does not cover development with the XML-RPC API
+          as the XML:DB API is the preferred mechanism for developing Xindice
+          applications. If you are developing applications in Java you can
+          safely ignore the existence of this API. The XML-RPC API will be
+          covered in a seperate document to be written at a later time.
+        
+
+          The final API for Xindice is the Core Server API.
+        
+
+Introducing the XML:DB XML Database API
+
+          XML:DB API is being developed by the
+          XML:DB Initiative to
+          facilitate the development of applications that function with
+          minimal change on more then one XML database. This is roughly
+          equivalent to the functionality provided by JDBC or ODBC for
+          providing access to relational databases. Xindice provides an
+          implementation of the XML:DB API that also serves as the primary
+          programming API for Xindice.
+        
+
+          The XML:DB API is based around the concept of collections that store
+          resources. A resource can be an XML Document, a binary blob or
+          some type that is not currently defined. Collections can be arranged
+          in a hierarchical fashion. This makes the architecture very similar
+          to that of a typical Windows or UNIX file system. What is different
+          however, is that collections also expose services that allow you to
+          do things such as query XML documents using XPath or update resources in a
+          transactionally secure manner.
+        
+
+          The XML:DB API defines several levels of interoperability called
+          Core Levels in XML:DB terminology. The Xindice implementation of the
+          API is a complete Core Level 1 implementation plus implementations of
+          some of the optional services.
+        
+
+          Required Core 1 services supported by Xindice include.
+        
+
+          
+
+            
+XPathQueryService - Enables execution of XPath
+            queries against the database.
+          
+        
+
+
+          Optional Core 1 services supported by Xindice include.
+        
+
+          
+
+            
+XUpdateQueryService - Enables execution of XUpdate
+            queries against the database.
+          
+          
+
+            
+CollectionManagementService - Provides basic
+            facilities to create and remove collections.
+          
+        
+
+
+          In addition to Core Level 1 support the Xindice implementation also
+          supports a few added services that are specific to Xindice. These
+          services exist because the functionality is necessary to fully
+          utilize all the capabilities provided by Xindice. However, they are
+          proprietary to Xindice and will not function unchanged on other XML
+          databases.
+        
+
+          The following services are currently provided by Xindice and are not
+          part of the common XML:DB API.
+        
+
+          
+
+            
+DatabaseInstanceManager - Provides the ability to
+            control the operation of the server programatically.
+          
+          
+
+            
+CollectionManager - Provides the ability to create
+            and configure collection instances within the server. This is a
+            much more functional version of CollectionManagementService
+            that will only work with Xindice.
+          
+        
+
+
+          While this guide aims to provide some useful examples and to guide
+          you in the process of getting to know how to program Xindice it is
+          also useful to know that there is a good source of example code within
+          the server it self. The Xindice command line tools are built 100% on
+          the XML:DB API and provide a pretty comprehensive set of examples in
+          how to use the API. This is especially true when it comes to the Xindice
+          specific services that are included with the server. The source code
+          for all the command line tools can be found in
+          xindice/java/src/org/apache/xindice/tools/command.
+        
+
+Setting up Your Build Environment
+
+          Before you can build applications for Xindice you need to make sure you
+          have your build environment properly setup. This mainly consists of
+          making sure that you have the proper VM version and a properly
+          configured CLASSPATH.
+        
+
+          To build applications for Xindice you can use JDK 1.3 or 1.4. JDK 1.2
+          and below will not work. If you have more than one Java VM installed
+          make sure that your JAVA_HOME environment variable and
+          PATH environment variable both include the correct path.
+        
+
+          Once you have your Java VM properly configured you need to add a few
+          jar files to your CLASSPATH. The following list of
+          jars are required and should be made available on your
+          CLASSPATH. All required jars can be found in
+          xindice/java/lib
+        
+
+
+          
+
+            
+xindice.jar - contains the main Xindice classes
+            that are used by the client API.
+          
+          
+
+             
+xmldb-common.jar, xmldb-api.jar,
+             xmldb-api-sdk.jar, xmldb-xupdate.jar
+             - contain implementations of the XML:DB API and XUpdate API.
+          
+          
+
+             
+xml-apis.jar - contains Java XML APIs.
+          
+          
+
+             
+xerces.jar - contains the Xerces XML parser.
+          
+          
+
+             
+xalan.jar - contains the Xalan XSLT engine.
+          
+          
+
+             
+commons-logging.jar - contains the Jakarta Commons
+             Logging package.
+          
+        
+
+
+Preparing the Server For the Examples
+
+          Before we get to some example code, we need to do a little work to setup the
+          server. Don't worry nothing hard.
+        
+
+          First we need to make sure the addressbook collection exists. If you followed
+          the install instructions completely you should have already created this,
+          but if not you should do so now. To find out if the collection exists you
+          can run:
+        
+  xindice lc -c /db  
+
+          If you don't see 'addressbook' listed in the result then you need to create
+          the collection. To create it just run:
+        
+  xindice ac -c /db -n addressbook  
+
+          Now that we have the collection, we can add a few example documents
+          so that we have something to play with. You can find the examples in your
+          Xindice installation in the directory
+          java/examples/guide/xml. Run these commands to add
+          the documents.
+        
++  cd $XINDICE_HOME/java/examples/guide/xml
+  xindice ad -c /db/addressbook -f address1.xml -n address1
+  xindice ad -c /db/addressbook -f address2.xml -n address2
+        
+
+          If you're on Windows you'll need to adjust the path in the cd command
+          for your platform. Most of the examples in the manual will be written for
+          UNIX but will work fine in Windows if you just replace / with \ and
+          $XINDICE_HOME with %XINDICE_HOME%.
+        
+
+          That wasn't so bad and now we're set to look at some example code.
+        
+
+Diving in With an Example Program
+
+Simple XML:DB Example Program
+
+            This example simply executes an XPath query against a
+            collection, retrieves the results as text and prints them out.
+          
+
+            You can find the source code for this example in
+            Xindice/java/examples/guide/src/org/apache/xindice/examples/Example1.java
+          
++package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+public class Example1 {
+
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+
+    String uri = "xmldb:xindice:///db/addressbook";
+    col = DatabaseManager.getCollection(uri);
+
+    String xpath = "//person[fname='John']";
+    XPathQueryService service =
+      (XPathQueryService) col.getService("XPathQueryService", "1.0");
+    ResourceSet resultSet = service.query(xpath);
+    ResourceIterator results = resultSet.getIterator();
+    while (results.hasMoreResources()) {
+      Resource res = results.nextResource();
+      System.out.println((String) res.getContent());
+    }
+  } catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  } finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+
+}
+          
+
+          Before diving into the gory detail of what this program is doing, let's
+          run it and see what we get back.
+        
+
+          If you have a binary build of Xindice the examples are already built
+          and you can run this example by typing.
+        
++  cd $XINDICE_HOME/java/examples/guide
+  ./run org.apache.xindice.examples.Example1
+        
+
+          If all goes well, you should see a result that looks something like this.
+        
+<?xml version="1.0"?>
+<person xmlns:src="http://xml.apache.org/xindice/Query"
+        src:col="/db/addressbook" src:key="address1">
+  <fname>John</fname>
+  <lname>Smith</lname>
+  <phone type="work">563-456-7890</phone>
+  <phone type="home">534-567-8901</phone>
+  <email type="home">jsmith@somemail.com</email>
+  <email type="work">john@lovesushi.com</email>
+  <address type="home">34 S. Colon St.</address>
+  <address type="work">9967 W. Shrimp Ave.</address>
+</person>
+        
+
+          Now that we've seen the result, let's dive in and look at the code in
+          detail. While this isn't the simplest possible example program to start
+          with it does a nice job of showing all the basic techniques used when
+          building applications with the XML:DB API.
+        
+
+          To begin the program imports several XML:DB packages.
+        
++  import org.xmldb.api.base.*;
+  import org.xmldb.api.modules.*;
+  import org.xmldb.api.*;
+        
+
+          These import the basic classes required by the API.
+          import org.xmldb.api.base.*; is the base API module
+          and is required for all XML:DB applications.
+          import org.xmldb.api.*; imports the all
+          important DatabaseManager class which is the
+          entry point into the API.
+          import org.xmldb.api.modules.*; brings in the
+          optional modules defined for the API. In this case the module we're
+          interested in is XPathQueryService.
+        
+
+          Before we can use the API we need to create and register the
+          database driver we want to use. In this case since we're writing for
+          Xindice we use org.apache.xindice.client.xmldb.DatabaseImpl
+          for our driver and register it with the DatabaseManager
+        
+
++String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+Class c = Class.forName(driver);
+
+Database database = (Database) c.newInstance();
+DatabaseManager.registerDatabase(database);
+        
+
+          Now that our driver is registered we're ready to retrieve the
+          collection that we want to work with.
+        
++String uri = "xmldb:xindice:///db/addressbook";
+Collection col =
+  DatabaseManager.getCollection(uri);
+        
+
+          In the XML:DB API collections are retrieved by calling
+          getCollection and handing it a URI that specifies the
+          collection we want. The format of this URI will vary depending on
+          the database implementation being used but will always begin with
+          xmldb: and be followed by a database specific database
+          name, xindice: in the case of Xindice.
+        
+
+          The rest of the URI is a path used to locate the collection you want
+          to work with. This path begins with the name of the root collection
+          for the Xindice instance that you are trying to connect with. All
+          Xindice instances must have a unique name for the root collection. The
+          reason for this is that the name of the root collection is also the
+          name of the database instance and that name is what the Xindice server
+          uses to register itself with the naming service. In all examples in
+          this guide the root collection is called db. This
+          is the default name used for a newly installed instance of Xindice. If
+          you have more then one instance of Xindice running that you must be
+          sure to change the names on all other instances so that they are
+          unique.
+          Once you do this you can switch between the instances by simply
+          changing the first component of the path.
+        
++  xindice:///db/news
+  xindice:///db2/news
+        
+
+          These paths will switch between a Xindice server with a root collection
+          of db and one of db2. These instances could be on the same machine or
+          on two completely different machines and to your application there is
+          no significant difference.
+        
+
+          After the root collection name the rest of the URI simply consists of
+          the path to locate the collection you want to work with.
+        
+
+          Now that we have a reference to the collection that we want to work
+          with we need to get a reference to the XPathQueryService
+          service for that collection.
+        
++String xpath = "//person[fname='John']";
+XPathQueryService service =
+(XPathQueryService) col.getService("XPathQueryService", "1.0");
+ResourceSet resultSet = service.query(xpath);
+        
+
+          Services provide a way to extend the functionality of the XML:DB
+          API as well as enabling the definition of optional functionality.
+          In this case the XPathQueryService is an optional
+          part of Core Level 0 but is a required part of Core Level 1.
+          Since Xindice provides a Core Level 1 XML:DB API implementation the
+          XPathQueryService is available.
+        
+
+          To retrieve a service you must know the name of the service that
+          you want as well as the version. Services define their own custom
+          interfaces so you must cast the result of the getService() call to
+          the appropriate service type before you can call its methods. The
+          XPathQueryService defines a method
+          query() that takes an XPath string as an argument.
+          Different services will define different sets of methods.
+        
+
+          Now that we have an XPathQueryService reference
+          and have called the query() method we get a
+          ResourceSet containing the results. Since we just
+          want to print out the results of the query, we need to get an
+          iterator for our results and then use it to print out the results.
+        
++ResourceIterator results = resultSet.getIterator();
+while (results.hasMoreResources()) {
+    Resource res = results.nextResource();
+    System.out.println((String) res.getContent());
+}
+        
+
+          Resources are another important concept within the XML:DB API. Since
+          XML can be accessed with multiple APIs and since an XML database
+          could potentialy store more the one type of data, resources provide
+          an abstract way to access the data in the database. The Xindice
+          implementation only supports XMLResource but other vendors may
+          support additional resource types as well.
+        
+
+          XMLResource provides access to the underlying XML data as either
+          text, a DOM Node or via SAX ContentHandlers. In our example we're
+          simply working with the content as text but we could just as easily
+          have called getContentAsDom() to get the content
+          as a DOM Node. Since we just want to print the XML out to the screen
+          it is easier to just work with text.
+        
+
+          The final element about our example program worth noting is the
+          finally clause.
+        
++finally {
+    if (col != null) {
+        col.close();
+    }
+}
+        
+
+          The finally clause closes the collection that we created earlier.
+          This is vitally important and should never be overlooked. Closing
+          the collection releases all the resources consumed by the
+          collection. In the Xindice implementation this will make sure that the
+          CORBA resources are released properly. Failure to properly call
+          close on the collection will result in a
+          resource leak within the server.
+        
+
+Accessing Xindice Remotely
+
+          By default Xindice assumes that the client and server are running on
+          the same machine, and the server is running on port 8888. In most
+          configurations this will not be the case so it will be necessary to
+          include the hostname and port of the server where Xindice is running
+          in your URIs. The port you use is the port that the servlet engine is
+          listening on. The port setting configuration depends on the servlet
+          engine you use. Xindice comes pre-configured with the Jetty servlet
+          engine running on port 8888, so URL used by default is
+          xmldb:xindice://localhost:8888.
+          To access the collection /db/addressbook on host xml.apache.org port
+          8000 the URI would look something like this
+          xmldb:xindice://xml.apache.org:8000/db/addressbook. All
+          examples in this document assume that server uses default configuration.
+        
+
+          If you are having problems accessing Xindice remotely this may be the
+          result of the Xindice deployment in the non-standard servlet context
+          name. Xindice assumes that the server will be deployed under
+          /xindice servlet context. To do this, you just need to rename
+          Xindice WAR file to xindice.war, and deploy this renamed WAR
+          file. Alternatively, you need to specify system property
+          xindice.xmlrpc.service-location, or set property
+          service-location on the Database XML:DB object
+          right after its creation.
+        
+
+    
+
+Managing Documents
+
+
+        In this chapter we'll look at using the XML:DB API to manage documents
+        within the Xindice server. As part of this we'll look at some sample code
+        that could be used to manage the data used by the AddressBook example
+        application included with the server and discussed in more detail later.
+      
+
+        When looking at managing documents with the XML:DB API the first thing
+        we need to confront is that the API doesn't actually work directly with
+        documents. It works with what the API calls resources that are an
+        abstraction of a document. This abstraction allows you to work with the same
+        document as either text, a DOM tree or SAX events. This is important to
+        understand as the use of resources runs as a common thread throughout the
+        XML:DB API. The XML:DB API actually defines more then one type of resource
+        however Xindice does not implement anything beyond XMLResource.
+      
+
+Creating a Collection
+
+          Before we can work with any data in the database we need to create
+          a collection to hold our data.
+          While we could easily create this collection using the command line
+          tools it will be more fun to see how you might do this from your own
+          program. This will also show you a quick example of using the Xindice
+          specific CollectionManager service to manage
+          collections. This guide doesn't go into detail about using this
+          service but you can find lots of examples by looking at the source
+          code to the command line tool commands in the package
+          org/apache/xindice/tools/commands.
+        
+
+          The collection we want to create will be named
+          mycollection and will be a child of the root
+          collection.
+        
+
+Creating a Collection
++package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+// For the Xindice specific CollectionManager service
+import org.apache.xindice.client.xmldb.services.*;
+
+import org.apache.xindice.xml.dom.*;
+
+public class CreateCollection {
+
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    String uri = "xmldb:xindice:///db/";
+    col =
+      DatabaseManager.getCollection(uri);
+
+    String collectionName = "mycollection";
+    CollectionManager service =
+      (CollectionManager) col.getService("CollectionManager", "1.0");
+
+    // Build up the Collection XML configuration.
+    String collectionConfig =
+      "<collection compressed=\"true\" " +
+      "            name=\"" + collectionName + "\">" +
+      "   <filer class=\"org.apache.xindice.core.filer.BTreeFiler\"/>" +
+      "</collection>";
+
+    service.createCollection(collectionName,
+      DOMParser.toDocument(collectionConfig));
+
+    System.out.println("Collection " + collectionName + " created.");
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+          
+
+          With this example you can see a basic example of how to create the
+          CollectionManager service and use it to create
+          the collection. This service is proprietary to Xindice so if you use
+          it in your application you will not be able to port it to another
+          server. However, if you have the need to create collections within
+          your programs this is currently the most powerful way to do it.
+        
+
+          The trickiest part of creating a collection is creating the
+          proper XML configuration to hand to the
+          createCollection method. This XML
+          is the exact same thing that is placed into the system.xml file.
+          At this time these XML configurations are not documented so to
+          see what they need to be you should look for examples in system.xml
+          and the source code for the command line tools. Future versions of
+          this documentation will cover this area in more detail.
+        
+
+Working with Documents
+
+          Now that we have a collection to store our data, we need to add
+          some data to it. We could use the command line tools
+          to do this but since we want to learn how the XML:DB API works we'll
+          look at how we can do this in a program that we write.
+        
+
+          For our examples in this chapter we'll work with some very simple
+          XML files that could be used to represent a person in an
+          address book. Later in the guide we'll look at an example
+          application that implements the actual address book functionality.
+          Each address book entry is stored in a seperate XML file.
+        
+
+Example Document
++  <person>
+    <fname>John</fname>
+    <lname>Smith</lname>
+    <phone type="work">563-456-7890</phone>
+    <phone type="home">534-567-8901</phone>
+    <email type="home">jsmith@somemail.com</email>
+    <email type="work">john@lovesushi.com</email>
+    <address type="home">34 S. Colon St.</address>
+    <address type="work">9967 W. Shrimp Ave.</address>
+  </person>
+          
+
+          If we store this example XML into a file we can then load it into
+          our addressbook collection using a simple program.
+        
+
+Adding an XML File to the Database
++package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+import java.io.*;
+
+public class AddDocument {
+
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    String data = readFileFromDisk(args[0]);
+
+    XMLResource document =
+      (XMLResource) col.createResource(null, "XMLResource");
+    document.setContent(data);
+    col.storeResource(document);
+    System.out.println("Document " + args[0] + " inserted");
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+
+public static String readFileFromDisk(String fileName) throws Exception {
+  File file = new File(fileName);
+  FileInputStream insr = new FileInputStream(file);
+
+  byte[] fileBuffer = new byte[(int)file.length()];
+
+  insr.read(fileBuffer);
+  insr.close();
+
+  return new String(fileBuffer);
+}
+}
+          
+
+          Much of this program is similar to what we've already seen in our
+          other XML:DB programs. Really the only difference is the code to add
+          the document.
+        
+
+          Documents are added to the server by first creating a new resource
+          implementation from a collection,
+          setting its content and then storing the resource to the collection.
+          The type of resource that is created is an XMLResource this can be
+          used to store XML as either text, a DOM Node or a SAX
+          ContentHandler.
+        
+
+          If you had your content already in a DOM tree you could also add
+          the document as a DOM.
+        
++XMLResource document = (XMLResource) col.createResource(null, "XMLResource");
+document.setContentAsDOM(doc); // doc is a DOM document
+col.storeResource(document);
+        
+
+          The only difference here is that you must have the document as a DOM
+          Document already and then call setContentAsDOM(). From
+          there the resource works the same as always.
+        
+
+          One thing to note is that a resource must be stored in the same
+          collection from which it was originally created.
+        
+
+Retrieving an XML Document from the Database
++package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+import java.io.*;
+
+public class RetrieveDocument {
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    XMLResource document = (XMLResource) col.getResource(args[0]);
+    if (document != null) {
+      System.out.println("Document " + args[0]);
+      System.out.println(document.getContent());
+    }
+    else {
+      System.out.println("Document not found");
+    }
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+          
+
+Deleting an XML Document from the Database
++package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+import java.io.*;
+
+public class DeleteDocument {
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    Resource document = col.getResource(args[0]);
+    col.removeResource(document);
+    System.out.println("Document " + args[0] + " removed");
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+          
+
+    
+
+Using XPath to Query the Database
+
+
+Introduction
+
+          Xindice currently supports XPath as a query language. In many
+          applications XPath is only applied at the document level but in
+          Xindice XPath queries are executed at the collection level. This
+          means that a query can be run against multiple documents and the
+          result set will contain all matching nodes from all documents
+          in the collection.
+          The Xindice server also support the creation of indexes on
+          particular XPaths to speed up commonly used XPath queries.
+        
+
+Using the XML:DB Java API
+
+          The XML:DB API defines operations for searching single documents as
+          well as collections of XML documents using XPath. These operations
+          are exposed through the XPathQueryService. In order to query single
+          documents you use the queryResource() method and to query
+          an entire collection you use the query() method.
+        
+
+Querying with XPath
+
+            This example simply executes an XPath query against a
+            collection, retrieves the results as text and prints them out.
+          
+
+            You can find the source code for this example in
+            Xindice/java/examples/guide/src/org/apache/xindice/examples/Example1.java
+          
++package org.apache.xindice.examples;
+
+import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+public class Example1 {
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    String xpath = "//person[fname='John']";
+    XPathQueryService service =
+      (XPathQueryService) col.getService("XPathQueryService", "1.0");
+    ResourceSet resultSet = service.query(xpath);
+    ResourceIterator results = resultSet.getIterator();
+    while (results.hasMoreResources()) {
+      Resource res = results.nextResource();
+      System.out.println((String) res.getContent());
+    }
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode);
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+          
+TODO: cover namespace support
+
+    
+
+Using XUpdate to Modify the Database
+
+
+Introduction
+
+          XUpdate is a specification under development by the XML:DB Initiative
+          to enable simpler updating of XML documents. It is useful within the
+          context of an XML database as well as in standalone implementations
+          for general XML applications. XUpdate gives you a declarative method
+          to insert nodes, remove nodes, and change nodes within an XML
+          document. The syntax is specified in the
+          
+          XUpdate working draft available on the XML:DB Initiative website.
+        
+
+          The XUpdate implementation in Xindice is based around the
+          Lexus XUpdate implementation that was developed by the
+          Infozone Group.
+        
+
+          The general model around XUpdate is to use an
+          xupdate:modifications
+          container to batch a series of XUpdate commands. All commands
+          will be performed in series against either a single XML document or
+          an entire collection of XML documents as specified by the developer.
+        
+
+          Execution of XUpdate commands is performed in two phases. First
+          selecting a node set within the document or collection and then
+          applying a change to the selected nodes.
+        
+
+Basic XUpdate Insert Command
++<xupdate:modifications version="1.0"
+  xmlns:xupdate="http://www.xmldb.org/xupdate">
+
+<xupdate:insert-after select="/addresses/address[1]" >
+
+<xupdate:element name="address">
+<xupdate:attribute name="id">2</xupdate:attribute>
+<fullname>John Smith</fullname>
+<born day='2' month='12' year='1974'/>
+<country>Germany</country>
+</xupdate:element>
+
+</xupdate:insert-after>
+</xupdate:modifications>
+          
+
+XUpdate Commands
+
+          
+
+            
+xupdate:insert-before - Inserts a new node in document order before the selected node.
+          
+          
+
+            
+xupdate:insert-after - Inserts a new node in document order after the selected node.
+          
+          
+
+            
+xupdate:update - Replaces all child nodes of the selected node with the specified nodes.
+          
+          
+
+            
+xupdate:append - Appends the specified node to the content of the selected node.
+          
+          
+
+            
+xupdate:remove - Remove the selected node
+          
+          
+
+            
+xupdate:rename - Renames the selected node
+          
+          
+
+            
+xupdate:variable - Defines a variable containing a node list that can be reused in later operations.
+          
+        
+
+
+XUpdate Node Construction
+
+          
+
+            
+xupdate:element - Creates a new element in the document.
+          
+          
+
+            
+xupdate:attribute - Creates a new attribute node
+            associated with an xupdate:element.
+          
+          
+
+            
+xupdate:text - Creates a text content node in the document.
+          
+          
+
+            
+xupdate:processing-instruction - Creates a
+            processing instruction node in the document.
+          
+          
+
+            
+xupdate:comment - Creates a new comment node in the
+            document.
+          
+        
+
+
+Using the XML:DB API for XUpdate
+
+           The XML:DB API provides an XUpdateQueryService to enable executing
+           XUpdate commands against single documents or collections of
+           documents. To update a single document you use the
+           updateResource() method and to apply the updates
+           to an entire collection you use the update() method.
+         
+
+           The next example program applies a set of XUpdate modifications to
+           an entire collection of data. It first removes all elements that
+           match the XPath
+           /person/phone[@type = 'home']
+           and then adds a new entry after all elements that match the XPath
+           /person/phone[@type = 'work']
+         
+
+
+Using XUpdate to modify the database
++import org.xmldb.api.base.*;
+import org.xmldb.api.modules.*;
+import org.xmldb.api.*;
+
+/**
+* Simple XML:DB API example to update the database.
+*/
+public class XUpdate {
+public static void main(String[] args) throws Exception {
+  Collection col = null;
+  try {
+    String driver = "org.apache.xindice.client.xmldb.DatabaseImpl";
+    Class c = Class.forName(driver);
+
+    Database database = (Database) c.newInstance();
+    DatabaseManager.registerDatabase(database);
+    col =
+      DatabaseManager.getCollection("xmldb:xindice:///db/addressbook");
+
+    String xupdate = "<xu:modifications version=\"1.0\"" +
+      "      xmlns:xu=\"http://www.xmldb.org/xupdate\">" +
+      "   <xu:remove select=\"/person/phone[@type = 'home']\"/>" +
+      "   <xu:update select=\"/person/phone[@type = 'work']\">" +
+      "       480-300-3003" +
+      "   </xu:update>" +
+      "</xu:modifications>";
+
+    XUpdateQueryService service =
+      (XUpdateQueryService) col.getService("XUpdateQueryService", "1.0");
+    service.update(xupdate);
+  }
+  catch (XMLDBException e) {
+    System.err.println("XML:DB Exception occured " + e.errorCode + " " +
+    e.getMessage());
+  }
+  finally {
+    if (col != null) {
+      col.close();
+    }
+  }
+}
+}
+           
+
+     
+
+Storing metadata
+
+
+         Xindice allows a developer to store metadata that is associated with
+         any collection or document. Metadata is data that is associated with
+         a document or collection but is not part of that document or collection.
+         For example, a filesystem lists the last modified time of a file or
+         directory. That last modified time is metadata about the file or directory.
+       
+
+         Within Xindice, when metadata is turned on, each document and collection
+         has a MetaData object associated with it. The MetaData object is composed
+         of three sections and is represented in XML like this:
+       
++  <meta>
+    <system type="doc">
+      <attr name="created" value="10128378882" />
+      <attr name="modified" value="10128378882" />
+    </system>
+    <attrs>
+      <attr name="key" value="value"/>
+      <attr name="foo" value="bar"/>
+    </attrs>
+    <custom>
+      <myspecial>
+        any <valid /> xml
+      </myspecial>
+    </custom>
+  </meta>
+       
+
+         The first section is enclosed by the <system> element and is controlled
+         by the core of Xindice.  It currently tracks the type of resource referenced,
+         creation time and last modification time of the resource.  The <system>
+         element has an attribute "type" which is either "doc" for document or "col"
+         for collection.  Within the <system> element are <attr> elements.
+         Each <attr> element has two attributes, name and value.  The creation
+         and modification times are stored in individual <attr> elements.
+         The value of these attributes are recorded as milliseconds since midnight
+         Jan 1, 1970 (just as System.currentTimeMills() ).
+       
+
+         The second section is a map of key-value pairs and is enclosed by the <attrs> element.  Each key-value
+         pair is represented in a single <attr> element.  The key-value pairs are completely controlled by the user.  You
+         can add or remove any key-value pair in this section.  Note that the map is from Object to Object, so you
+         can store any object your application requires.
+       
+
+         The third section is a custom XML document.  This too is completely controlled
+         by the user.  The only prerequisite is that the document stored is well-formed
+         XML.
+       
+
+Enabling metadata
+
+           To turn on metadata storage in Xindice, edit the system.xml configuration
+           file and set the "use-metadata" attribute of the root-collection element to
+           "on".  Restart your container, and metadata storage will be enabled.
+         
+
+           If properly configured, when you restart your container, you will see a
+           log message that looks like this:
+         
++  Dec 30, 2002 10:21:51 AM org.apache.xindice.core.Database setConfig
+  INFO: Meta information initialized
+         
+
+Note
+
+           This example is from the output of Tomcat.  The output from other
+           containers might look different, but the message ("Meta information
+           initialized") should be identical.
+         
+
+
+Using metadata
+
+           How you use metadata is really up to you, the application developer.
+           There are many potential uses depending on your application.  One
+           example is a content management system in which each document has a
+           series of states through which it must pass.  The states might be
+           controlled by a finite state machine, but each document's current
+           state would be stored in the metadata associated with it.
+         
+
+Sample metadata code
+
+           Currently the metadata accessors are implemented as non-standard meta
+           information service which can be obtained via XML:DB API (name
+           "MetaService", version "1.0"), and it also available via the XML-RPC code.
+         
+
+           The Xindice XML-RPC server has four metadata related methods:
+           GetCollectionMeta, GetDocumentMeta, SetCollectionMeta, SetDocumentMeta.
+           Here's quick perl script which creates a collection and then dumps out
+           its metadata contents, and then sets some values inside the metadata.
+         
++#!/usr/local/bin/perl -w
+
+use strict;
+use Frontier::Client;
+use Data::Dumper;
+
+my($server,$result,$url);
+
+$url = 'http://localhost:8888/xindice';
+$server = Frontier::Client->new('url'=>$url,'debug'=>0);
+
+## try listing the collections
+## look at org/apache/xindice/server/rpc/messages/*.java
+## for the 'message' possibilities.  The parameters are there as well.
+
+my $colname = 'ninemetatest';
+my $args = {};
+
+#first, add the collection directly under the /db root.
+$args->{'message'} = 'CreateCollection';
+$args->{'collection'} = '/db';
+$args->{'name'} = $colname;
+$result = $server->call('run',$args);
+
+## now get the collection's meta
+$args = {};
+$args->{'message'} = 'GetCollectionMeta';
+$args->{'collection'} = '/db/'.$colname;
+$result = $server->call('run',$args);
+
+## this should print out the xml for the
+## collection's metadata.
+print Dumper($result);
+
+
+## now add some stuff to the metadata
+my $meta=<<EOF;
+<?xml version="1.0"?>
+    <meta>
+        <!-- since the system is controlled by
+          Xindice, this doesn't matter...
+        -->
+        <system type="col">
+            <attr name="created" value="1" />
+            <attr name="modified" value="5" />
+        </system>
+        <attrs>
+            <attr name="test" value="added" />
+        </attrs>
+        <custom>
+              <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+                  <test>the rdf example</test>
+              </rdf:RDF>
+        </custom>
+    </meta>
+EOF
+$args = {};
+$args->{'message'} = 'SetCollectionMeta';
+$args->{'collection'} = '/db/'.$colname;
+$args->{'meta'} = $meta;
+$result = $server->call('run',$args);
+
+## this should print out the xml for the
+## collection's revised metadata.
+print Dumper($result);
+         
+
+Fixme (dviner)
+
+         Make this example java instead of perl.
+       
+
+
+Note
+Metadata is currently only exposed in the XML-RPC accessor.
+
+
+    
+
+Example Application
+
+
+Address Book
+
+          The address book example is a simple servlet based application
+          constructued using Xindice. For more information on this example look
+          in the Xindice/java/examples/addressbook directory.
+        
+
+          TODO: Add more detail about building servlet applications.
+        
+
+
+    
+
+Experimental Features
+
+
+        There are a couple of features in Xindice that are definitely
+        experimental. These features can be interesing to explore to see some
+        things that could be useful in future versions of Xindice but they should
+        not be considered complete or stable.
+      
+
+  
+
+by Kimbro Staken, Dave Viner
+
+
+          version 598114
+
+
+ 
+
+
+
+
+
+
+
+        Copyright ©
+         2001-2007 The Apache Software Foundation.
+
+
+
+

Propchange: xml/site/targets/xindice/1.1/guide-developer.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.1/guide-developer.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.1/guide-developer.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-developer.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.1/guide-developer.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org

+ Xalan-Java 1 is no longer supported. +
+Please see Xalan-Java 2 instead for the latest Java XSLT processor. +Alternately, please see Xalan-C++ if you want a C version of the XSLT processor for multiple platforms. +

Action:	+ add_collection +
Abberviated-Action:	+ ac +
Access Level:	Admin

Action:	+ delete_collection +
Abberviated-Action:	+ dc +
Access Level:	Admin

Action:	+ list_collections +
Abberviated-Action:	+ lc +
Access Level:	User

Action:	+ add_document +
Abberviated-Action:	+ ad +
Access Level:	User

Action:	+ add_multiple_documents +
Abberviated-Action:	+ addmultiple +
Access Level:	User

Action:	+ delete_document +
Abberviated-Action:	+ dd +
Access Level:	User

Action:	+ retrieve_document +
Abberviated-Action:	+ rd +
Access Level:	User

Action:	+ import +
Abberviated-Action:	+ import +
Access Level:	Admin

Action:	+ export +
Abberviated-Action:	+ export +
Access Level:	User

Action:	+ add_indexer +
Abberviated-Action:	+ ai +
Access Level:	Admin

Action:	+ delete_indexer +
Abberviated-Action:	+ di +
Access Level:	Admin

Action:	+ list_indexers +
Abberviated-Action:	+ li +
Access Level:	Admin

Action:	+ xpath +
Abberviated-Action:	+ xpath +
Access Level:	User

Action:	+ shutdown +
Abberviated-Action:	+ shutdown +
Access Level:	Admin