You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juddi.apache.org by al...@apache.org on 2022/05/15 15:09:52 UTC
[juddi] branch feature/JUDDI-978 created (now fde14da9b)
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a change to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
at fde14da9b [JUDDI-978] [JUDDI-1020]
This branch includes the following new commits:
new a93f5b942 JUDDI-978 starting conversion process from docbook to maven pdf plugin. Distriubtion zips need to be updated, unlikely that this commit will build to completion
new 8801b6380 Merge branch 'master' into feature/JUDDI-978
new 47accac9a JUDDI-978 resolves merge issues
new 25a86acae Merge branch 'master' into feature/JUDDI-978
new 1ae04582f JUDDI-978 adds maven site (html) and pdf plugin generation to the build
new 578ecfdbb Merge branch 'master' into feature/JUDDI-978
new b5d853881 Merge branch 'master' into feature/JUDDI-978
new fde14da9b [JUDDI-978] [JUDDI-1020]
The 8 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org
[juddi] 03/08: JUDDI-978 resolves merge issues
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a commit to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
commit 47accac9ad450f77294bef3b25f3543bc3f7f6d2
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Mon Jan 20 16:40:09 2020 -0500
JUDDI-978 resolves merge issues
---
docs/pom.xml | 1 -
juddiv3-war/pom.xml | 6 +-----
2 files changed, 1 insertion(+), 6 deletions(-)
diff --git a/docs/pom.xml b/docs/pom.xml
index cb36abb80..3cf17af98 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -22,7 +22,6 @@
<modules>
- <module>asciidoc</module>
<module>dist</module>
</modules>
</project>
diff --git a/juddiv3-war/pom.xml b/juddiv3-war/pom.xml
index 810f80c3a..405929861 100644
--- a/juddiv3-war/pom.xml
+++ b/juddiv3-war/pom.xml
@@ -328,11 +328,7 @@ language governing permissions and * limitations under the License. * */ -->
<artifactId>jettison</artifactId>
</dependency>
<!--END added AO 6/8/2013 support for JSON encoding on REST endpoints -->
- <dependency>
- <groupId>org.apache.cxf</groupId>
- <artifactId>cxf-rt-frontend-jaxrs</artifactId>
- <version>${cxf.version}</version>
- </dependency>
+
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http</artifactId>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org
[juddi] 05/08: JUDDI-978 adds maven site (html) and pdf plugin generation to the build
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a commit to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
commit 1ae04582fdaac4ef11351e5e01aa2d1dd03d6814
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Sun Apr 17 13:55:43 2022 -0400
JUDDI-978 adds maven site (html) and pdf plugin generation to the build
---
docs/dist/.gitignore | 6 --
docs/dist/assembly.xml | 72 ----------------
docs/dist/pom.xml | 66 ---------------
juddi-dist/pom.xml | 9 --
pom.xml | 209 +++++++++++++++++++++++++++++++++--------------
uddi-client-dist/pom.xml | 17 +---
6 files changed, 148 insertions(+), 231 deletions(-)
diff --git a/docs/dist/.gitignore b/docs/dist/.gitignore
deleted file mode 100644
index c1a69fdf9..000000000
--- a/docs/dist/.gitignore
+++ /dev/null
@@ -1,6 +0,0 @@
-target
-**/target/*
-**/derby.log
-**/.project
-**/.classpath
-**/.settings/*
diff --git a/docs/dist/assembly.xml b/docs/dist/assembly.xml
deleted file mode 100644
index 4c9b1cc76..000000000
--- a/docs/dist/assembly.xml
+++ /dev/null
@@ -1,72 +0,0 @@
-<!-- * Copyright 2001-2009 The Apache Software Foundation. * * Licensed under
- the Apache License, Version 2.0 (the "License"); * you may not use this file
- except in compliance with the License. * You may obtain a copy of the License
- at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by
- applicable law or agreed to in writing, software * distributed under the
- License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS
- OF ANY KIND, either express or implied. * See the License for the specific
- language governing permissions and * limitations under the License. * */ -->
-
-<assembly>
- <id>docs</id>
- <formats>
- <format>tar.gz</format>
- <format>zip</format>
- </formats>
- <includeBaseDirectory>false</includeBaseDirectory>
- <fileSets>
- <fileSet>
- <directory>${parent.basedir}/db</directory>
- <outputDirectory>db</outputDirectory>
- </fileSet>
- <fileSet>
- <directory>${parent.basedir}/uddi3-specification</directory>
- <includes>
- <include>*.pdf</include>
- <include>*.txt</include>
- </includes>
- <outputDirectory>uddi3-specification</outputDirectory>
- </fileSet>
- </fileSets>
- <dependencySets>
- <!-- The jUDDI documentation -->
- <dependencySet>
- <outputDirectory>docs/juddi-guide</outputDirectory>
- <includes>
- <include>org.apache.juddi.juddi-docs:juddi-guide:jdocbook</include>
- </includes>
- <useProjectArtifact>false</useProjectArtifact>
- <useProjectAttachments>false</useProjectAttachments>
- <useTransitiveDependencies>false</useTransitiveDependencies>
- <useTransitiveFiltering>false</useTransitiveFiltering>
- <directoryMode>0755</directoryMode>
- <fileMode>0755</fileMode>
- <unpack>true</unpack>
- <unpackOptions>
- <excludes>
- <exclude>**/META-INF/**</exclude>
- </excludes>
- </unpackOptions>
- </dependencySet>
- <!-- The jUDDI client documentation -->
- <dependencySet>
- <outputDirectory>docs/juddi-client-guide</outputDirectory>
- <includes>
- <include>org.apache.juddi.juddi-docs:juddi-client-guide:jdocbook
- </include>
- </includes>
- <useProjectArtifact>false</useProjectArtifact>
- <useProjectAttachments>false</useProjectAttachments>
- <useTransitiveDependencies>false</useTransitiveDependencies>
- <useTransitiveFiltering>false</useTransitiveFiltering>
- <directoryMode>0755</directoryMode>
- <fileMode>0755</fileMode>
- <unpack>true</unpack>
- <unpackOptions>
- <excludes>
- <exclude>**/META-INF/**</exclude>
- </excludes>
- </unpackOptions>
- </dependencySet>
- </dependencySets>
-</assembly>
diff --git a/docs/dist/pom.xml b/docs/dist/pom.xml
deleted file mode 100644
index e83e778ab..000000000
--- a/docs/dist/pom.xml
+++ /dev/null
@@ -1,66 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- * Copyright 2001-2009 The Apache Software Foundation. * * Licensed under
- the Apache License, Version 2.0 (the "License"); * you may not use this file
- except in compliance with the License. * You may obtain a copy of the License
- at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by
- applicable law or agreed to in writing, software * distributed under the
- License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS
- OF ANY KIND, either express or implied. * See the License for the specific
- language governing permissions and * limitations under the License. * */ -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-docs</artifactId>
- <version>3.3.11-SNAPSHOT</version>
- </parent>
- <artifactId>juddi-docs-dist</artifactId>
- <name>jUDDI Document Packaging</name>
- <url>http://maven.apache.org</url>
- <packaging>pom</packaging>
- <dependencies>
- <dependency>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-guide</artifactId>
- <version>${project.parent.version}</version>
- <type>jdocbook</type>
- </dependency>
- <dependency>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-client-guide</artifactId>
- <version>${project.parent.version}</version>
- <type>jdocbook</type>
- </dependency>
- </dependencies>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-assembly-plugin</artifactId>
- <dependencies>
- <dependency>
- <!-- Entry needed to enable jdocbook unzipping -->
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.8</version>
- </dependency>
- </dependencies>
- <executions>
- <execution>
- <id>make-assembly</id>
- <phase>package</phase>
- <goals>
- <goal>attached</goal>
- </goals>
- <configuration>
- <descriptors>
- <descriptor>assembly.xml</descriptor>
- </descriptors>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
-
-</project>
diff --git a/juddi-dist/pom.xml b/juddi-dist/pom.xml
index 04490f106..325793515 100644
--- a/juddi-dist/pom.xml
+++ b/juddi-dist/pom.xml
@@ -160,15 +160,6 @@
<classifier>javadoc</classifier>
</dependency>
- <!-- documentation -->
- <dependency>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-docs-dist</artifactId>
- <version>${project.parent.version}</version>
- <classifier>docs</classifier>
- <type>zip</type>
- </dependency>
-
<!-- tomcat -->
<dependency>
<groupId>org.apache.juddi</groupId>
diff --git a/pom.xml b/pom.xml
index c2127df59..42a65e566 100644
--- a/pom.xml
+++ b/pom.xml
@@ -49,6 +49,7 @@ under the License.
<jacoco.ut.execution.data.file>${project.build.directory}/coverage-reports/jacoco-ut.exec</jacoco.ut.execution.data.file>
<timestamp>${maven.build.timestamp}</timestamp>
<maven.build.timestamp.format>yyyy-MM-dd HH:mm</maven.build.timestamp.format>
+
</properties>
<issueManagement>
@@ -187,12 +188,7 @@ under the License.
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>0.1.4</version>
</plugin>
- <plugin>
- <!-- Entry needed to enable jdocbook unzipping -->
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.8</version>
- </plugin>
+
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
@@ -714,13 +710,7 @@ under the License.
<version>1.3.2</version>
</dependency>
- <dependency>
- <!-- Entry needed to enable jdocbook unzipping -->
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.10</version>
- </dependency>
-
+
<dependency>
<groupId>org.hibernate.javax.persistence</groupId>
<artifactId>hibernate-jpa-2.1-api</artifactId>
@@ -958,54 +948,7 @@ under the License.
<profiles>
- <profile>
- <id>prepare-site</id>
- <activation>
- <file>
- <exists>src/site/site.xml</exists>
- </file>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-antrun-plugin</artifactId>
- <dependencies>
- <!-- force the juddi docs module to build -->
- <dependency>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-docs</artifactId>
- <version>${project.version}</version>
- <type>pom</type>
- </dependency>
-
- </dependencies>
- <executions>
- <execution>
- <phase>site</phase>
- <configuration>
- <target>
-
-
- <copy todir="target/site/docs/3.3/juddi-client-guide/">
- <fileset dir="docs/asciidoc/ClientGuide/target/docbook/publish/en-US" />
- </copy>
-
- <copy todir="target/site/docs/3.3/juddi-guide/">
- <fileset dir="docs/asciidoc/Guide/target/docbook/publish/en-US" />
- </copy>
-
- </target>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
+
<profile>
<id>doclint-java8-disable</id>
@@ -1025,7 +968,6 @@ under the License.
<module>uddi-tck</module>
<module>uddi-tck-runner</module>
<module>juddi-ddl-generator</module>
- <module>docs</module>
<module>juddi-dist</module>
<module>uddi-client-dist</module>
</modules>
@@ -1039,12 +981,153 @@ under the License.
<module>uddi-tck</module>
<module>uddi-tck-runner</module>
<module>juddi-ddl-generator</module>
- <module>docs</module>
<module>juddi-dist</module>
<module>uddi-client-dist</module>
</modules>
<build>
<plugins>
+
+ <plugin>
+ <groupId>com.github.spyhunter99</groupId>
+ <artifactId>maven-pdf-plugin</artifactId>
+ <version>1.5.0.8</version>
+ <inherited>false</inherited>
+ <executions>
+ <execution>
+ <id>pdf-client</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>pdf</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+ <includeReports>false</includeReports>
+ <docDescriptor>src/site/pdf-client.xml</docDescriptor>
+
+ <!-- optional, the title of a doc defined in pdf-user that is rendered before the TOC
+ <executiveSummaryName>EXSUM</executiveSummaryName>-->
+ <!-- optional, a header only on the title page
+ <titleHeader>A custom header only on the title pages</titleHeader>-->
+
+ <!-- optional, the distribution statement is printed on the title page towards the bottom, common use case:
+ confidentiality statements, limited distribution, legalese and other mumbo jumbo.
+ <distributionStatement>DISTRIBUTION STATEMENT: Feel free to give this document to anyone you will take it.</distributionStatement>-->
+
+ <!-- optional, these header/footer definitions are used on all pages exception the title page -->
+ <pdfFooter>Version ${project.version}
+ ${timestamp}</pdfFooter>
+ <pdfHeader>jUDDI Client Guide</pdfHeader>
+
+ <!-- optional, the cover page can have a pom defined date too
+ <pdfCoverDate>1970-1-1</pdfCoverDate>-->
+
+ <!-- optional, the max depth of the TOC -->
+ <tocMaxDepthToPrint>4</tocMaxDepthToPrint>
+ <!-- optional, you can override any of the colors, fonts, padding etc with your own file here
+ <foStylesOverride>src/main/resources/fo-styles_1.xslt</foStylesOverride>-->
+ </configuration>
+ </execution>
+
+ <execution>
+ <id>pdf-server</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>pdf</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+ <includeReports>false</includeReports>
+ <docDescriptor>src/site/pdf-server.xml</docDescriptor>
+
+ <!-- optional, the title of a doc defined in pdf-user that is rendered before the TOC
+ <executiveSummaryName>EXSUM</executiveSummaryName>-->
+ <!-- optional, a header only on the title page
+ <titleHeader>A custom header only on the title pages</titleHeader>-->
+
+ <!-- optional, the distribution statement is printed on the title page towards the bottom, common use case:
+ confidentiality statements, limited distribution, legalese and other mumbo jumbo.
+ <distributionStatement>DISTRIBUTION STATEMENT: Feel free to give this document to anyone you will take it.</distributionStatement>-->
+
+ <!-- optional, these header/footer definitions are used on all pages exception the title page -->
+ <pdfFooter>Version ${project.version}
+ ${timestamp}</pdfFooter>
+ <pdfHeader>jUDDI Server Guide</pdfHeader>
+
+ <!-- optional, the cover page can have a pom defined date too
+ <pdfCoverDate>1970-1-1</pdfCoverDate>-->
+
+ <!-- optional, the max depth of the TOC -->
+ <tocMaxDepthToPrint>4</tocMaxDepthToPrint>
+ <!-- optional, you can override any of the colors, fonts, padding etc with your own file here
+ <foStylesOverride>src/main/resources/fo-styles_1.xslt</foStylesOverride>-->
+ </configuration>
+ </execution>
+
+ </executions>
+ </plugin>
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>pack-site</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>site</goal>
+ <goal>jar</goal>
+ </goals>
+ <configuration>
+ <attach>false</attach>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
+ <plugin>
+ <groupId>com.coderplus.maven.plugins</groupId>
+ <artifactId>copy-rename-maven-plugin</artifactId>
+ <version>1.0.1</version>
+ <executions>
+ <execution>
+ <id>rename-file</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>rename</goal>
+ </goals>
+ <configuration>
+ <sourceFile>${project.build.directory}/${project.build.finalName}-site.jar</sourceFile>
+ <destinationFile>${project.build.directory}/${project.build.finalName}-site.zip</destinationFile>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>build-helper-maven-plugin</artifactId>
+ <version>1.10</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>attach-artifact</goal>
+ </goals>
+ <phase>package</phase>
+ <configuration>
+ <artifacts>
+ <artifact>
+ <file>${project.build.directory}/${project.build.finalName}-site.zip</file>
+ <type>zip</type>
+ <classifier>site</classifier>
+ </artifact>
+ </artifacts>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
+
+
<!-- Create a source-release artifact that contains the fully buildable
project directory source structure. This is the artifact which is the official
subject of any release vote. -->
diff --git a/uddi-client-dist/pom.xml b/uddi-client-dist/pom.xml
index 442a5e529..e18c1dbaf 100644
--- a/uddi-client-dist/pom.xml
+++ b/uddi-client-dist/pom.xml
@@ -212,27 +212,14 @@ language governing permissions and * limitations under the License. * */ -->
<type>jar</type>
<classifier>javadoc</classifier>
</dependency>
- <!-- documentation -->
- <dependency>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-client-guide</artifactId>
- <version>${project.parent.version}</version>
- <type>jdocbook</type>
- </dependency>
+
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
- <dependencies>
- <dependency>
- <!-- Entry needed to enable jdocbook unzipping -->
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.8</version>
- </dependency>
- </dependencies>
+
<executions>
<execution>
<id>make-assembly</id>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org
[juddi] 02/08: Merge branch 'master' into feature/JUDDI-978
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a commit to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
commit 8801b6380ed86b2225fb6eca1ccfefed57ccf0e9
Merge: a93f5b942 baba62cc2
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Mon Jan 20 14:37:53 2020 -0500
Merge branch 'master' into feature/JUDDI-978
# Conflicts:
# docs/asciidoc/ClientGuide/pom.xml
# docs/asciidoc/Guide/pom.xml
# docs/asciidoc/pom.xml
# pom.xml
.gitattributes | 1 +
.gitignore | 8 +
KEYS | 139 ++
RELEASE_NOTES.html | 113 +-
docs/dist/pom.xml | 2 +-
docs/pom.xml | 2 +-
juddi-client-cli/pom.xml | 14 +-
.../org/apache/juddi/v3/client/cli/EntryPoint.java | 2 +-
.../juddi/v3/client/cli/EntryPointSingleNode.java | 127 +-
.../juddi/v3/client/cli/EntryPoitMultiNode.java | 20 +-
.../juddi/v3/client/cli/FindBusinessBugHunt.java | 208 ---
.../juddi/v3/client/cli/JuddiAdminService.java | 76 +-
.../apache/juddi/v3/client/cli/SearchByQos.java | 19 +-
.../apache/juddi/v3/client/cli/SimpleBrowse.java | 59 +-
.../apache/juddi/v3/client/cli/UddiCreatebulk.java | 210 ---
.../juddi/v3/client/cli/UddiCustodyTransfer.java | 14 +-
.../client/cli/UddiDigitalSignatureBusiness.java | 8 +-
.../v3/client/cli/UddiDigitalSignatureFile.java | 3 +-
.../v3/client/cli/UddiDigitalSignatureSearch.java | 5 +-
.../v3/client/cli/UddiDigitalSignatureService.java | 9 +-
.../v3/client/cli/UddiDigitalSignatureTmodel.java | 8 +-
.../juddi/v3/client/cli/UddiFindBinding.java | 4 +-
.../juddi/v3/client/cli/UddiFindEndpoints.java | 5 +-
.../juddi/v3/client/cli/UddiGetServiceDetails.java | 4 +-
.../juddi/v3/client/cli/UddiKeyGenerator.java | 4 +-
.../juddi/v3/client/cli/UddiRelatedBusinesses.java | 19 +-
.../juddi/v3/client/cli/UddiReplication.java | 10 +-
.../apache/juddi/v3/client/cli/UddiSubscribe.java | 49 +-
.../client/cli/UddiSubscribeAssertionStatus.java | 19 +-
.../juddi/v3/client/cli/UddiSubscribeValidate.java | 4 +-
.../v3/client/cli/UddiSubscriptionManagement.java | 2 +-
.../org/apache/juddi/v3/client/cli/WadlImport.java | 9 +-
.../org/apache/juddi/v3/client/cli/WsdlImport.java | 10 +-
juddi-client-plugins/pom.xml | 58 -
.../juddi/client/plugins/JGroupsTransport.java | 73 --
.../client/plugins/MulticastDNSTransport.java | 71 -
.../juddi/client/plugins/WSDiscoveryTransport.java | 71 -
.../org/apache/juddi/client/plugins/AppTest.java | 54 -
juddi-client.net/bb-win7.bat | 6 +
.../LogFactoryTests.cs | 18 +-
.../org.apache.juddi.v3.client/EventLogger.cs | 14 +-
juddi-client.net/juddi-installer/Program.cs | 9 +-
juddi-client/pom.xml | 2 +-
.../org/apache/juddi/v3/client/UDDIConstants.java | 1382 ++++++++++----------
.../juddi/v3/client/config/ClientConfig.java | 2 +-
.../apache/juddi/v3/client/config/UDDIClerk.java | 4 +-
.../juddi/v3/client/config/UDDIClerkServlet.java | 4 +-
.../apache/juddi/v3/client/config/UDDIClient.java | 32 +-
.../v3/client/config/UDDIClientContainer.java | 5 +
.../juddi/v3/client/config/UDDIKeyConvention.java | 3 +-
.../apache/juddi/v3/client/config/UDDINode.java | 4 +-
.../apache/juddi/v3/client/config/WebHelper.java | 140 +-
.../juddi/v3/client/cryptor/AES128Cryptor.java | 7 +-
.../juddi/v3/client/cryptor/AES256Cryptor.java | 7 +-
.../v3/client/cryptor/AESCryptorAbstract.java | 11 +-
.../apache/juddi/v3/client/cryptor/Cryptor.java | 9 +-
.../juddi/v3/client/cryptor/DefaultCryptor.java | 13 +-
.../apache/juddi/v3/client/cryptor/DigSigUtil.java | 42 +-
.../v3/client/cryptor/TransportSecurityHelper.java | 50 +-
.../juddi/v3/client/cryptor/TripleDESCrytor.java | 8 +-
.../apache/juddi/v3/client/cryptor/XmlUtils.java | 139 ++
.../juddi/v3/client/mapping/MapUDDIv2Tov3.java | 4 +-
.../juddi/v3/client/mapping/PolicyLocalFirst.java | 8 +-
.../juddi/v3/client/mapping/ServiceLocator.java | 3 +-
.../juddi/v3/client/mapping/UDDIServiceCache.java | 4 +-
.../juddi/v3/client/mapping/wadl/WADL2UDDI.java | 9 +-
.../client/subscription/ISubscriptionCallback.java | 8 +-
.../subscription/SubscriptionCallbackListener.java | 4 +-
.../juddi/v3/client/transport/InVMTransport.java | 4 +-
.../juddi/v3/client/transport/JAXWSTransport.java | 6 +-
.../transport/JAXWSv2TranslationTransport.java | 2 +-
.../v3/client/transport/wrapper/Inquiry3to2.java | 3 +
.../client/transport/wrapper/RequestHandler.java | 6 +-
.../transport/wrapper/UDDIInquiryService.java | 8 +-
.../juddi/v3/client/config/WebHelperTest.java | 2 -
.../subscription/SubscriptionCallbackTest.java | 16 +-
juddi-core-openjpa/pom.xml | 2 +-
juddi-core/pom.xml | 9 +-
.../juddi/api/impl/AuthenticatedService.java | 34 +-
.../org/apache/juddi/api/impl/InquiryHelper.java | 40 +-
.../org/apache/juddi/api/impl/JUDDIApiImpl.java | 31 +-
.../juddi/api/impl/UDDICustodyTransferImpl.java | 41 +-
.../org/apache/juddi/api/impl/UDDIInquiryImpl.java | 30 +-
.../apache/juddi/api/impl/UDDIPublicationImpl.java | 77 +-
.../apache/juddi/api/impl/UDDIReplicationImpl.java | 144 +-
.../apache/juddi/api/impl/UDDISecurityImpl.java | 3 +-
.../juddi/api/impl/UDDIValueSetCachingImpl.java | 9 +-
.../juddi/api/impl/UDDIValueSetValidationImpl.java | 19 +-
.../org/apache/juddi/api/impl/XRegisterHelper.java | 1 -
.../juddi/api/util/CustodyTransferQuery.java | 10 +-
.../org/apache/juddi/api/util/InquiryQuery.java | 7 +
.../java/org/apache/juddi/api/util/JUDDIQuery.java | 6 +
.../apache/juddi/api/util/PublicationQuery.java | 6 +
.../org/apache/juddi/api/util/QueryStatus.java | 6 +
.../apache/juddi/api/util/ReplicationQuery.java | 6 +
.../org/apache/juddi/api/util/SecurityQuery.java | 6 +
.../juddi/api/util/SubscriptionListenerQuery.java | 7 +
.../apache/juddi/api/util/SubscriptionQuery.java | 6 +
.../juddi/api/util/ValueSetCachingQuery.java | 6 +
.../juddi/api/util/ValueSetValidationQuery.java | 6 +
.../java/org/apache/juddi/config/AppConfig.java | 2 +-
.../main/java/org/apache/juddi/config/Install.java | 50 +-
.../org/apache/juddi/cryptor/CryptorFactory.java | 2 +-
.../apache/juddi/mapping/MappingApiToModel.java | 47 +-
.../apache/juddi/mapping/MappingModelToApi.java | 12 +-
.../src/main/java/org/apache/juddi/model/Edge.java | 6 +-
.../java/org/apache/juddi/model/KeyDataValue.java | 3 +-
.../org/apache/juddi/model/PublisherAssertion.java | 267 ++--
.../org/apache/juddi/model/TmodelInstanceInfo.java | 2 +
.../apache/juddi/query/BindingTemplateQuery.java | 2 +-
.../apache/juddi/query/BusinessEntityQuery.java | 2 +-
.../apache/juddi/query/BusinessServiceQuery.java | 2 +-
.../DeletePublisherAssertionByBusinessQuery.java | 2 +-
.../java/org/apache/juddi/query/EntityQuery.java | 47 +-
.../juddi/query/FetchBindingTemplatesQuery.java | 4 +-
.../juddi/query/FetchBusinessEntitiesQuery.java | 4 +-
.../juddi/query/FetchBusinessServicesQuery.java | 4 +-
.../org/apache/juddi/query/FetchTModelsQuery.java | 4 +-
.../query/FindBindingByCategoryGroupQuery.java | 4 +-
.../juddi/query/FindBindingByCategoryQuery.java | 4 +-
.../juddi/query/FindBindingByTModelKeyQuery.java | 10 +-
.../query/FindBusinessByCategoryGroupQuery.java | 4 +-
.../juddi/query/FindBusinessByCategoryQuery.java | 4 +-
.../query/FindBusinessByCombinedCategoryQuery.java | 2 +-
.../query/FindBusinessByDiscoveryURLQuery.java | 6 +-
.../juddi/query/FindBusinessByIdentifierQuery.java | 4 +-
.../juddi/query/FindBusinessByNameQuery.java | 4 +-
.../juddi/query/FindBusinessByPublisherQuery.java | 2 +-
.../juddi/query/FindBusinessByTModelKeyQuery.java | 6 +-
.../query/FindEntityByCategoryGroupQuery.java | 34 +-
.../juddi/query/FindEntityByCategoryQuery.java | 4 +-
.../query/FindEntityByCombinedCategoryQuery.java | 12 +-
.../juddi/query/FindEntityByIdentifierQuery.java | 22 +-
.../apache/juddi/query/FindEntityByNamesQuery.java | 16 +-
.../juddi/query/FindEntityByPublisherQuery.java | 8 +-
.../query/FindServiceByCategoryGroupQuery.java | 4 +-
.../juddi/query/FindServiceByCategoryQuery.java | 4 +-
.../query/FindServiceByCombinedCategoryQuery.java | 4 +-
.../apache/juddi/query/FindServiceByNameQuery.java | 4 +-
.../juddi/query/FindServiceByTModelKeyQuery.java | 4 +-
.../query/FindTModelByCategoryGroupQuery.java | 4 +-
.../juddi/query/FindTModelByCategoryQuery.java | 4 +-
.../juddi/query/FindTModelByIdentifierQuery.java | 4 +-
.../apache/juddi/query/FindTModelByNameQuery.java | 2 +-
.../juddi/query/FindTModelByPublisherQuery.java | 2 +-
.../juddi/query/PublisherAssertionQuery.java | 4 +-
.../org/apache/juddi/query/SubscriptionQuery.java | 2 +-
.../java/org/apache/juddi/query/TModelQuery.java | 2 +-
.../juddi/replication/ReplicationNotifier.java | 9 +-
.../juddi/rmi/UDDICustodyTransferService.java | 2 +-
.../org/apache/juddi/rmi/UDDIInquiryService.java | 2 +-
.../apache/juddi/rmi/UDDIPublicationService.java | 2 +-
.../org/apache/juddi/rmi/UDDISecurityService.java | 2 +-
.../juddi/rmi/UDDISubscriptionListenerService.java | 2 +-
.../apache/juddi/rmi/UDDISubscriptionService.java | 2 +-
.../juddi/subscription/SubscriptionNotifier.java | 23 +-
.../juddi/subscription/notify/SMTPNotifier.java | 8 +-
.../juddi/v3/auth/HTTPContainerAuthenticator.java | 4 +-
.../apache/juddi/v3/auth/XMLDocAuthenticator.java | 252 ++--
.../juddi/validation/ValidateCustodyTransfer.java | 10 +-
.../apache/juddi/validation/ValidateInquiry.java | 43 +-
.../apache/juddi/validation/ValidatePublish.java | 31 +-
.../juddi/validation/ValidateReplication.java | 11 +-
.../apache/juddi/validation/ValidateUDDIKey.java | 4 +-
.../validation/ValidateValuesFromWebService.java | 13 +-
.../validation/vsv/AbstractSimpleValidator.java | 6 +-
.../vsv/Uddiuddiorgcategorizationderivedfrom.java | 6 +-
.../vsv/Uddiuddiorgidentifierisreplacedby.java | 24 -
juddi-core/src/main/resources/messages.properties | 2 +
.../api/impl/API_050_BindingTemplateTest.java | 47 +-
.../juddi/api/impl/API_070_FindEntityTest.java | 95 +-
.../apache/juddi/api/impl/API_141_JIRATest.java | 7 +
.../juddi/api/impl/API_160_ReplicationTest.java | 1 +
.../apache/juddi/api/runtime/CLIServerTest.java | 2 -
.../java/org/apache/juddi/config/InstallTest.java | 3 +-
juddi-ddl-generator/pom.xml | 189 ++-
.../java/org/apache/juddi/ddl/generator/App.java | 73 +-
juddi-dist/pom.xml | 2 +-
juddi-examples/ValueSetValidator/pom.xml | 9 +-
.../juddi/examples/vsv/valuesetvalidator/App.java | 2 +-
juddi-examples/create-partition/pom.xml | 2 +-
.../partition/SimpleCreateTmodelPartition.java | 4 -
juddi-examples/hello-world-embedded/pom.xml | 2 +-
juddi-examples/hello-world/pom.xml | 2 +-
.../juddi/example/helloworld/HelloWorld.java | 2 +-
juddi-examples/juddi-embedded/juddi-server.xml | 225 ++++
juddi-examples/juddi-embedded/juddi-users.xml | 22 +
juddi-examples/juddi-embedded/pom.xml | 35 +
.../example/juddi/embedded/EmbeddedNoWeb.java | 73 ++
.../juddi/embedded/EmbeddedNoWebNoClerk.java | 99 ++
.../example/juddi/embedded/EmbeddedWithWeb.java | 179 +++
.../juddi/example/juddi/embedded/MyWebContext.java | 69 +
.../src/main/resources}/META-INF/persistence.xml | 229 ++--
.../src/main/resources/META-INF/uddi-client.xml | 53 +
juddi-examples/juddi-embedded/truststore.jks | Bin 0 -> 965 bytes
juddi-examples/juddi-embedded/uddi-http.xml | 93 ++
juddi-examples/juddi-embedded/uddi-invm.xml | 83 ++
juddi-examples/more-uddi-samples/pom.xml | 3 +-
.../main/java/org/apache/juddi/samples/AES.java | 122 +-
.../juddi/samples/BusinessServiceKeymismatch.java | 89 +-
.../samples/CompareByTModelInstanceInfoQOS.java | 155 +--
.../main/java/org/apache/juddi/samples/DES.java | 110 +-
.../java/org/apache/juddi/samples/EntryPoint.java | 21 +-
.../apache/juddi/samples/EntryPointSingleNode.java | 49 +-
.../apache/juddi/samples/EntryPoitMultiNode.java | 5 +-
.../apache/juddi/samples/FindBusinessBugHunt.java | 290 ++--
.../apache/juddi/samples/JuddiAdminService.java | 34 +-
.../java/org/apache/juddi/samples/SearchByQos.java | 41 +-
.../org/apache/juddi/samples/SimpleBrowse.java | 12 +-
.../org/apache/juddi/samples/UddiCreatebulk.java | 28 +-
.../apache/juddi/samples/UddiCustodyTransfer.java | 10 +-
.../samples/UddiDigitalSignatureBusiness.java | 20 +-
.../juddi/samples/UddiDigitalSignatureFile.java | 33 +-
.../juddi/samples/UddiDigitalSignatureSearch.java | 153 ++-
.../juddi/samples/UddiDigitalSignatureService.java | 33 +-
.../juddi/samples/UddiDigitalSignatureTmodel.java | 48 +-
.../org/apache/juddi/samples/UddiFindBinding.java | 19 +-
.../apache/juddi/samples/UddiFindEndpoints.java | 18 +-
.../juddi/samples/UddiGetServiceDetails.java | 15 +-
.../org/apache/juddi/samples/UddiKeyGenerator.java | 21 +-
.../juddi/samples/UddiRelatedBusinesses.java | 31 +-
.../org/apache/juddi/samples/UddiReplication.java | 18 +-
.../org/apache/juddi/samples/UddiSubscribe.java | 43 +-
.../samples/UddiSubscribeAssertionStatus.java | 62 +-
.../juddi/samples/UddiSubscribeValidate.java | 25 +-
.../juddi/samples/UddiSubscriptionManagement.java | 58 +-
.../java/org/apache/juddi/samples/WadlImport.java | 16 +-
.../java/org/apache/juddi/samples/WsdlImport.java | 22 +-
.../java/org/apache/juddi/samples/testStrings.java | 73 --
juddi-examples/pom.xml | 5 +-
juddi-examples/service-version/pom.xml | 5 +-
juddi-examples/simple-browse/pom.xml | 2 +-
juddi-examples/simple-publish-clerk/pom.xml | 2 +-
juddi-examples/simple-publish-portable/pom.xml | 2 +-
.../subscription-notification-amqp/pom.xml | 4 +-
juddi-examples/uddi-annotations/pom.xml | 2 +-
.../src/main/webapp/WEB-INF/beans.xml | 1 -
juddi-examples/uddiv2-api-bridge-example/pom.xml | 3 +-
juddi-examples/wsdl2uddi-lifecyle/pom.xml | 2 +-
.../src/main/webapp/WEB-INF/beans.xml | 1 -
juddi-examples/wsdl2uddi/generate-client.sh | 2 +-
juddi-examples/wsdl2uddi/pom.xml | 2 +-
juddi-extras/juddi-client-extras/pom.xml | 4 +-
juddi-gui-dsig/pom.xml | 2 +-
.../org/apache/juddi/gui/dsig/XmlSigApplet2.java | 9 +-
.../apache/juddi/gui/dsig/XmlSignatureApplet.java | 10 +-
juddi-gui/pom.xml | 4 +-
.../juddi/webconsole/hub/UDDIRequestsAsXML.java | 88 +-
.../org/apache/juddi/webconsole/hub/UddiHub.java | 25 +-
juddi-gui/src/main/resources/META-INF/uddi.xml | 220 ++--
.../src/main/webapp/ajax/abortTransferToken.jsp | 20 +-
juddi-gui/src/main/webapp/ajax/advanced.jsp | 13 +-
juddi-gui/src/main/webapp/ajax/getCert.jsp | 8 +-
juddi-gui/src/main/webapp/ajax/saveFromXML.jsp | 11 +-
juddi-gui/src/main/webapp/ajax/search.jsp | 4 +-
juddi-rest-cxf/pom.xml | 25 +-
juddi-tomcat/build.xml | 2 +
juddi-tomcat/catalina.bat | 687 +++++-----
juddi-tomcat/catalina.sh | 132 +-
juddi-tomcat/context.xml | 2 +-
juddi-tomcat/index.html | 2 +-
juddi-tomcat/juddi-cryptor.sh | 2 +-
juddi-tomcat/juddi-md5.sh | 2 +-
juddi-tomcat/pom.xml | 322 +++--
juddi-tomcat/server.xml | 56 +-
juddi-tomcat/serverContext.xml | 31 +
juddi-tomcat/serverNode2.xml | 12 +-
juddi-tomcat/serverNode3.xml | 12 +-
.../JAX-WS/CXF-JBossAS7Up/WEB-INF/beans.xml | 40 +-
juddiv3-war-repl/JAX-WS/CXF/WEB-INF/beans.xml | 45 +-
.../WEB-INF/classes/META-INF/persistence.xml | 1 -
juddiv3-war-repl/pom.xml | 44 +-
.../juddi/adminconsole/hub/JUDDIRequestsAsXML.java | 15 +-
.../juddi/adminconsole/hub/UddiAdminHub.java | 15 +-
.../JAX-WS/CXF-JBossAS7Up/WEB-INF/beans.xml | 41 +-
juddiv3-war/JAX-WS/CXF/WEB-INF/beans.xml | 39 +-
.../WEB-INF/classes/META-INF/persistence.xml | 1 -
juddiv3-war/pom.xml | 35 +-
.../juddi/adminconsole/hub/JUDDIRequestsAsXML.java | 19 +-
.../juddi/adminconsole/hub/UddiAdminHub.java | 12 +-
pom.xml | 71 +-
src/site/markdown/ClientGuideUsingthejUDDIGUI.md | 13 +
src/site/markdown/committers.md | 2 +-
src/site/markdown/index.md | 9 +-
src/site/markdown/releases.md | 2 +-
src/site/markdown/security.md | 39 +-
src/site/site.xml | 5 +-
uddi-client-dist/pom.xml | 346 ++---
.../src/main/bin/juddi-client-cryptor.sh | 2 +-
uddi-migration-tool/pom.xml | 2 +-
.../org/apache/juddi/v3/migration/tool/Import.java | 7 +-
uddi-tck-base/pom.xml | 2 +-
.../org/apache/juddi/v2/tck/TckFindEntity.java | 6 +-
.../java/org/apache/juddi/v2/tck/TckTModel.java | 1 -
.../apache/juddi/v3/tck/TckBindingTemplate.java | 10 +-
.../org/apache/juddi/v3/tck/TckSigningUtil.java | 8 +-
.../joepublisher/bindingTemplateInvalid.xml | 115 ++
.../joepublisher/bindingTemplateMaxLength.xml | 114 ++
.../uddi_data_v2/joepublisher/bindingTemplate.xml | 4 +-
uddi-tck-runner/pom.xml | 2 +-
uddi-tck/context.xml | 2 +-
uddi-tck/pom.xml | 18 +-
uddi-tck/server.xml | 10 +-
uddi-tck/serverNode2.xml | 10 +-
.../java/org/apache/juddi/v2/tck/package-info.java | 3 +-
.../java/org/apache/juddi/v3/tck/package-info.java | 1 -
.../v2/tck/UDDI_020_TmodelIntegrationTest.java | 3 +
.../juddi/v3/bpel/BPEL_020_IntegrationTest.java | 8 +-
...091_RMISubscriptionListenerIntegrationTest.java | 13 +-
...ientSubscriptionCallbackAPIIntegrationTest.java | 6 +-
.../v3/tck/JUDDI_300_MultiNodeIntegrationTest.java | 13 +-
.../v3/tck/UDDI_010_PublisherIntegrationTest.java | 85 +-
...UDDI_030_BusinessEntityLoadIntegrationTest.java | 2 +-
.../UDDI_050_BindingTemplateIntegrationTest.java | 4 +-
...UDDI_060_PublisherAssertionIntegrationTest.java | 18 +-
.../v3/tck/UDDI_070_FindEntityIntegrationTest.java | 10 +-
.../tck/UDDI_080_SubscriptionIntegrationTest.java | 39 +-
.../juddi/v3/tck/UDDI_090_HttpExternalTest.java | 4 +-
.../v3/tck/UDDI_090_HttpMavenIntegrationTest.java | 6 +-
.../juddi/v3/tck/UDDI_090_RMIIntegrationTest.java | 4 +-
.../juddi/v3/tck/UDDI_090_Smtp_ExternalTest.java | 2 +-
...DI_090_SubscriptionListenerIntegrationBase.java | 28 +-
...DDI_140_NegativePublicationIntegrationTest.java | 145 +-
.../juddi/v3/tck/UDDI_141_JIRAIntegrationTest.java | 87 +-
.../UDDI_142_DigitalSignatureIntegrationTest.java | 58 +-
.../UDDI_150_CustodyTransferIntegrationTest.java | 7 +-
.../v3/tck/UDDI_160_RESTIntergrationTest.java | 9 +-
...UDDI_170_ValueSetValidationIntegrationTest.java | 232 ++--
uddi-tck/src/test/resources/log4j.xml | 11 +
uddi-ws/pom.xml | 2 +-
.../org/uddi/repl_v3/ReplicationConfiguration.java | 726 +++++-----
331 files changed, 7138 insertions(+), 5645 deletions(-)
diff --cc pom.xml
index 5eb462d75,682d778bb..32e797a39
--- a/pom.xml
+++ b/pom.xml
@@@ -43,13 -43,12 +43,13 @@@ under the License
<sourceReleaseAssemblyDescriptor>source-release</sourceReleaseAssemblyDescriptor>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
- <cxf.version>2.7.18</cxf.version>
- <springframework.version>3.2.18.RELEASE</springframework.version>
- <apache.tomcat.version>7.0.82</apache.tomcat.version>
+ <cxf.version>3.3.4</cxf.version>
+ <springframework.version>5.2.3.RELEASE</springframework.version>
+ <apache.tomcat.version>9.0.30</apache.tomcat.version>
<jacoco.it.execution.data.file>${project.build.directory}/coverage-reports/jacoco-it.exec</jacoco.it.execution.data.file>
<jacoco.ut.execution.data.file>${project.build.directory}/coverage-reports/jacoco-ut.exec</jacoco.ut.execution.data.file>
-
+ <timestamp>${maven.build.timestamp}</timestamp>
+ <maven.build.timestamp.format>yyyy-MM-dd HH:mm</maven.build.timestamp.format>
</properties>
<issueManagement>
@@@ -820,12 -772,7 +855,7 @@@
<version>2.1_3</version>
</dependency>
- <dependency>
- <groupId>org.hibernate</groupId>
- <artifactId>hibernate</artifactId>
- <version>3.2.5.ga</version>
-
+
- </dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org
[juddi] 07/08: Merge branch 'master' into feature/JUDDI-978
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a commit to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
commit b5d853881d2133a10bb140b5d7d9174d97ca5bc6
Merge: 578ecfdbb b1a72d2f6
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Sat May 14 20:53:36 2022 -0400
Merge branch 'master' into feature/JUDDI-978
.github/workflows/codeql-analysis.yml | 69 ++++++++++++++++++----
.travis.yml | 13 ----
juddi-client-cli/pom.xml | 1 -
juddi-client/pom.xml | 2 +-
.../juddi/v3/client/cryptor/TripleDESCrytor.java | 2 +
.../v3/client/cryptor/TripleDESCrytorTest.java | 2 +
.../main/java/org/apache/juddi/samples/DES.java | 2 +
pom.xml | 12 ++--
8 files changed, 71 insertions(+), 32 deletions(-)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org
[juddi] 06/08: Merge branch 'master' into feature/JUDDI-978
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a commit to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
commit 578ecfdbb697f99164dcd2ff09b85320439ccaa7
Merge: 1ae04582f 36c51732f
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Sun Apr 17 14:49:23 2022 -0400
Merge branch 'master' into feature/JUDDI-978
.github/workflows/codeql-analysis.yml | 48 +-
juddi-dist/pom.xml | 22 +-
juddi-dist/src/main/assembly/assembly.xml | 5 -
juddi-gui-dsig/.gitignore | 6 -
juddi-gui-dsig/applet.policy | 3 -
juddi-gui-dsig/pom.xml | 136 -----
juddi-gui-dsig/readme.txt | 26 -
.../org/apache/juddi/gui/dsig/XmlSigApplet2.form | 382 ------------
.../org/apache/juddi/gui/dsig/XmlSigApplet2.java | 638 ---------------------
.../apache/juddi/gui/dsig/XmlSignatureApplet.form | 54 --
.../apache/juddi/gui/dsig/XmlSignatureApplet.java | 411 -------------
.../src/main/keystore/signing-jar.keystore | Bin 2218 -> 0 bytes
.../src/main/resources/META-INF/MANIFEST.MF | 3 -
juddi-gui/pom.xml | 40 +-
juddi-gui/src/main/webapp/bindingEditor.jsp | 1 -
juddi-gui/src/main/webapp/reginfo.jsp | 1 -
juddi-gui/src/main/webapp/serviceEditor.jsp | 1 -
juddi-gui/src/main/webapp/signer.jsp | 164 ------
juddi-gui/src/main/webapp/tmodelEditor.jsp | 1 -
pom.xml | 1 -
uddi-client-dist/pom.xml | 22 +-
uddi-client-dist/src/main/assembly/assembly.xml | 5 -
.../v3/tck/JUDDI_200_GUI_IntegrationTest.java | 4 -
23 files changed, 43 insertions(+), 1931 deletions(-)
diff --cc juddi-dist/pom.xml
index 325793515,ad299c745..7ea0805cd
--- a/juddi-dist/pom.xml
+++ b/juddi-dist/pom.xml
@@@ -152,14 -142,17 +142,8 @@@
<version>${project.parent.version}</version>
<classifier>javadoc</classifier>
</dependency>
- <dependency>
- <groupId>org.apache.juddi</groupId>
- <artifactId>juddi-gui-dsig</artifactId>
- <version>${project.parent.version}</version>
- <type>jar</type>
- <classifier>javadoc</classifier>
- </dependency>
+
- <!-- documentation -->
- <dependency>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-docs-dist</artifactId>
- <version>${project.parent.version}</version>
- <classifier>docs</classifier>
- <type>zip</type>
- </dependency>
-
<!-- tomcat -->
<dependency>
<groupId>org.apache.juddi</groupId>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org
[juddi] 08/08: [JUDDI-978] [JUDDI-1020]
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a commit to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
commit fde14da9bde8d85aa59b1a0deb2cfc1114289ab2
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Sun May 15 11:09:46 2022 -0400
[JUDDI-978] [JUDDI-1020]
---
pom.xml | 128 ++++++++++++++++++------------------------------
src/site/pdf-client.xml | 4 +-
src/site/pdf-server.xml | 4 +-
3 files changed, 52 insertions(+), 84 deletions(-)
diff --git a/pom.xml b/pom.xml
index cf1f60ce8..957781134 100644
--- a/pom.xml
+++ b/pom.xml
@@ -472,11 +472,11 @@ under the License.
<plugin>
<groupId>com.github.spyhunter99</groupId>
<artifactId>maven-pdf-plugin</artifactId>
- <version>1.5.0.5</version>
+ <version>1.5.0.8</version>
<executions>
<execution>
<id>pdf-user</id>
- <phase>site</phase>
+ <phase>compile</phase>
<goals>
<goal>pdf</goal>
</goals>
@@ -509,7 +509,7 @@ under the License.
</execution>
<execution>
<id>pdf-server</id>
- <phase>site</phase>
+ <phase>compile</phase>
<goals>
<goal>pdf</goal>
</goals>
@@ -528,7 +528,7 @@ under the License.
<distributionStatement>DISTRIBUTION STATEMENT: Feel free to give this document to anyone you will take it.</distributionStatement>
-->
<!-- optional, these header/footer definitions are used on all pages exception the title page -->
- <pdfFooter>Apache jUDDI
+ <pdfFooter>Apache jUDDI - https://juddi.apache.org
Version ${project.version}
${timestamp}</pdfFooter>
<pdfHeader>Apache jUDDI
@@ -985,85 +985,53 @@ under the License.
</modules>
<build>
<plugins>
-
- <plugin>
- <groupId>com.github.spyhunter99</groupId>
- <artifactId>maven-pdf-plugin</artifactId>
- <version>1.5.0.8</version>
- <inherited>false</inherited>
- <executions>
- <execution>
- <id>pdf-client</id>
- <phase>prepare-package</phase>
- <goals>
- <goal>pdf</goal>
- </goals>
- <configuration>
- <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
- <includeReports>false</includeReports>
- <docDescriptor>src/site/pdf-client.xml</docDescriptor>
-
- <!-- optional, the title of a doc defined in pdf-user that is rendered before the TOC
- <executiveSummaryName>EXSUM</executiveSummaryName>-->
- <!-- optional, a header only on the title page
- <titleHeader>A custom header only on the title pages</titleHeader>-->
-
- <!-- optional, the distribution statement is printed on the title page towards the bottom, common use case:
- confidentiality statements, limited distribution, legalese and other mumbo jumbo.
- <distributionStatement>DISTRIBUTION STATEMENT: Feel free to give this document to anyone you will take it.</distributionStatement>-->
+
+ <plugin>
+ <groupId>com.github.spyhunter99</groupId>
+ <artifactId>maven-pdf-plugin</artifactId>
+ <version>1.5.0.8</version>
+ <inherited>false</inherited>
+ <executions>
+ <execution>
+ <id>pdf-client</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>pdf</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+ <includeReports>false</includeReports>
+ <docDescriptor>src/site/pdf-client.xml</docDescriptor>
- <!-- optional, these header/footer definitions are used on all pages exception the title page -->
- <pdfFooter>Version ${project.version}
- ${timestamp}</pdfFooter>
- <pdfHeader>jUDDI Client Guide</pdfHeader>
- <!-- optional, the cover page can have a pom defined date too
- <pdfCoverDate>1970-1-1</pdfCoverDate>-->
-
- <!-- optional, the max depth of the TOC -->
- <tocMaxDepthToPrint>4</tocMaxDepthToPrint>
- <!-- optional, you can override any of the colors, fonts, padding etc with your own file here
- <foStylesOverride>src/main/resources/fo-styles_1.xslt</foStylesOverride>-->
- </configuration>
- </execution>
-
- <execution>
- <id>pdf-server</id>
- <phase>prepare-package</phase>
- <goals>
- <goal>pdf</goal>
- </goals>
- <configuration>
- <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
- <includeReports>false</includeReports>
- <docDescriptor>src/site/pdf-server.xml</docDescriptor>
-
- <!-- optional, the title of a doc defined in pdf-user that is rendered before the TOC
- <executiveSummaryName>EXSUM</executiveSummaryName>-->
- <!-- optional, a header only on the title page
- <titleHeader>A custom header only on the title pages</titleHeader>-->
+ <pdfFooter>Version ${project.version}
+ ${timestamp}</pdfFooter>
+ <pdfHeader>jUDDI Client Guide</pdfHeader>
+
+ </configuration>
+ </execution>
- <!-- optional, the distribution statement is printed on the title page towards the bottom, common use case:
- confidentiality statements, limited distribution, legalese and other mumbo jumbo.
- <distributionStatement>DISTRIBUTION STATEMENT: Feel free to give this document to anyone you will take it.</distributionStatement>-->
+ <execution>
+ <id>pdf-server</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>pdf</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+ <includeReports>false</includeReports>
+ <docDescriptor>src/site/pdf-server.xml</docDescriptor>
- <!-- optional, these header/footer definitions are used on all pages exception the title page -->
- <pdfFooter>Version ${project.version}
- ${timestamp}</pdfFooter>
- <pdfHeader>jUDDI Server Guide</pdfHeader>
+ <pdfFooter>Version ${project.version}
+ ${timestamp}</pdfFooter>
+ <pdfHeader>jUDDI Server Guide</pdfHeader>
+
- <!-- optional, the cover page can have a pom defined date too
- <pdfCoverDate>1970-1-1</pdfCoverDate>-->
-
- <!-- optional, the max depth of the TOC -->
- <tocMaxDepthToPrint>4</tocMaxDepthToPrint>
- <!-- optional, you can override any of the colors, fonts, padding etc with your own file here
- <foStylesOverride>src/main/resources/fo-styles_1.xslt</foStylesOverride>-->
- </configuration>
- </execution>
-
- </executions>
- </plugin>
+ </configuration>
+ </execution>
+
+ </executions>
+ </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -1082,7 +1050,7 @@ under the License.
</execution>
</executions>
</plugin>
-
+ <!--
<plugin>
<groupId>com.coderplus.maven.plugins</groupId>
<artifactId>copy-rename-maven-plugin</artifactId>
@@ -1124,7 +1092,7 @@ under the License.
</execution>
</executions>
</plugin>
-
+ -->
<!-- Create a source-release artifact that contains the fully buildable
diff --git a/src/site/pdf-client.xml b/src/site/pdf-client.xml
index 8138f33c5..1e90fd21d 100644
--- a/src/site/pdf-client.xml
+++ b/src/site/pdf-client.xml
@@ -21,7 +21,7 @@ under the License.
outputName="juddi-client-guide" xmlns="http://maven.apache.org/DOCUMENT/1.0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<meta>
<title>Apache jUDDI Client Guide</title>
-<author>Alex O'Ree</author>
+<author>Apache Software Foundation</author>
</meta>
<!-- depth of the TOC can be controlled by adding a depth attribute-->
<toc name="Table of Contents">
@@ -49,7 +49,7 @@ outputName="juddi-client-guide" xmlns="http://maven.apache.org/DOCUMENT/1.0.1" x
<projectLogo>images\logo.png</projectLogo>
<companyName>The Apache Software Foundation</companyName>
<companyLogo>http://www.apache.org/images/asf_logo_wide.png</companyLogo>
-<author>Alex O'Ree, alexoree@apache.org</author>
+<author>Apache jUDDI Team</author>
</cover>
</document>
diff --git a/src/site/pdf-server.xml b/src/site/pdf-server.xml
index c919e9d82..3bd98c2a2 100644
--- a/src/site/pdf-server.xml
+++ b/src/site/pdf-server.xml
@@ -21,7 +21,7 @@ under the License.
outputName="juddi-server-guide" xmlns="http://maven.apache.org/DOCUMENT/1.0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<meta>
<title>Apache jUDDI Server Guide</title>
-<author>Alex O'Ree</author>
+<author>Apache Software Foundation</author>
</meta>
<!-- depth of the TOC can be controlled by adding a depth attribute-->
<toc name="Table of Contents">
@@ -51,7 +51,7 @@ outputName="juddi-server-guide" xmlns="http://maven.apache.org/DOCUMENT/1.0.1" x
<projectLogo>images\logo.png</projectLogo>
<companyName>The Apache Software Foundation</companyName>
<companyLogo>http://www.apache.org/images/asf_logo_wide.png</companyLogo>
-<author>Alex O'Ree, alexoree@apache.org</author>
+<author>Apache jUDDI Team</author>
</cover>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org
[juddi] 04/08: Merge branch 'master' into feature/JUDDI-978
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a commit to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
commit 25a86acaed152606a730444f57845a7afe5379dc
Merge: 47accac9a e01bc27ae
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Sun Apr 17 11:45:16 2022 -0400
Merge branch 'master' into feature/JUDDI-978
# Conflicts:
# docs/asciidoc/ClientGuide/pom.xml
# docs/asciidoc/Guide/pom.xml
# docs/asciidoc/pom.xml
# pom.xml
.github/dependabot.yml | 11 ++
.github/workflows/codeql-analysis.yml | 72 +++++++
RELEASE_NOTES.html | 42 +++-
docs/dist/pom.xml | 2 +-
docs/pom.xml | 2 +-
juddi-client-cli/pom.xml | 4 +-
.../org/apache/juddi/v3/client/cli/WadlImport.java | 2 +-
.../org/apache/juddi/v3/client/cli/WsdlImport.java | 2 +-
juddi-client/pom.xml | 2 +-
.../org/apache/juddi/v3/client/UDDIConstants.java | 2 +
.../apache/juddi/v3/client/config/UDDIClient.java | 4 +
.../v3/client/config/UDDIClientContainer.java | 4 +
.../juddi/v3/client/mapping/MapUDDIv2Tov3.java | 28 +--
.../juddi/v3/client/mapping/MapUDDIv3Tov2.java | 99 +++++-----
.../juddi/v3/client/mapping/ServiceLocator.java | 62 ++++--
.../juddi/v3/client/transport/RMITransport.java | 220 ---------------------
.../juddi/v3/client/transport/Transport.java | 3 +-
.../src/test/resources/META-INF/subscription.xml | 14 +-
juddi-client/src/test/resources/META-INF/uddi.xml | 14 +-
juddi-core-openjpa/pom.xml | 6 +-
juddi-core/pom.xml | 2 +-
.../src/main/java/org/apache/juddi/Registry.java | 27 ---
.../java/org/apache/juddi/config/Property.java | 3 +
.../org/apache/juddi/model/BindingTemplate.java | 2 +
.../java/org/apache/juddi/model/DiscoveryUrl.java | 2 +
.../main/java/org/apache/juddi/model/Email.java | 2 +
.../org/apache/juddi/model/PublisherAssertion.java | 2 +-
.../juddi/model/ReplicationConfiguration.java | 7 +-
.../juddi/model/ReplicationConfigurationNode.java | 2 +-
.../java/org/apache/juddi/model/Signature.java | 2 +-
.../query/FindBusinessByDiscoveryURLQuery.java | 4 +-
.../org/apache/juddi/rmi/JNDIRegistration.java | 154 ---------------
.../java/org/apache/juddi/rmi/JUDDIApiService.java | 196 ------------------
.../java/org/apache/juddi/rmi/RMIRegistration.java | 149 --------------
.../juddi/rmi/UDDICustodyTransferService.java | 66 -------
.../org/apache/juddi/rmi/UDDIInquiryService.java | 108 ----------
.../apache/juddi/rmi/UDDIPublicationService.java | 133 -------------
.../org/apache/juddi/rmi/UDDISecurityService.java | 53 -----
.../juddi/rmi/UDDISubscriptionListenerService.java | 49 -----
.../apache/juddi/rmi/UDDISubscriptionService.java | 71 -------
.../java/org/apache/juddi/rmi/package-info.java | 19 --
.../subscription/notify/JNDI_RMINotifier.java | 91 ---------
.../juddi/subscription/notify/RMINotifier.java | 63 ------
.../org/apache/juddi/validation/ValidateNode.java | 13 +-
.../resources/juddi_install_data/UDDI_tModels.xml | 25 +--
juddi-core/src/main/resources/messages.properties | 2 +-
.../api/impl/API_050_BindingTemplateTest.java | 62 ++++++
...091_RMISubscriptionListenerIntegrationTest.java | 173 ----------------
.../juddi/api/impl/API_110_FindBusinessTest.java | 45 +++++
.../apache/juddi/api/runtime/CLIServerTest.java | 4 +-
.../{juddiTestimpl.java => JuddiTestimpl.java} | 2 +-
.../{replicantImpl.java => ReplicantImpl.java} | 4 +-
.../org/apache/juddi/rmi/JNDIRegistrationTest.java | 58 ------
.../juddi/subscription/notify/NotifierTest.java | 32 +--
juddi-ddl-generator/pom.xml | 46 +++--
.../java/org/apache/juddi/ddl/generator/App.java | 137 ++++++++-----
juddi-dist/pom.xml | 2 +-
juddi-examples/ValueSetValidator/pom.xml | 2 +-
juddi-examples/create-partition/pom.xml | 2 +-
.../partition/SimpleCreateTmodelPartition.java | 2 +-
juddi-examples/hello-world-embedded/pom.xml | 2 +-
.../juddi/example/helloworld/HelloWorld.java | 2 +-
juddi-examples/hello-world/pom.xml | 2 +-
.../juddi/example/helloworld/HelloWorld.java | 2 +-
juddi-examples/juddi-embedded/pom.xml | 2 +-
juddi-examples/more-uddi-samples/pom.xml | 2 +-
.../juddi/samples/BusinessServiceKeymismatch.java | 2 +-
.../apache/juddi/samples/FindBusinessBugHunt.java | 2 +-
.../apache/juddi/samples/JuddiAdminService.java | 4 +-
.../org/apache/juddi/samples/SimpleBrowse.java | 2 +-
.../java/org/apache/juddi/samples/WadlImport.java | 2 +-
.../java/org/apache/juddi/samples/WsdlImport.java | 2 +-
juddi-examples/pom.xml | 2 +-
juddi-examples/service-version/pom.xml | 2 +-
.../service/version/ServiceVersioningExample.java | 2 +-
juddi-examples/simple-browse/pom.xml | 2 +-
.../apache/juddi/example/browse/SimpleBrowse.java | 2 +-
juddi-examples/simple-publish-clerk/pom.xml | 2 +-
juddi-examples/simple-publish-portable/pom.xml | 2 +-
.../example/publish/SimplePublishPortable.java | 2 +-
.../subscription-notification-amqp/pom.xml | 2 +-
juddi-examples/uddi-annotations/pom.xml | 2 +-
juddi-examples/uddiv2-api-bridge-example/pom.xml | 2 +-
.../api/bridge/example/SimpleBrowseUDDIv2.java | 2 +-
juddi-examples/wsdl2uddi-lifecyle/pom.xml | 2 +-
juddi-examples/wsdl2uddi/pom.xml | 2 +-
juddi-gui-dsig/pom.xml | 2 +-
juddi-gui/pom.xml | 2 +-
.../apache/juddi/webconsole/PostBackConstants.java | 1 +
.../org/apache/juddi/webconsole/hub/UddiHub.java | 26 ++-
.../juddi/webconsole/hub/builders/Printers.java | 6 +-
.../juddi/webconsole/resources/web.properties | 2 +
.../juddi/webconsole/resources/web_es.properties | 2 +
juddi-gui/src/main/webapp/about.jsp | 4 +-
juddi-gui/src/main/webapp/advanced.jsp | 4 +-
juddi-gui/src/main/webapp/ajax/businesssearch.jsp | 8 +-
juddi-gui/src/main/webapp/ajax/servicesearch.jsp | 2 +-
juddi-gui/src/main/webapp/ajax/tmodelsearch.jsp | 6 +-
juddi-gui/src/main/webapp/assertions.jsp | 4 +-
juddi-gui/src/main/webapp/bindingChooser.jsp | 3 -
juddi-gui/src/main/webapp/bindingEditor.jsp | 14 +-
juddi-gui/src/main/webapp/businessBrowse.jsp | 9 +-
juddi-gui/src/main/webapp/businessEditor2.jsp | 7 +-
juddi-gui/src/main/webapp/editSubscription.jsp | 4 +-
juddi-gui/src/main/webapp/home.jsp | 4 +-
juddi-gui/src/main/webapp/importFromWadl.jsp | 4 +-
juddi-gui/src/main/webapp/importFromWsdl.jsp | 4 +-
juddi-gui/src/main/webapp/js/bindingeditor.js | 1 -
juddi-gui/src/main/webapp/js/businessEditor.js | 1 +
juddi-gui/src/main/webapp/js/businesssearch.js | 13 +-
juddi-gui/src/main/webapp/js/serviceBrowse.js | 14 +-
juddi-gui/src/main/webapp/js/serviceEditor.js | 8 +-
juddi-gui/src/main/webapp/js/tmodelChooser.js | 16 +-
juddi-gui/src/main/webapp/js/tmodelsearch.js | 99 +++++-----
juddi-gui/src/main/webapp/reginfo.jsp | 4 +-
juddi-gui/src/main/webapp/search.jsp | 4 +-
juddi-gui/src/main/webapp/serviceBrowse.jsp | 94 ++++-----
juddi-gui/src/main/webapp/serviceEditor.jsp | 4 +-
juddi-gui/src/main/webapp/settings.jsp | 4 +-
juddi-gui/src/main/webapp/signer.jsp | 4 +-
juddi-gui/src/main/webapp/subscriptionFeed.jsp | 4 +-
juddi-gui/src/main/webapp/tmodelBrowse.jsp | 109 +++++-----
juddi-gui/src/main/webapp/tmodelChooser.jsp | 4 +-
juddi-gui/src/main/webapp/tmodelEditor.jsp | 4 +-
juddi-gui/src/main/webapp/tmodelPartitions.jsp | 4 +-
juddi-gui/src/main/webapp/transfer.jsp | 4 +-
juddi-gui/src/main/webapp/viewSubscriptions.jsp | 4 +-
juddi-rest-cxf/pom.xml | 2 +-
juddi-tomcat/build.xml | 1 +
juddi-tomcat/context.xml | 15 +-
.../juddi_install_data_node2/UDDI_tModels.xml | 27 +--
.../juddi_install_data_node3/UDDI_tModels.xml | 26 +--
juddi-tomcat/pom.xml | 11 +-
juddiv3-war-repl/pom.xml | 2 +-
juddiv3-war/pom.xml | 2 +-
juddiv3-war/src/main/webapp/admin/mbeans.jsp | 25 +--
pom.xml | 84 ++++++--
qa/juddi-xlt/src/META-INF/uddi.xml | 14 +-
readme.txt | 8 +-
src/site/markdown/committers.md | 2 +-
src/site/markdown/index.md | 10 +-
src/site/markdown/integration.md | 4 +-
src/site/markdown/releases.md | 2 +-
src/site/markdown/security.md | 31 +++
src/site/site.xml | 5 +-
uddi-client-dist/pom.xml | 3 +-
uddi-migration-tool/pom.xml | 2 +-
.../org/apache/juddi/v3/migration/tool/Export.java | 2 +-
.../org/apache/juddi/v3/migration/tool/Import.java | 2 +-
uddi-tck-base/pom.xml | 2 +-
.../java/org/apache/juddi/v2/tck/TckPublisher.java | 5 +-
.../java/org/apache/juddi/v3/tck/TckCommon.java | 23 ++-
.../java/org/apache/juddi/v3/tck/TckPublisher.java | 4 +-
uddi-tck-base/src/main/resources/tck.properties | 2 -
.../subscriptionnotifier/listenerServiceRMI.xml | 43 ----
.../subscriptionnotifier/subscription1RMI.xml | 32 ---
.../subscriptionnotifier/subscription2RMI.xml | 32 ---
.../subscriptionnotifier/subscription3RMI.xml | 32 ---
uddi-tck-runner/pom.xml | 2 +-
.../main/java/org/apache/juddi/tckrunner/App.java | 2 -
uddi-tck-runner/tck.properties | 4 +-
uddi-tck/juddi_install_data_node2/UDDI_tModels.xml | 25 +--
uddi-tck/pom.xml | 4 +-
...091_RMISubscriptionListenerIntegrationTest.java | 186 -----------------
.../juddi/v3/tck/UDDI_090_RMIIntegrationTest.java | 188 ------------------
uddi-ws/pom.xml | 2 +-
166 files changed, 1028 insertions(+), 2824 deletions(-)
diff --cc pom.xml
index 32e797a39,362f4ada3..c2127df59
--- a/pom.xml
+++ b/pom.xml
@@@ -44,12 -43,11 +43,12 @@@ under the License
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<cxf.version>3.3.4</cxf.version>
- <springframework.version>5.2.3.RELEASE</springframework.version>
- <apache.tomcat.version>9.0.30</apache.tomcat.version>
+ <springframework.version>5.2.4.RELEASE</springframework.version>
+ <apache.tomcat.version>9.0.37</apache.tomcat.version>
<jacoco.it.execution.data.file>${project.build.directory}/coverage-reports/jacoco-it.exec</jacoco.it.execution.data.file>
<jacoco.ut.execution.data.file>${project.build.directory}/coverage-reports/jacoco-ut.exec</jacoco.ut.execution.data.file>
-
+ <timestamp>${maven.build.timestamp}</timestamp>
+ <maven.build.timestamp.format>yyyy-MM-dd HH:mm</maven.build.timestamp.format>
</properties>
<issueManagement>
@@@ -936,6 -858,13 +941,13 @@@
<url>https://repo1.maven.org/maven2</url>
<layout>default</layout>
</repository>
+
- <repository>
++ <repository>
+ <id>central1</id>
+ <name>Maven Central Repository</name>
+ <url>https://repo.maven.org/maven2</url>
+ <layout>default</layout>
+ </repository>
<repository>
<id>jboss3</id>
<name>JBoss 3rd Party</name>
@@@ -946,15 -875,55 +958,64 @@@
<profiles>
- <profile>
- <id>prepare-site</id>
- <activation>
- <file>
- <exists>src/site/site.xml</exists>
- </file>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-antrun-plugin</artifactId>
- <dependencies>
- <!-- force the juddi docs module to build -->
- <dependency>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-docs</artifactId>
- <version>${project.version}</version>
- <type>pom</type>
- </dependency>
-
- </dependencies>
- <executions>
- <execution>
- <phase>site</phase>
- <configuration>
- <target>
-
-
- <copy todir="target/site/docs/3.3/juddi-client-guide/">
- <fileset dir="docs/asciidoc/ClientGuide/target/docbook/publish/en-US" />
- </copy>
-
- <copy todir="target/site/docs/3.3/juddi-guide/">
- <fileset dir="docs/asciidoc/Guide/target/docbook/publish/en-US" />
- </copy>
-
- </target>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
-
++ <profile>
++ <id>prepare-site</id>
++ <activation>
++ <file>
++ <exists>src/site/site.xml</exists>
++ </file>
++ </activation>
++ <build>
++ <plugins>
++ <plugin>
++ <groupId>org.apache.maven.plugins</groupId>
++ <artifactId>maven-antrun-plugin</artifactId>
++ <dependencies>
++ <!-- force the juddi docs module to build -->
++ <dependency>
++ <groupId>org.apache.juddi.juddi-docs</groupId>
++ <artifactId>juddi-docs</artifactId>
++ <version>${project.version}</version>
++ <type>pom</type>
++ </dependency>
++
++ </dependencies>
++ <executions>
++ <execution>
++ <phase>site</phase>
++ <configuration>
++ <target>
++
++
++ <copy todir="target/site/docs/3.3/juddi-client-guide/">
++ <fileset dir="docs/asciidoc/ClientGuide/target/docbook/publish/en-US" />
++ </copy>
++
++ <copy todir="target/site/docs/3.3/juddi-guide/">
++ <fileset dir="docs/asciidoc/Guide/target/docbook/publish/en-US" />
++ </copy>
++
++ </target>
++ </configuration>
++ <goals>
++ <goal>run</goal>
++ </goals>
++ </execution>
++ </executions>
++ </plugin>
++ </plugins>
++ </build>
++ </profile>
++
+ <profile>
+ <id>doclint-java8-disable</id>
+ <activation>
+ <jdk>[1.8,)</jdk>
+ </activation>
+ <properties>
+ <javadoc.extra.settings>-Xdoclint:none</javadoc.extra.settings>
+ </properties>
+ </profile>
<!-- inherit from the apache parent: release-profile -->
<profile>
@@@ -1017,7 -986,7 +1078,7 @@@
<plugin>
<inherited>true</inherited>
<groupId>org.apache.maven.plugins</groupId>
-- <artifactId>maven-deploy-plugin</artifactId>
++ <artifactId>maven-deploy-plugin</artifactId>
<configuration>
<updateReleaseInfo>true</updateReleaseInfo>
</configuration>
@@@ -1053,6 -1022,6 +1114,7 @@@
<configuration>
<excludes>
<exclude>**/*.nupkg</exclude>
++ <exclude>.github/**/*.*</exclude>
<exclude>**/*.psd</exclude>
<exclude>**/*.ddl</exclude>
<exclude>Doxyfile</exclude>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org
[juddi] 01/08: JUDDI-978 starting conversion process from docbook to maven pdf plugin. Distriubtion zips need to be updated, unlikely that this commit will build to completion
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexoree pushed a commit to branch feature/JUDDI-978
in repository https://gitbox.apache.org/repos/asf/juddi.git
commit a93f5b942181ba14ba845f1673a3d924b09e7ac8
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Sun Oct 8 11:18:01 2017 -0400
JUDDI-978 starting conversion process from docbook to maven pdf plugin. Distriubtion zips need to be updated, unlikely that this commit will build to completion
---
docs/asciidoc/.gitignore | 6 -
docs/asciidoc/ClientGuide/.gitignore | 6 -
.../ClientGuide/en-US/ClientGuide-docinfo.xml | 56 ---
.../ClientGuide/en-US/ClientGuide.asciidoc | 95 -----
docs/asciidoc/ClientGuide/en-US/Guardfile | 13 -
docs/asciidoc/ClientGuide/en-US/_Sidebar.asciidoc | 15 -
docs/asciidoc/ClientGuide/en-US/asciidoctor.css | 80 -----
docs/asciidoc/ClientGuide/pom.xml | 209 -----------
docs/asciidoc/Guide/.gitignore | 6 -
docs/asciidoc/Guide/en-US/Guardfile | 14 -
docs/asciidoc/Guide/en-US/Guide-docinfo.xml | 56 ---
docs/asciidoc/Guide/en-US/Guide.asciidoc | 107 ------
.../en-US/GuideUDDIRegistryIntroduction.asciidoc | 109 ------
docs/asciidoc/Guide/en-US/_Sidebar.asciidoc | 15 -
docs/asciidoc/Guide/en-US/asciidoctor.css | 80 -----
docs/asciidoc/Guide/pom.xml | 207 -----------
docs/asciidoc/Home.asciidoc | 8 -
docs/asciidoc/Readme.asciidoc | 58 ----
docs/asciidoc/pom.xml | 42 ---
pom.xml | 135 +++++---
src/site/markdown/ClientGuide.md | 9 +
.../site/markdown/ClientGuideKeyFormatTemplates.md | 85 +++--
.../ClientGuideMappingWADLandWSDLtoUDDI.md | 26 +-
.../ClientGuideSimplePublishingUsingthejUDDIAPI.md | 235 ++++++-------
.../site/markdown/ClientGuideTCKRunner.md | 40 +--
.../site/markdown/ClientGuideUDDIMigrationTool.md | 30 +-
.../site/markdown/ClientGuideUDDIv2Services.md | 25 +-
...deUsingUDDIAnnotationstoAutomateRegistration.md | 72 ++--
.../markdown/ClientGuideUsingjUDDIRestServices.md | 93 ++---
.../site/markdown/ClientGuideUsingthejUDDIGUI.md | 221 ++++--------
.../ClientGuidejUDDIClientConfigurationGuide.md | 100 +++---
.../site/markdown/ClientGuidejUDDIClientforNET.md | 28 +-
src/site/markdown/Guide.md | 9 +
.../site/markdown/GuideAdministration.md | 385 ++++++++++++---------
.../site/markdown/GuideArchitecture.md | 37 +-
.../site/markdown/GuideConfigurationServer.md | 175 +++++-----
.../site/markdown/GuideContributingtojUDDI.md | 89 ++---
.../site/markdown/GuideExtendingUDDI.md | 35 +-
.../site/markdown/GuideGettingStarted.md | 81 ++---
.../site/markdown/GuideHowToDeployjUDDITo.md | 151 ++++----
.../site/markdown/GuideReplication.md | 52 +--
.../site/markdown/GuideRootSeedData.md | 47 ++-
.../site/markdown/GuideTroubleshootingjUDDI.md | 24 +-
src/site/markdown/GuideUDDIRegistryIntroduction.md | 101 ++++++
.../site/markdown/GuideUDDISubscriptions.md | 77 +++--
.../markdown/GuideUsingDigitalSignaturesinUDDI.md | 12 +-
src/site/pdf-client.xml | 56 +++
src/site/pdf-server.xml | 58 ++++
.../images/GettingStarted-add_publisher.png | Bin
.../images/GettingStarted-authToken_SoapUI.png | Bin
.../images/GettingStarted-create_business.png | Bin
.../images/GettingStarted-create_keygenerator.png | Bin
.../images/GettingStarted-form_login.png | Bin
.../images/GettingStarted-happy_juddi.png | Bin
.../images/GettingStarted-jUDDI_admin.png | Bin
.../images/GettingStarted-jUDDI_welcome.png | Bin
.../images/GettingStarted-juddi_services.png | Bin
.../images/UDDI_Registry_invocation_pattern.png | Bin
.../resources}/images/UDDI_services_overview.png | Bin
.../resources}/images/a_bothup_b_sales_down.png | Bin
.../resources}/images/community/community_doc.png | Bin
.../resources}/images/community/jbossorglogo.png | Bin
.../site/resources}/images/community/title_hdr.png | Bin
.../resources}/images/create_new_subscription.png | Bin
.../site/resources}/images/icon.svg | 0
.../resources}/images/jUDDIArchitecture_Gui.png | Bin
.../images/jUDDIArchitecture_clientAndGui.png | Bin
.../resources}/images/jUDDIArchitecture_server.png | Bin
.../images/jUDDIbyKimWood300x300ish - Copy.png | Bin 0 -> 37799 bytes
.../resources}/images/juddi-admin-configure.png | Bin
.../site/resources}/images/juddi-admin-home.png | Bin
.../resources}/images/juddi-admin-juddiapi.png | Bin
.../site/resources}/images/juddi-admin-mbeans.png | Bin
.../site/resources}/images/juddi-admin-stats.png | Bin
.../site/resources}/images/juddi-admin-status.png | Bin
.../images/juddi-gui-browse-business.png | Bin
.../images/juddi-gui-browse-business2.png | Bin
.../resources}/images/juddi-gui-browse-options.png | Bin
.../images/juddi-gui-browse-services.png | Bin
.../resources}/images/juddi-gui-browse-tmodel.png | Bin
.../images/juddi-gui-create-business.png | Bin
.../images/juddi-gui-create-business2.png | Bin
.../images/juddi-gui-create-business3.png | Bin
.../images/juddi-gui-fullbootstrap-menu.png | Bin
.../resources}/images/juddi-gui-import-wsdl.png | Bin
.../resources}/images/juddi-gui-login-warning.png | Bin
.../site/resources}/images/juddi-gui-menu.png | Bin
.../site/resources}/images/juddi-gui-mybuz.png | Bin
.../resources}/images/juddi-gui-nodeswitcher.png | Bin
.../images/juddi-gui-publisherassertion.png | Bin
.../images/juddi-gui-publisherassertion2.png | Bin
.../images/juddi-gui-publisherassertion3.png | Bin
.../site/resources}/images/juddi-gui-search.png | Bin
.../resources}/images/juddi-gui-service-add1.png | Bin
.../resources}/images/juddi-gui-service-add2.png | Bin
.../site/resources}/images/juddi-gui-sign1.png | Bin
.../site/resources}/images/juddi-gui-sign2.png | Bin
.../resources}/images/juddi-gui-signed-invalid.png | Bin
.../resources}/images/juddi-gui-signed-valid.png | Bin
.../resources}/images/juddi-gui-signerpanel1.png | Bin
.../resources}/images/juddi-gui-signerpanel2.png | Bin
.../resources}/images/juddi-gui-signerpanel3.png | Bin
.../images/juddi-gui-subscription-view.png | Bin
.../resources}/images/juddi-gui-subscription1.png | Bin
.../resources}/images/juddi-gui-subscription2.png | Bin
.../resources}/images/juddi-gui-subscription2a.png | Bin
.../resources}/images/juddi-gui-subscription3.png | Bin
.../resources}/images/juddi-gui-subscription4.png | Bin
.../resources}/images/juddi-gui-subscription5.png | Bin
.../resources}/images/juddi-gui-subscription6.png | Bin
.../images/juddi-gui-tabletbootstrap-menu.png | Bin
.../resources}/images/juddi-gui-tmodel-keygen.png | Bin
.../site/resources}/images/juddi-gui-transfer.png | Bin
.../site/resources}/images/juddi-gui-welcome.png | Bin
.../images/marketing_node_installation.png | Bin
.../site/resources}/images/marketing_services.png | Bin
.../resources}/images/newly_saved_subscription.png | Bin
...L_response_synchronous_subscription_request.png | Bin
.../images/registration_by_annotation.png | Bin
.../resources}/images/registry_info_helloworld.png | Bin
.../resources}/images/sales_node_installation.png | Bin
.../site/resources}/images/sales_services.png | Bin
.../site/resources}/images/set_coverage_period.png | Bin
.../resources}/images/subscriptions_portal.png | Bin
.../resources}/images/uddi_core_datastructures.gif | Bin
src/site/site.xml | 38 ++
126 files changed, 1423 insertions(+), 2285 deletions(-)
diff --git a/docs/asciidoc/.gitignore b/docs/asciidoc/.gitignore
deleted file mode 100644
index c1a69fdf9..000000000
--- a/docs/asciidoc/.gitignore
+++ /dev/null
@@ -1,6 +0,0 @@
-target
-**/target/*
-**/derby.log
-**/.project
-**/.classpath
-**/.settings/*
diff --git a/docs/asciidoc/ClientGuide/.gitignore b/docs/asciidoc/ClientGuide/.gitignore
deleted file mode 100644
index c1a69fdf9..000000000
--- a/docs/asciidoc/ClientGuide/.gitignore
+++ /dev/null
@@ -1,6 +0,0 @@
-target
-**/target/*
-**/derby.log
-**/.project
-**/.classpath
-**/.settings/*
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuide-docinfo.xml b/docs/asciidoc/ClientGuide/en-US/ClientGuide-docinfo.xml
deleted file mode 100644
index 65e035757..000000000
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuide-docinfo.xml
+++ /dev/null
@@ -1,56 +0,0 @@
- <authorgroup>
-
-Â <author>
-Â Â <firstname>Kurt</firstname>
-Â Â <surname>Stam</surname>
- <othername role='mi'>T</othername>
- <affiliation>
- <shortaffil>RedHat</shortaffil>
- <jobtitle>Enterprise Integration Magician (EIM)</jobtitle>
- <orgname>Red Hat, Inc.</orgname>
- <orgdiv><ulink url="http://www.jboss.org/overlord">SOA Governance</ulink></orgdiv>
- <authorblurb>
- <para>
- Open Source, written by domain experts.
- </para>
- </authorblurb>
-
- </affiliation>
-
-Â </author>
-
- <author>
- Â Â <firstname>Alex</firstname>
- Â Â <surname>O'Ree</surname>
- <affiliation>
- <shortaffil>Apache Software Foundation (ASF)</shortaffil>
- <orgname>Apache Software Foundation (ASF), http://juddi.apache.org</orgname>
- </affiliation>
- Â </author>
-
- </authorgroup>
-
- <copyright>
- Â <year>2003-2014</year>
- <holder>The Apache Software Foundation</holder>
- </copyright>
-
- <legalnotice>
- <simpara>
-Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
-</simpara>
-<simpara>
- You may obtain a copy of the License at
-
- <ulink url="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</ulink>
-</simpara>
-<simpara>
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- </simpara>
-</legalnotice>
-
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuide.asciidoc b/docs/asciidoc/ClientGuide/en-US/ClientGuide.asciidoc
deleted file mode 100644
index c78850029..000000000
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuide.asciidoc
+++ /dev/null
@@ -1,95 +0,0 @@
-Apache jUDDI Client and GUI Guide
-=================================
-:doctype: book
-:backend: docbook5
-:docinfo:
-
-[dedication]
-Dedication
-----------
-We'd like to dedicate this guide to Steve Viens and Andy Cutright who started this project back in 2003.
-
-[preface]
-Preface
--------
-The jUDDI client framework facilitates interaction with any UDDI v3 compliant registry. In addition to providing a client framework for both Java and .NET, it also provides a self proclaimed Technical Compatilibity Test (TCK) Suite. The jUDDI community encourages collabration of other vendors on the TCK or on the client framework in general.
-
-include::ClientGuideSimplePublishingUsingthejUDDIAPI.asciidoc[]
-
-include::ClientGuidejUDDIClientConfigurationGuide.asciidoc[]
-
-include::ClientGuideKeyFormatTemplates.asciidoc[]
-
-include::ClientGuideUsingthejUDDIGUI.asciidoc[]
-
-include::ClientGuideMappingWADLandWSDLtoUDDI.asciidoc[]
-
-include::ClientGuideUsingUDDIAnnotationstoAutomateRegistration.asciidoc[]
-
-include::ClientGuideUDDIv2Services.asciidoc[]
-
-include::ClientGuideUDDIMigrationTool.asciidoc[]
-
-include::ClientGuideUsingjUDDIRestServices.asciidoc[]
-
-include::ClientGuidejUDDIClientforNET.asciidoc[]
-
-include::ClientGuideTCKRunner.asciidoc[]
-
-:numbered!:
-
-////
-/* commented out till we start using it */
-[appendix]
-Example Appendix
-----------------
-One or more optional appendixes go here at section level 1.
-
-Appendix Sub-section
-~~~~~~~~~~~~~~~~~~~
-Sub-section body.
-
-
-[bibliography]
-Example Bibliography
---------------------
-The bibliography list is a style of AsciiDoc bulleted list.
-
-[bibliography]
-.Books
-- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
-'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
-ISBN 1-56592-580-7.
-
-[bibliography]
-.Articles
-- [[[abc2003]]] Gall Anonim. 'An article', Whatever. 2003.
-
-[glossary]
-Example Glossary
-----------------
-Glossaries are optional. Glossaries entries are an example of a style
-of AsciiDoc labeled lists.
-
-[glossary]
-A glossary term::
-The corresponding (indented) definition.
-
-A second glossary term::
-The corresponding (indented) definition.
-
-
-[colophon]
-Example Colophon
-----------------
-Text at the end of a book describing facts about its production.
-////
-
-
-[index]
-Index
------
-////////////////////////////////////////////////////////////////
-The index is normally left completely empty, it's contents being
-generated automatically by the DocBook toolchain.
-////////////////////////////////////////////////////////////////
diff --git a/docs/asciidoc/ClientGuide/en-US/Guardfile b/docs/asciidoc/ClientGuide/en-US/Guardfile
deleted file mode 100755
index 8d82d8982..000000000
--- a/docs/asciidoc/ClientGuide/en-US/Guardfile
+++ /dev/null
@@ -1,13 +0,0 @@
-require 'asciidoctor'
-require 'erb'
-require 'fileutils'
-
-FileUtils.mkdir_p('build')
-FileUtils.cp_r('../../images','build')
-FileUtils.cp_r('asciidoctor.css','build')
-
-guard 'shell' do
- watch (/^.*\.asciidoc$/) {|m|
- Asciidoctor.render_file(m[0], :to_dir => "build" )
- }
-end
diff --git a/docs/asciidoc/ClientGuide/en-US/_Sidebar.asciidoc b/docs/asciidoc/ClientGuide/en-US/_Sidebar.asciidoc
deleted file mode 100644
index 5d8935889..000000000
--- a/docs/asciidoc/ClientGuide/en-US/_Sidebar.asciidoc
+++ /dev/null
@@ -1,15 +0,0 @@
-.Contents
-****
-link:ClientGuideSimplePublishingUsingthejUDDIAPI[Simple Publishing] +
-link:ClientGuidejUDDIClientConfigurationGuide[Configuration] +
-link:ClientGuideKeyFormatTemplates[Key Format] +
-link:ClientGuideUsingthejUDDIGUI[Using the jUDDI GUI] +
-link:ClientGuideMappingWADLandWSDLtoUDDI[WSDL to UDDI] +
-link:ClientGuideUsingUDDIAnnotationstoAutomateRegistration[UDDI Annotations] +
-link:ClientGuideUDDIv2Services[UDDI v2] +
-link:ClientGuideUDDIMigrationTool[UDDI Migration Tool] +
-link:ClientGuideUsingjUDDIRestServices[REST Services] +
-link:ClientGuidejUDDIClientforNET[.NET Client] +
-link:ClientGuideTCKRunner[TCK]
-****
-link:GuideReadme[Readme] +
diff --git a/docs/asciidoc/ClientGuide/en-US/asciidoctor.css b/docs/asciidoc/ClientGuide/en-US/asciidoctor.css
deleted file mode 100644
index ce16cff0e..000000000
--- a/docs/asciidoc/ClientGuide/en-US/asciidoctor.css
+++ /dev/null
@@ -1,80 +0,0 @@
-@import url("documentation.css");
-@import url("docnav.css");
-@import url("reports.css");
-@import url("extensions.css");
-@import url("codehighlight.css");
-
-body {
- background-image:url(../images/community/bkg_gradient.gif);
- background-repeat:repeat-x;
- margin:0 auto;
- font-family:'Lucida Grande', Geneva, Verdana, Arial, sans-serif;
- font-size:12px;
- max-width:55em;
- padding:0em 2em;
- color:#333;
- line-height:150%;
- text-align:justify;
-}
-
-/* Links */
-
-a:link {color:#0066cc;}
-
-a:visited {color:#6699cc;}
-
-div.longdesc-link {
- float:right;
- color:#999;
-}
-
-/* Headings */
-
-h1, h2, h3, h4, h5, h6 {
- color:#4a5d75;
- line-height:130%;
- margin-top:0em;
- font-family:'Lucida Grande', Geneva, Verdana, Arial, sans-serif;
- background-color:transparent;
-}
-
-h1 {
- background-image:url(../images/community/title_hdr.png);
- background-repeat:no-repeat;
- border-top:1px dotted #CCCCCC;
- line-height:1.2em;
- color:#182737;
- font-size:2em;
- padding:1.5em;
-}
-
-h2 {font-size:1.6em;}
-
-h3 {
- font-size:1.3em;
- padding-top:0em;
- padding-bottom:0em;
-}
-
-h4 {
- font-size:1.1em;
- padding-top:0em;
- padding-bottom:0em;
-}
-
-h5.formalpara {
- font-size:1em;
- margin-top:2em;
- margin-bottom:.8em;
-}
-
-/* Element rules */
-
-hr {
- border-collapse:collapse;
- border-style:none;
- border-top:1px dotted #ccc;
- width:100% !important;
-}
-
-sup {color:#999;}
diff --git a/docs/asciidoc/ClientGuide/pom.xml b/docs/asciidoc/ClientGuide/pom.xml
deleted file mode 100644
index 9ef4c1b67..000000000
--- a/docs/asciidoc/ClientGuide/pom.xml
+++ /dev/null
@@ -1,209 +0,0 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-<!--
- * Copyright 2001-2009 The Apache Software Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */ -->
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-guide-parent</artifactId>
- <version>3.3.5-SNAPSHOT</version>
- </parent>
- <artifactId>juddi-client-guide</artifactId>
- <packaging>jdocbook</packaging>
- <name>jUDDI Client Guide</name>
- <description>The documentation for the Apache jUDDI Client and the UDDI TCK</description>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <version>0.1.4</version>
- <executions>
- <execution>
- <id>output-docbook</id>
- <phase>generate-resources</phase>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <sourceDirectory>en-US</sourceDirectory>
- <outputDirectory>target/docbook/en-US</outputDirectory>
- <imagesDir>.</imagesDir>
- <backend>docbook5</backend>
- <doctype>book</doctype>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.8</version>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt-ns</artifactId>
- <version>3.0.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-jdocbook-style</artifactId>
- <type>jdocbook-style</type>
- <version>3.0.0</version>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDocumentName>ClientGuide.xml</sourceDocumentName>
- <sourceDirectory>target/docbook/</sourceDirectory>
- <imageResource>
- <directory>${project.parent.basedir}/</directory>
- <includes>
- <include>images/*</include>
- <include>images/community/*</include>
- </includes>
- </imageResource>
-
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pressgang/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pressgang/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
-
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pressgang/pdf.xsl</stylesheetResource>
- <finalName>jUDDI_Guide.pdf</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- <pluginManagement>
- <plugins>
- <!--This plugin's configuration is used to store Eclipse m2e settings only. It has no influence on the
- Maven build itself. -->
- <plugin>
- <groupId>org.eclipse.m2e</groupId>
- <artifactId>lifecycle-mapping</artifactId>
- <version>1.0.0</version>
- <configuration>
- <lifecycleMappingMetadata>
- <pluginExecutions>
- <pluginExecution>
- <pluginExecutionFilter>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <versionRange>[0.1.1,)</versionRange>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- </pluginExecutionFilter>
- <action>
- <ignore />
- </action>
- </pluginExecution>
- <pluginExecution>
- <pluginExecutionFilter>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <versionRange>[2.3.8,)</versionRange>
- <goals>
- <goal>generate</goal>
- <goal>resources</goal>
- </goals>
- </pluginExecutionFilter>
- <action>
- <ignore />
- </action>
- </pluginExecution>
- </pluginExecutions>
- </lifecycleMappingMetadata>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
- <profiles>
- <!-- START SNIPPET: release-profile -->
- <!-- this is borrowed from an nov 2009 apache-7 pom release attempt-->
- <profile>
- <id>apache-release</id>
- <build>
- <plugins>
- <!-- Create a source-release artifact that contains the fully buildable
- project directory source structure. This is the artifact which is
- the official subject of any release vote. -->
- <plugin>
- <artifactId>maven-assembly-plugin</artifactId>
- <dependencies>
- <dependency>
- <groupId>org.apache.apache.resources</groupId>
- <artifactId>apache-source-release-assembly-descriptor</artifactId>
- <version>1.0.1</version>
- </dependency>
- <dependency>
- <!-- NOTE: The fix for PLXUTILS-120 is crucial for the new assembly descriptor -->
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-utils</artifactId>
- <version>2.0.1</version>
- </dependency>
- </dependencies>
- <executions>
- <execution>
- <id>source-release-assembly</id>
- <phase>package</phase>
- <goals>
- <goal>single</goal>
- </goals>
- <configuration>
- <runOnlyAtExecutionRoot>true</runOnlyAtExecutionRoot>
- <descriptorRefs>
- <descriptorRef>${sourceReleaseAssemblyDescriptor}</descriptorRef>
- </descriptorRefs>
- <tarLongFileFormat>gnu</tarLongFileFormat>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
- <!-- END SNIPPET: release-profile -->
- </profiles>
-</project>
diff --git a/docs/asciidoc/Guide/.gitignore b/docs/asciidoc/Guide/.gitignore
deleted file mode 100644
index c1a69fdf9..000000000
--- a/docs/asciidoc/Guide/.gitignore
+++ /dev/null
@@ -1,6 +0,0 @@
-target
-**/target/*
-**/derby.log
-**/.project
-**/.classpath
-**/.settings/*
diff --git a/docs/asciidoc/Guide/en-US/Guardfile b/docs/asciidoc/Guide/en-US/Guardfile
deleted file mode 100755
index 9aa8a7412..000000000
--- a/docs/asciidoc/Guide/en-US/Guardfile
+++ /dev/null
@@ -1,14 +0,0 @@
-require 'asciidoctor'
-require 'erb'
-require 'fileutils'
-
-FileUtils.mkdir_p('build')
-FileUtils.cp_r('../../images','build')
-FileUtils.cp_r('asciidoctor.css','build')
-
-guard 'shell' do
- watch (/^.*\.asciidoc$/) {|m|
- Asciidoctor.render_file(m[0], :to_dir => "build" )
- FileUtils.cp_r('../../images','build')
- }
-end
diff --git a/docs/asciidoc/Guide/en-US/Guide-docinfo.xml b/docs/asciidoc/Guide/en-US/Guide-docinfo.xml
deleted file mode 100644
index 65e035757..000000000
--- a/docs/asciidoc/Guide/en-US/Guide-docinfo.xml
+++ /dev/null
@@ -1,56 +0,0 @@
- <authorgroup>
-
-Â <author>
-Â Â <firstname>Kurt</firstname>
-Â Â <surname>Stam</surname>
- <othername role='mi'>T</othername>
- <affiliation>
- <shortaffil>RedHat</shortaffil>
- <jobtitle>Enterprise Integration Magician (EIM)</jobtitle>
- <orgname>Red Hat, Inc.</orgname>
- <orgdiv><ulink url="http://www.jboss.org/overlord">SOA Governance</ulink></orgdiv>
- <authorblurb>
- <para>
- Open Source, written by domain experts.
- </para>
- </authorblurb>
-
- </affiliation>
-
-Â </author>
-
- <author>
- Â Â <firstname>Alex</firstname>
- Â Â <surname>O'Ree</surname>
- <affiliation>
- <shortaffil>Apache Software Foundation (ASF)</shortaffil>
- <orgname>Apache Software Foundation (ASF), http://juddi.apache.org</orgname>
- </affiliation>
- Â </author>
-
- </authorgroup>
-
- <copyright>
- Â <year>2003-2014</year>
- <holder>The Apache Software Foundation</holder>
- </copyright>
-
- <legalnotice>
- <simpara>
-Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
-</simpara>
-<simpara>
- You may obtain a copy of the License at
-
- <ulink url="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</ulink>
-</simpara>
-<simpara>
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- </simpara>
-</legalnotice>
-
diff --git a/docs/asciidoc/Guide/en-US/Guide.asciidoc b/docs/asciidoc/Guide/en-US/Guide.asciidoc
deleted file mode 100644
index 35c00648f..000000000
--- a/docs/asciidoc/Guide/en-US/Guide.asciidoc
+++ /dev/null
@@ -1,107 +0,0 @@
-Apache jUDDI Guide
-==================
-:doctype: book
-:backend: docbook5
-:docinfo:
-
-[dedication]
-Dedication
-----------
-We'd like to dedicate this guide to Steve Viens and Andy Cutright who started this project back in 2003.
-
-[preface]
-Preface
--------
-The jUDDI project maintains a UDDIv3 registry that can be deployed to most modern JEE application servers. The jUDDI project is part of the Apache Software Foundation and encourages participation. It is easy to participate and if you discover a simple typo or would like to contribute to this guide in general please read the README page (add link).
-
-include::GuideUDDIRegistryIntroduction.asciidoc[]
-
-include::GuideGettingStarted.asciidoc[]
-
-include::GuideArchitecture.asciidoc[]
-
-include::GuideAdministration.asciidoc[]
-
-include::GuideConfigurationServer.asciidoc[]
-
-include::GuideReplication.asciidoc[]
-
-include::GuideRootSeedData.asciidoc[]
-
-include::GuideHowToDeployjUDDITo.asciidoc[]
-
-include::GuideExtendingUDDI.asciidoc[]
-
-include::GuideUsingDigitalSignaturesinUDDI.asciidoc[]
-
-include::GuideTroubleshootingjUDDI.asciidoc[]
-
-include::GuideContributingtojUDDI.asciidoc[]
-
-
-:numbered!:
-
-////
-/* commenting out till we need it */
-[appendix]
-Example Appendix
-----------------
-One or more optional appendixes go here at section level 1.
-
-Appendix Sub-section
-~~~~~~~~~~~~~~~~~~~
-Sub-section body.
-////
-
-[bibliography]
-Bibliography
-------------
-
-[bibliography]
-.Books
-- [[[graham-Davis-et-all]]] Steve Graham, Doug Davis et all.
-'Building Web Services with Java - Making sense of XML, SOAP, WSDL, and UDDI'. Second Edition. Sams Publishing. 2005.
-ISBN 0-672-32641-8.
-- [[[stam-oree]]] Kurt Stam, Alex O'Ree et all.
-'jUDDI Client and GUI Guide'. 2014.
-
-[bibliography]
-.Articles
-- [[[uddi-v3]]] OASIS. 'https://www.oasis-open.org/standards#uddiv3.0.2'. 2003.
-
-[bibliography]
-.WebSites
-- [[[uddi-xml-org]]] UDDI XML.org Editorial Board. 'http://uddi.xml.org/'. 2014.
-- [[[uddi-oasis-open-org]]] OASIS. 'https://www.oasis-open.org/standards#uddiv3.0.2'. 2003.
-
-
-////
-/* commenting out till we need it */
-[glossary]
-Example Glossary
-----------------
-Glossaries are optional. Glossaries entries are an example of a style
-of AsciiDoc labeled lists.
-
-[glossary]
-A glossary term::
-The corresponding (indented) definition.
-
-A second glossary term::
-The corresponding (indented) definition.
-
-
-[colophon]
-Example Colophon
-----------------
-Text at the end of a book describing facts about its production.
-
-////
-
-[index]
-Index
------
-////////////////////////////////////////////////////////////////
-The index is normally left completely empty, it's contents being
-generated automatically by the DocBook toolchain.
-////////////////////////////////////////////////////////////////
diff --git a/docs/asciidoc/Guide/en-US/GuideUDDIRegistryIntroduction.asciidoc b/docs/asciidoc/Guide/en-US/GuideUDDIRegistryIntroduction.asciidoc
deleted file mode 100644
index 4bfb38280..000000000
--- a/docs/asciidoc/Guide/en-US/GuideUDDIRegistryIntroduction.asciidoc
+++ /dev/null
@@ -1,109 +0,0 @@
-[[UDDI-Registry-Introduction]]
-== Universal Description, Discovery and Integration (UDDI)
-
-=== UDDI Protocol, Specification
-
-The Universal Description, Discovery and Integration (UDDI) protocol is one of the major building blocks required for successful Web services. UDDI creates a standard interoperable platform that enables companies and applications to quickly, easily, and dynamically find and use Web services over the Internet (or Intranet). UDDI also allows operational registries to be maintained for different purposes in different contexts. UDDI is a cross-industry effort driven by major platform and sof [...]
-
-=== UDDI Registry
-
-The UDDI Registry (((UDDI,registry))) implements the UDDI specification (((UDDI,specification))). UDDI is a Web-based _distributed_ _directory_ (((directory))) that enables businesses to list themselves on the Internet (or Intranet) and discover each other, similar to a traditional phone book's yellow and white pages. The UDDI registry is both a white pages business directory and a technical specifications library. The Registry is designed to store information about Businesses and Servic [...]
-
-[[figure-UDDIREG-InvocationPattern]]
-.Invocation Pattern using the UDDI Registry
-image::images/UDDI_Registry_invocation_pattern.png[Invocation Pattern using the UDDI Registry]
-
-In step 1 of <<figure-UDDIREG-InvocationPattern>> it is shown how a business publishes services to the UDDI registry. In step 2, a client looks up the service in the registry and receives service binding information. Finally in step 3, the client then uses the binding information to invoke the service. The UDDI APIs are SOAP based for interoperability reasons. In this example we've three APIs specified in the UDDI v3 specification, Security, Publication and Inquiry. The UDDI v3 specifica [...]
-
-. UDDI_Security_PortType, defines the API to obtain a security token. With a valid security token a publisher can publish to the registry. A security token can be used for the entire session.
-. UDDI_Publication_PortType, defines the API to publish business and service information to the UDDI registry.
-. UDDI_Inquiry_PortType, defines the API to query the UDDI registry. Typically this API does not require a security token.
-. UDDI_CustodyTransfer_PortType, this API can be used to transfer the custody of a business from one UDDI node to another.
-. UDDI_Subscription_PortType, defines the API to register for updates on a particular business of service.
-. UDDI_SubscriptionListener_PortType, defines the API a client must implement to receive subscription notifications from a UDDI node.
-. UDDI_Replication_PortType, defines the API to replicate registry data between UDDI nodes.
-. UDDI_ValueSetValidation_PortType, by nodes to allow external providers of value set validation. Web services to assess whether keyedReferences or keyedReferenceGroups are valid.
-. UDDI_ValueSetCaching_PortType, UDDI nodes may perform validation of publisher references themselves using the cached values obtained from such a Web service.
-
-=== jUDDI Project
-
-Apache jUDDI is server and client-side implementation of the UDDI v3 specification. The server side is the UDDI Registry, the client side are the juddi-client libraries. There is a Java as well as a C# version of the client libraries. The jUDDI GUI uses the client libraries to connect to a UDDI Registry. For more details please see the <<GuideGettingStarted#chapter-GettingStarted>>.
-
-The following is a list of all supported UDDI interfaces provided by this release of jUDDI
-
-.Supported UDDI Interfaces
-[options="header"]
-|========================================================
-| API | Spec | Supported | Notes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908076[Inquiry] | Required | All Methods |
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908158[Inquiry HTTP GET] | Optional | All Methods | Plus a number of additional methods
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908095[Publication] | Required | All Methods |
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908115[Security] | Optional | All Methods | Pluggable authentication
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908128[Subscription] | Optional | All Methods | HTTP, SMTP delivery implemented, pluggable
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908336[Subscription Listener] |Optional | All Methods | Client and Server side implementations
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908141[Value Set Caching] | Optional | Partial | Scheduled for 3.3
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908141[Value Set Validation] | Optional | Implemented | Scheduled for 3.3
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908180[Replication] | Optional | Partial | Scheduled for 3.3
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908118[Custody and Ownership Transfer] | Optional | All Methods | Only supports user to user transfers on the same node
-| http://uddi.org/pubs/ProgrammersAPI-V2.04-Published-20020719.htm#_Toc25137711[UDDIv2 Inquiry] | Required | BETA | Supported via API translator
-| http://uddi.org/pubs/ProgrammersAPI-V2.04-Published-20020719.htm#_Toc25137722[UDDIv2 Publish] | Required | BETA | Supported via API translator
-
-|========================================================
-
-The following is a list of other features of interest that was either defined in the UDDI specifications or in technical notes.
-
-.jUDDI Features
-[options="header"]
-|========================================================
-| API | Spec | Supported | Notes
-|Digital Signatures | Server req | Full support | Java and .NET clients and in browser signing
-|Client side Subscription Listener | Optional | Full support | Java and .NET clients
-| https://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-tn-wsdl-v2.htm[WSDL to UDDI] | Recommendation| Full support | Java, .NET clients and web GUI
-| https://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-tn-wsdl-v2.htm[WADL to UDDI] | Recommendation| Full support | Java, .NET clients and web GUI
-| https://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-tn-bpel-20040725.htm[BPEL to UDDI] | Recommendation| Full support | Java client
-| UDDI Technical Compliance Kit | - | Full support | Provides a standalone UDDI testing capability
-| Internationalization | Recommendation| Yes | Both end user interfaces (User and Admin web apps) are supported. Error messages from the server are external and can be overwritten.
-| Registration via Annotations | - | Full support | Provides automated registration of classes via Java/.NET Annotations
-|========================================================
-
-UDDI defines a number of http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908080[sorting mechanisms].
-
-.Supported Sort Orders
-[options="header"]
-|========================================================
-| Find Qualifier | Spec | Supported | Notes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#sortOrd[binarySort] | Required | yes |
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#caseInsensSort[caseInsensitiveSort] | Required | party | Only when using caseInsentitiveMatch, https://issues.apache.org/jira/browse/JUDDI-785[JIRA opened]
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908355[caseSensitiveSort] | Required | yes |
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908356[sortByNameAsc] | Required | yes |
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908357[sortByNameDesc] | Required | yes |
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908358[sortByDateAsc] | Required | yes |
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908359[sortByDateDesc] | Required | yes |
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc42047570[JIS-X4061] | Optional | no | Japanese Character Strings
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#UCASort[UTS-10] | Recommended | yes
-|========================================================
-
-UDDI also defines a number of http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908080[Find Qualifiers], which modify the default search behavior of the http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908076[Inquiry] Find* APIs.
-
-.Supported Find Qualifiers
-[options="header"]
-|========================================================
-| Find Qualifier | Spec |Supported
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908360[andAllKeys] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908346[approximateMatch] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908365[bindingSubset] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908348[caseInsensitiveMatch] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908349[caseSensitiveMatch] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908363[combineCategoryBags] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908350[diacriticInsensitiveMatch] | Optional | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908351[diacriticSensitiveMatch] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908347[exactMatch] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908367[signaturePresent] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908361[orAllKeys] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908362[orLikeKeys] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908364[serviceSubset] | Required | yes
-| http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908366[suppressProjectedServices] | Required | yes
-
-|========================================================
-
-
diff --git a/docs/asciidoc/Guide/en-US/_Sidebar.asciidoc b/docs/asciidoc/Guide/en-US/_Sidebar.asciidoc
deleted file mode 100644
index 089a4bf37..000000000
--- a/docs/asciidoc/Guide/en-US/_Sidebar.asciidoc
+++ /dev/null
@@ -1,15 +0,0 @@
-.Contents
-****
-link:GuideUDDIRegistryIntroduction[UDDI Introduction] +
-link:GuideGettingStarted[Getting Started] +
-link:GuideAdministration[Administration] +
-link:GuideConfigurationServer[Server Configuration] +
-link:GuideRootSeedData[Root Seed Data] +
-link:GuideHowToDeployjUDDITo[How to Deploy To?] +
-link:GuideExtendingUDDI[Extending jUDDI] +
-link:GuideUsingDigitalSignaturesinUDDI[Digital Signatures] +
-link:GuideUDDISubscriptions[Subscriptions] +
-link:GuideTroubleshootingjUDDI[Troubleshooting] +
-link:GuideContributingtojUDDI[Contributing] +
-****
-link:Readme[Readme] +
diff --git a/docs/asciidoc/Guide/en-US/asciidoctor.css b/docs/asciidoc/Guide/en-US/asciidoctor.css
deleted file mode 100644
index ce16cff0e..000000000
--- a/docs/asciidoc/Guide/en-US/asciidoctor.css
+++ /dev/null
@@ -1,80 +0,0 @@
-@import url("documentation.css");
-@import url("docnav.css");
-@import url("reports.css");
-@import url("extensions.css");
-@import url("codehighlight.css");
-
-body {
- background-image:url(../images/community/bkg_gradient.gif);
- background-repeat:repeat-x;
- margin:0 auto;
- font-family:'Lucida Grande', Geneva, Verdana, Arial, sans-serif;
- font-size:12px;
- max-width:55em;
- padding:0em 2em;
- color:#333;
- line-height:150%;
- text-align:justify;
-}
-
-/* Links */
-
-a:link {color:#0066cc;}
-
-a:visited {color:#6699cc;}
-
-div.longdesc-link {
- float:right;
- color:#999;
-}
-
-/* Headings */
-
-h1, h2, h3, h4, h5, h6 {
- color:#4a5d75;
- line-height:130%;
- margin-top:0em;
- font-family:'Lucida Grande', Geneva, Verdana, Arial, sans-serif;
- background-color:transparent;
-}
-
-h1 {
- background-image:url(../images/community/title_hdr.png);
- background-repeat:no-repeat;
- border-top:1px dotted #CCCCCC;
- line-height:1.2em;
- color:#182737;
- font-size:2em;
- padding:1.5em;
-}
-
-h2 {font-size:1.6em;}
-
-h3 {
- font-size:1.3em;
- padding-top:0em;
- padding-bottom:0em;
-}
-
-h4 {
- font-size:1.1em;
- padding-top:0em;
- padding-bottom:0em;
-}
-
-h5.formalpara {
- font-size:1em;
- margin-top:2em;
- margin-bottom:.8em;
-}
-
-/* Element rules */
-
-hr {
- border-collapse:collapse;
- border-style:none;
- border-top:1px dotted #ccc;
- width:100% !important;
-}
-
-sup {color:#999;}
diff --git a/docs/asciidoc/Guide/pom.xml b/docs/asciidoc/Guide/pom.xml
deleted file mode 100644
index 2b3b8a2d9..000000000
--- a/docs/asciidoc/Guide/pom.xml
+++ /dev/null
@@ -1,207 +0,0 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-<!--
- * Copyright 2001-2009 The Apache Software Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */ -->
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-guide-parent</artifactId>
- <version>3.3.5-SNAPSHOT</version>
- </parent>
- <artifactId>juddi-guide</artifactId>
- <packaging>jdocbook</packaging>
- <name>jUDDI Guide</name>
- <description>The documentation for the Apache jUDDI project.</description>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <executions>
- <execution>
- <id>output-docbook</id>
- <phase>generate-resources</phase>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <sourceDirectory>en-US</sourceDirectory>
- <outputDirectory>target/docbook/en-US</outputDirectory>
- <imagesDir>.</imagesDir>
- <backend>docbook5</backend>
- <doctype>book</doctype>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt-ns</artifactId>
- <version>3.0.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-jdocbook-style</artifactId>
- <type>jdocbook-style</type>
- <version>3.0.0</version>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDocumentName>Guide.xml</sourceDocumentName>
- <sourceDirectory>target/docbook/</sourceDirectory>
- <imageResource>
- <directory>${project.parent.basedir}/</directory>
- <includes>
- <include>images/*</include>
- <include>images/community/*</include>
- </includes>
- </imageResource>
-
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pressgang/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pressgang/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
-
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pressgang/pdf.xsl</stylesheetResource>
- <finalName>jUDDI_Guide.pdf</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- <pluginManagement>
- <plugins>
- <!--This plugin's configuration is used to store Eclipse m2e settings only. It has no influence on the
- Maven build itself. -->
- <plugin>
- <groupId>org.eclipse.m2e</groupId>
- <artifactId>lifecycle-mapping</artifactId>
- <version>1.0.0</version>
- <configuration>
- <lifecycleMappingMetadata>
- <pluginExecutions>
- <pluginExecution>
- <pluginExecutionFilter>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <versionRange>[0.1.1,)</versionRange>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- </pluginExecutionFilter>
- <action>
- <ignore />
- </action>
- </pluginExecution>
- <pluginExecution>
- <pluginExecutionFilter>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <versionRange>[2.3.8,)</versionRange>
- <goals>
- <goal>generate</goal>
- <goal>resources</goal>
- </goals>
- </pluginExecutionFilter>
- <action>
- <ignore />
- </action>
- </pluginExecution>
- </pluginExecutions>
- </lifecycleMappingMetadata>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
- <profiles>
- <!-- START SNIPPET: release-profile -->
- <!-- this is borrowed from an nov 2009 apache-7 pom release attempt-->
- <profile>
- <id>apache-release</id>
- <build>
- <plugins>
- <!-- Create a source-release artifact that contains the fully buildable
- project directory source structure. This is the artifact which is
- the official subject of any release vote. -->
- <plugin>
- <artifactId>maven-assembly-plugin</artifactId>
- <dependencies>
- <dependency>
- <groupId>org.apache.apache.resources</groupId>
- <artifactId>apache-source-release-assembly-descriptor</artifactId>
- <version>1.0.1</version>
- </dependency>
- <dependency>
- <!-- NOTE: The fix for PLXUTILS-120 is crucial for the new assembly descriptor -->
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-utils</artifactId>
- <version>2.0.1</version>
- </dependency>
- </dependencies>
- <executions>
- <execution>
- <id>source-release-assembly</id>
- <phase>package</phase>
- <goals>
- <goal>single</goal>
- </goals>
- <configuration>
- <runOnlyAtExecutionRoot>true</runOnlyAtExecutionRoot>
- <descriptorRefs>
- <descriptorRef>${sourceReleaseAssemblyDescriptor}</descriptorRef>
- </descriptorRefs>
- <tarLongFileFormat>gnu</tarLongFileFormat>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
- <!-- END SNIPPET: release-profile -->
- </profiles>
-</project>
diff --git a/docs/asciidoc/Home.asciidoc b/docs/asciidoc/Home.asciidoc
deleted file mode 100644
index fb5f981f2..000000000
--- a/docs/asciidoc/Home.asciidoc
+++ /dev/null
@@ -1,8 +0,0 @@
-Welcome to the juddi wiki!
-
-jUDDI User Guide
-~~~~~~~~~~~~~~~~~
-The link:wiki/Guide[jUDDI Guide] and the link:wiki/ClientGuide[jUDDI Client Guide] are written in http://www.methods.co.nz/asciidoc/[asciidoc] and the source is published right in this wiki. So, you can edit the documentation right on master, see the link:wiki/GuideReadme[Readme] for more detail on this. The http://powerman.name/doc/asciidoc[Asciidoc cheat-sheet] is a nice place to start learning about Asciidoc itself.
-
-* Pages that start with "Guide" make up the link:wiki/Guide[jUDDI Guide]
-* Pages that start with "ClientGuide" make up the link:wiki/ClientGuide[jUDDI Client Guide]
diff --git a/docs/asciidoc/Readme.asciidoc b/docs/asciidoc/Readme.asciidoc
deleted file mode 100644
index 1d60722e8..000000000
--- a/docs/asciidoc/Readme.asciidoc
+++ /dev/null
@@ -1,58 +0,0 @@
-How to build the jUDDI Guide Book in Docbook format?
-====================================================
-
-This jUDDI wiki is the source of the jUDDI Guide document. The directory layout of the wiki in this example is
-....
-├── Guide
-│  └── en-US
-│  ├── Guide-docinfo.xml
-│  ├── Guide.asciidoc
-│  ├── GuideDatabase-Connection-Setup.asciidoc
-│  ├── GuideReadme.asciidoc
-│  └── _Sidebar.asciidoc
-├── Home.md
-├── JUDDI.asciidoc
-├── Readme.asciidoc
-├── images
-└── pom.xml
-....
-
-The Guide document is based on the Asciidoc http://www.methods.co.nz/asciidoc/book.txt[book.txt] example, and a Guide-docinfo.xml include file to support more then one author. The http://asciidoctor.org/[AsciiDoctor] maven plugin converts the asciidoc files into an intermediate Docbook format ('Guide.xml'), which then is used as input for _maven-jdocbook-plugin_ to create HTML and PDF versions. If you want to build these yourself you need to check out the repository locally using:
-----
-git clone git@github.com/UDDI/juddi.wiki.git
-----
-and run:
-----
-mvn clean install
-----
-and it will build HTML and PDF versions in the target/docbook/publish/en-US directory.
-
-[qanda]
-.Q&A
-I spotted a typo, can I fix it?::
-Yes please help us maintain the documentation. Simpy update the
-appropriate page right on
-https://github.com/UDDI/juddi/wiki/Guide[github]. Our nightly
-build will distribute the changes to docbook and the html and pdf
-versions.
-
-How do I add an image?::
-Images can not be uploaded through the github UI. Instead you need to add them to the `images` directory in the root of the juddi.wiki repo and then push it up to github. You can then reference your image on the page using `image::images/<myimage>.ext`.
-NOTE: Make sure to add an empty line before and after this image reference.
-
-How do add a numbering and references?::
-You should add a label -we use the convention
-<type>-<chapter>-<label>, i.e.
-`[[figure-UDDIREG-Invocation Pattern]]`- , a title i.e.
-`.Invocation Pattern using the UDDI Registry.` and then the thing itself -for an
-image use something like `image::images/UDDI_Registry_invocation_pattern.png[Invocation Pattern using the UDDI Registry]`. The label `figure-UDDIREG-Invocation Pattern` can be used to link to this figure using
-`<<figure-UDDIREG-Invocation Pattern>>`. The link:GuideUDDIRegistryIntroduction[UDDIRegistryIntroduction] contains an example.
-
-How do I add a chapter to the book in docbook?::
-We add chapters as different files, and then include them in the
-`Guide.asciidoc` file. At docbook generation time it will pull in the
-chapter into the `Guide.xml` file. Also we add a link in the `_Sidebar.asciidoc`
-page to have a link when looking at it at Github in wiki style.
-
-Why are all the files prefixed with `Guide`?::
-The GitHub wiki flattens out the directory structure on the link:_pages[Pages] page. So in order to group all the files of the Guide together we decided to prefix them all with `Guide`.
diff --git a/docs/asciidoc/pom.xml b/docs/asciidoc/pom.xml
deleted file mode 100644
index adb20ec0f..000000000
--- a/docs/asciidoc/pom.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Copyright 2001-2009 The Apache Software Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */ --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-docs</artifactId>
- <version>3.3.5-SNAPSHOT</version>
- </parent>
- <packaging>pom</packaging>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-guide-parent</artifactId>
- <name>jUDDI Guide Parent</name>
- <description>jUDDI (pronounced "Judy") is an open source Java
- implementation of the Universal Description, Discovery, and
- Integration (UDDI) specification for Web Services.</description>
- <url>http://juddi.apache.org/</url>
-
- <prerequisites>
- <maven>3.0.3</maven>
- </prerequisites>
-
- <modules>
- <module>Guide</module>
- <module>ClientGuide</module>
- </modules>
-
-</project>
diff --git a/pom.xml b/pom.xml
index deb2a280e..5eb462d75 100644
--- a/pom.xml
+++ b/pom.xml
@@ -48,7 +48,8 @@ under the License.
<apache.tomcat.version>7.0.82</apache.tomcat.version>
<jacoco.it.execution.data.file>${project.build.directory}/coverage-reports/jacoco-it.exec</jacoco.it.execution.data.file>
<jacoco.ut.execution.data.file>${project.build.directory}/coverage-reports/jacoco-ut.exec</jacoco.ut.execution.data.file>
-
+ <timestamp>${maven.build.timestamp}</timestamp>
+ <maven.build.timestamp.format>yyyy-MM-dd HH:mm</maven.build.timestamp.format>
</properties>
<issueManagement>
@@ -311,7 +312,12 @@ under the License.
<phase>validate</phase>
<configuration>
<rules>
-
+ <requireProperty>
+ <property>java.vendor</property>
+ <message>Oracle JDK is required, sorry</message>
+ <regex>Oracle Corporation</regex>
+ <regexMessage>Oracle JDK is required</regexMessage>
+ </requireProperty>
<requireMavenVersion>
<version>[3.0.3,)</version>
</requireMavenVersion>
@@ -447,6 +453,83 @@ under the License.
</configuration>
</plugin>
+
+ <plugin>
+ <groupId>com.github.spyhunter99</groupId>
+ <artifactId>maven-pdf-plugin</artifactId>
+ <version>1.5.0.5</version>
+ <executions>
+ <execution>
+ <id>pdf-user</id>
+ <phase>site</phase>
+ <goals>
+ <goal>pdf</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+ <includeReports>false</includeReports>
+ <docDescriptor>src/site/pdf-client.xml</docDescriptor>
+
+ <!-- optional, the title of a doc defined in pdf-user that is rendered before the TOC
+ <executiveSummaryName>EXSUM</executiveSummaryName>-->
+ <!-- optional, a header only on the title page-->
+ <titleHeader>Apache Software Foundation</titleHeader>
+
+ <!-- optional, the distribution statement is printed on the title page towards the bottom, common use case:
+ confidentiality statements, limited distribution, legalese and other mumbo jumbo.
+ <distributionStatement>DISTRIBUTION STATEMENT: Feel free to give this document to anyone you will take it.</distributionStatement>
+ -->
+ <!-- optional, these header/footer definitions are used on all pages exception the title page -->
+ <pdfFooter>Apache jUDDI
+ Version ${project.version}
+ ${timestamp}</pdfFooter>
+ <pdfHeader>Apache jUDDI
+ Version ${project.version}
+ ${timestamp}</pdfHeader>
+
+
+ <!-- optional, the max depth of the TOC -->
+ <tocMaxDepthToPrint>4</tocMaxDepthToPrint>
+ </configuration>
+ </execution>
+ <execution>
+ <id>pdf-server</id>
+ <phase>site</phase>
+ <goals>
+ <goal>pdf</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+ <includeReports>false</includeReports>
+ <docDescriptor>src/site/pdf-server.xml</docDescriptor>
+
+ <!-- optional, the title of a doc defined in pdf-user that is rendered before the TOC
+ <executiveSummaryName>EXSUM</executiveSummaryName>-->
+ <!-- optional, a header only on the title page-->
+ <titleHeader>Apache Software Foundation</titleHeader>
+
+ <!-- optional, the distribution statement is printed on the title page towards the bottom, common use case:
+ confidentiality statements, limited distribution, legalese and other mumbo jumbo.
+ <distributionStatement>DISTRIBUTION STATEMENT: Feel free to give this document to anyone you will take it.</distributionStatement>
+ -->
+ <!-- optional, these header/footer definitions are used on all pages exception the title page -->
+ <pdfFooter>Apache jUDDI
+ Version ${project.version}
+ ${timestamp}</pdfFooter>
+ <pdfHeader>Apache jUDDI
+ Version ${project.version}
+ ${timestamp}</pdfHeader>
+
+
+ <!-- optional, the max depth of the TOC -->
+ <tocMaxDepthToPrint>4</tocMaxDepthToPrint>
+ </configuration>
+ </execution>
+
+ </executions>
+ </plugin>
+
+
</plugins>
</build>
<reporting>
@@ -833,54 +916,6 @@ under the License.
<profiles>
- <profile>
- <id>prepare-site</id>
- <activation>
- <file>
- <exists>src/site/site.xml</exists>
- </file>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-antrun-plugin</artifactId>
- <dependencies>
- <!-- force the juddi docs module to build -->
- <dependency>
- <groupId>org.apache.juddi.juddi-docs</groupId>
- <artifactId>juddi-docs</artifactId>
- <version>${project.version}</version>
- <type>pom</type>
- </dependency>
-
- </dependencies>
- <executions>
- <execution>
- <phase>site</phase>
- <configuration>
- <target>
-
-
- <copy todir="target/site/docs/3.3/juddi-client-guide/">
- <fileset dir="docs/asciidoc/ClientGuide/target/docbook/publish/en-US"/>
- </copy>
-
- <copy todir="target/site/docs/3.3/juddi-guide/">
- <fileset dir="docs/asciidoc/Guide/target/docbook/publish/en-US"/>
- </copy>
-
- </target>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
<profile>
<id>doclint-java8-disable</id>
<activation>
diff --git a/src/site/markdown/ClientGuide.md b/src/site/markdown/ClientGuide.md
new file mode 100644
index 000000000..12a38c542
--- /dev/null
+++ b/src/site/markdown/ClientGuide.md
@@ -0,0 +1,9 @@
+# Apache jUDDI Client and GUI Guide
+
+## Dedication
+
+We'd like to dedicate this guide to Steve Viens and Andy Cutright who started this project back in 2003.
+
+## Preface
+
+The jUDDI client framework facilitates interaction with any UDDI v3 compliant registry. In addition to providing a client framework for both Java and .NET, it also provides a self proclaimed Technical Compatilibity Test (TCK) Suite. The jUDDI community encourages collabration of other vendors on the TCK or on the client framework in general.
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideKeyFormatTemplates.asciidoc b/src/site/markdown/ClientGuideKeyFormatTemplates.md
similarity index 64%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideKeyFormatTemplates.asciidoc
rename to src/site/markdown/ClientGuideKeyFormatTemplates.md
index b6990dd4a..4b9e31c0e 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideKeyFormatTemplates.asciidoc
+++ b/src/site/markdown/ClientGuideKeyFormatTemplates.md
@@ -1,65 +1,76 @@
-[[chapter-KeyFormatTemplates]]
-== Key Format Templates
+## Key Format Templates
-=== UDDIv3 key format
-The UDDI v3 keys are formatted such that they are human readable. The short story is that UDDI v3 keys are formatted like: _uddi:<domain>:name_. For example, if you wanted a tModel defined as "uddi:www.mycompany.com:serviceauthenticationmethod", you would first have to create a tModel key generator with value "uddi:www.mycompany.com:keygenerator".
+### UDDIv3 key format
+The UDDI v3 keys are formatted such that they are human readable. The short story is that UDDI v3 keys are formatted like: `_uddi:<domain>:name_`. For example, if you wanted a tModel defined as `uddi:www.mycompany.com:serviceauthenticationmethod`, you would first have to create a tModel key generator with value `uddi:www.mycompany.com:keygenerator`.
-=== jUDDI key format templates
+### jUDDI key format templates
The jUDDI client has taken the key format approach one step further so the name part of the key actually helps you understand what the key is for, or even better in the case of a binding template what server registered the key.
-==== Advantages of using a template
+#### Advantages of using a template
Using a binding Key with format `uddi:${keyDomain}:binding_${serverName}_${serviceName}_${portName}_${serverPort}` contains valuable information for two reasons
+
- you can tell from the bindingKey what server registered it. This is helpful information if you want to debug connectivity issues between a client and the UDDI server.
- if a server goes to register a bindingTemplate it registered before it won't create a second bindingTemplate, so it won't leave behind dead or duplicate bindingTemplates.
-==== Default UDDIKeyConvention Key Templates
+#### Default UDDIKeyConvention Key Templates
The default templates setup by the jUDDI client are:
-....
+
+````
uddi:${keyDomain}:business_${businessName}
uddi:${keyDomain}:service_${serviceName}
uddi:${keyDomain}:service_cache_${serverName}
uddi:${keyDomain}:binding_${serverName}_${serviceName}_${portName}_${serverPort}
-....
+````
+
where tokens are expressed using `${}`. The templates are defined in the UDDIKeyConvention class.
-==== How to use the templates?
+#### How to use the templates?
+
At runtime a serviceKey can be obtained using
-....
+
+````
String serviceKey = UDDIKeyConvention.getServiceKey(properties, serviceName);
-....
+````
+
The serviceName can be specified in as a property in the first argument, or it can explicitly passed as the second argument. Using the second argument overrides what's specified in the properties. By default it will use the service template `uddi:${keyDomain}:service_${serviceName}`, but if you wish to use a different template you can simple specify that as a property, for example
-....
-String myCustomServiceFormat = "uddi:${keyDomain}:s_${serviceName}";
+
+````
+String myCustomServiceFormat = `uddi:${keyDomain}:s_${serviceName}`;
properties.add(Property.SERVICE_KEY_FORMAT, myCustomServiceFormat);
String myCustomFormattedServiceKey = UDDIKeyConvention.getServiceKey(properties, serviceName);
-....
+````
+
+#### Where to define to properties?
-==== Where to define to properties?
You can define the properties in your code, or you can obtain and pass in the properties defined in your `uddi.xml`. For an exmaple of this you can check out the `META-INF/wsdl2uddi-uddi.xml` of the `wsdl2uddi` example where for the `default` node we set
-....
- ...
- <nodes>
- <node>
- <name>default</name>
- <properties>
- <property name="serverName" value="localhost"/>
- <property name="serverPort" value="8080"/>
- <property name="keyDomain" value="uddi.joepublisher.com"/>
- <property name="businessName" value="WSDL-Business"/>
- </properties>
- ...
- </node>
- ...
- </nodes>
- ...
-....
+
+````
+...
+<nodes>
+ <node>
+ <name>default</name>
+ <properties>
+ <property name="serverName" value="localhost"/>
+ <property name="serverPort" value="8080"/>
+ <property name="keyDomain" value="uddi.joepublisher.com"/>
+ <property name="businessName" value="WSDL-Business"/>
+ </properties>
+ ...
+ </node>
+ ...
+</nodes>
+...
+````
+
and you can obtain the properties like
-....
-UDDIClient uddiClient = new UDDIClient("META-INF/wsdl2uddi-uddi.xml");
-Properties properties = uddiClient.getClientConfig().getUDDINode("default").getProperties();
-....
+
+````
+UDDIClient uddiClient = new UDDIClient(`META-INF/wsdl2uddi-uddi.xml`);
+Properties properties = uddiClient.getClientConfig().getUDDINode(`default`).getProperties();
+````
+
This is exactly what the WSDL2UDDI implementation does, and it the reason the class requires the properties in the constructor.
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideMappingWADLandWSDLtoUDDI.asciidoc b/src/site/markdown/ClientGuideMappingWADLandWSDLtoUDDI.md
similarity index 93%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideMappingWADLandWSDLtoUDDI.asciidoc
rename to src/site/markdown/ClientGuideMappingWADLandWSDLtoUDDI.md
index 11f18bf23..7504c0953 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideMappingWADLandWSDLtoUDDI.asciidoc
+++ b/src/site/markdown/ClientGuideMappingWADLandWSDLtoUDDI.md
@@ -1,16 +1,16 @@
-== Mapping WSDL and WSDL to UDDI
+## Mapping WSDL and WSDL to UDDI
-=== Introduction
+### Introduction
OASIS published a technical article which describes the recommended way to map the entries from a WSDL (Web Service Description Language) document into UDDI (https://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-tn-wsdl-v202-20040631.htm). The jUDDI-client provides a convenient mechanism for this mapping. In addition, the jUDDI team provides a similar API for mapping a WADL (Web Application Description Language) document to UDDI. This guide will help you use the APIs to reg [...]
-=== Use Case - WSDL
+### Use Case - WSDL
The most basic use case is that we have one or more SOAP/WSDL based services from a 3rd party that was just stood up on our network and we wish to now advertise to our user base that this service exists. We could manually punch in the information, but what fun is that? Let's import it using some code! This can be expanded to import services in bulk.
-==== Sample Code
+#### Sample Code
-----
+````
URL url = new URL("http://someURLtoYourWSDL");
ReadWSDL rw = new ReadWSDL();
Definition wsdlDefinition = rw.readWSDL(url);
@@ -32,9 +32,10 @@ Map allBindings = wsdlDefinition.getAllBindings();
Set<TModel> createWSDLBindingTModels = wsdl2UDDI.createWSDLBindingTModels(wsdlURL, allBindin
//Now just save the tModels, then add the services to a new or existing business
-----
-==== Links to sample project
+````
+
+#### Links to sample project
.SVN Links to sample projects
* http://svn.apache.org/repos/asf/juddi/trunk/juddi-examples/
@@ -43,12 +44,13 @@ Set<TModel> createWSDLBindingTModels = wsdl2UDDI.createWSDLBindingTModels(wsdlUR
The examples are also available in both jUDDI distributions.
-=== Use Case - WADL
+### Use Case - WADL
The most basic use case is that we have one or more REST/WADL based services from a 3rd party that was just stood up on our network and we wish to now advertise to our user base that this service exists. We could manually punch in the information, but what fun is that? Let's import it using some code! This can be expanded to import services in bulk.
-==== Sample Code
-----
+#### Sample Code
+
+````
Application app = WADL2UDDI.ParseWadl(new URL("URL to WADL file"));
List<URL> urls = WADL2UDDI.GetBaseAddresses(app);
URL url = urls.get(0);
@@ -65,10 +67,10 @@ BusinessService businessServices = wadl2UDDI.createBusinessService(new QName("My
//creates tModels (if any)
Set<TModel> portTypeTModels = wadl2UDDI.createWADLPortTypeTModels(wsdlURL, app);
//Now just save the tModels, then add the services to a new or existing business
-----
+````
-==== Links to sample project
+#### Links to sample project
.SVN Links to sample projects
* http://svn.apache.org/repos/asf/juddi/trunk/juddi-examples/
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideSimplePublishingUsingthejUDDIAPI.asciidoc b/src/site/markdown/ClientGuideSimplePublishingUsingthejUDDIAPI.md
similarity index 71%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideSimplePublishingUsingthejUDDIAPI.asciidoc
rename to src/site/markdown/ClientGuideSimplePublishingUsingthejUDDIAPI.md
index 485c76c63..9ea11bb6a 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideSimplePublishingUsingthejUDDIAPI.asciidoc
+++ b/src/site/markdown/ClientGuideSimplePublishingUsingthejUDDIAPI.md
@@ -1,8 +1,8 @@
-== Simple Publishing Using the jUDDI API
+## Simple Publishing Using the jUDDI API
One of the most common requests we get on the message board is "How do I publish a service using jUDDI?" This question holds a wide berth, as it can result anywhere from not understanding the UDDI data model, to confusion around how jUDDI is set up, to the order of steps required to publish artifacts in the registry, to general use of the API - and everything in between. This article will attempt to answer this "loaded" question and, while not going into too much detail, will hopefully c [...]
-=== UDDI Data Model
+### UDDI Data Model
Before you begin publishing artifacts, you need to know exactly how to break down your data into the UDDI model. This topic is covered extensively in the specification, particularly in section 3, so I only want to gloss over some for details. Readers interested in more extensive coverage should most definitely take a look at the UDDI specification.
@@ -18,7 +18,7 @@ Business Services are the cogs of the SOA landscape. They represent units of fun
Binding Templates, as mentioned above, give the details about the technical specification of the service. This can be as simple as just providing the service's access point, to providing the location of the service WSDL to more complicated scenarios to breaking down the technical details of the WSDL (when used in concert with tModels). Once again, getting into these scenarios is beyond the scope of this article but may be the subject of future articles.
-=== jUDDI Additions to the Model
+### jUDDI Additions to the Model
Out of the box, jUDDI provides some additional structure to the data model described in the specification. Primarily, this is the concept of the Publisher.
@@ -31,7 +31,7 @@ jUDDI's Publisher concept is really quite simple, particularly when using the de
TIP: In UDDI, ownership is essentially assigned to a given registry entity by using its "authorizedName" field. The "authorizedName" field is defined in the specification in the operationalInfo structure which keeps track of operational info for each entity. In jUDDI, the authorizedName field translates to the person's username, also know as the publisher id,
-=== UDDI and jUDDI API
+### UDDI and jUDDI API
Knowing the UDDI data model is all well and good. But to truly interact with the registry, you need to know how the UDDI API is structured and how jUDDI implements this API. The UDDI API is covered in great detail in chapter 5 of the specification but will be summarized here.
@@ -51,40 +51,40 @@ The jUDDI server implements each of these API sets as a JAX-WS compliant web ser
One final note, jUDDI defines its own API set. This API set contains methods that deal with handling Publishers as well as other useful maintenance functions (mostly related to jUDDI's subscription model). This API set is obviously proprietary to jUDDI and therefore doesn't conform to the UDDI specification.
-=== Getting Started
+### Getting Started
Now that we've covered the basics of the data model and API sets, it's time to get started with the publishing sample. The first thing that must happen is to get the jUDDI server up and running. Please refer to this http://apachejuddi.blogspot.com/2010/02/getting-started-with-juddi-v3.html article that explains how to start the jUDDI server.
-==== Simple Publishing Example
+#### Simple Publishing Example
We will now go over the "simple-publish" examples. These examples expand upon the HelloWorld example in that after retrieving an authentication token, a BusinessEntity and BusinessService are published to the registry. There are two examples:
- simple-publish-portal - This is how to perform the publish operations in a way that's portable, meaning that the code logic should apply to any UDDIv3 client application library.
- simple-publish-clerk - This shows you how to perform the same actions using the helper functions in jUDDI's Client library, which greatly reduces the code required and makes things simple. This uses the UDDIClerk's functions.
-===== Simple Publishing using Portable Code
+##### Simple Publishing using Portable Code
The complete source for this example can be found here:
- Portable http://svn.apache.org/repos/asf/juddi/trunk/juddi-examples/simple-publish-portable/
-----
- public SimplePublishPortable() {
- try {
- // create a client and read the config in the archive;
- // you can use your config file name
- UDDIClient uddiClient = new UDDIClient("META-INF/uddi.xml");
- // a UddiClient can be a client to multiple UDDI nodes, so
- // supply the nodeName (defined in your uddi.xml.
- // The transport can be WS, inVM, RMI etc which is defined in the uddi.xml
- Transport transport = uddiClient.getTransport("default");
- // Now you create a reference to the UDDI API
- security = transport.getUDDISecurityService();
- publish = transport.getUDDIPublishService();
- } catch (Exception e) {
- e.printStackTrace();
- }
- }
-----
+````
+public SimplePublishPortable() {
+try {
+ // create a client and read the config in the archive;
+ // you can use your config file name
+ UDDIClient uddiClient = new UDDIClient("META-INF/uddi.xml");
+ // a UddiClient can be a client to multiple UDDI nodes, so
+ // supply the nodeName (defined in your uddi.xml.
+ // The transport can be WS, inVM, RMI etc which is defined in the uddi.xml
+ Transport transport = uddiClient.getTransport("default");
+ // Now you create a reference to the UDDI API
+ security = transport.getUDDISecurityService();
+ publish = transport.getUDDIPublishService();
+} catch (Exception e) {
+ e.printStackTrace();
+}
+}
+````
The constructor uses the jUDDI client API to retrieve the transport from the default node. You can refer to the documentation if you're confused about how clerks and nodes work. Suffice it to say, we are simply retrieving the default client transport class which is designed to make UDDI calls out using JAX-WS web services.
@@ -93,14 +93,15 @@ Once the transport is instantiated, we grab the two API sets we need for this de
All the magic happens in the publish method. We will look at that next.
Here are the first few lines of the publish method:
-----
- // Login aka retrieve its authentication token
- GetAuthToken getAuthTokenMyPub = new GetAuthToken();
- getAuthTokenMyPub.setUserID("bob"); //your username
- getAuthTokenMyPub.setCred("bob"); //your password
- AuthToken myPubAuthToken = security.getAuthToken(getAuthTokenMyPub);
- System.out.println(getAuthTokenMyPub.getUserID() + "'s AUTHTOKEN = " + "******* never log auth tokens!");
-----
+
+````
+ // Login aka retrieve its authentication token
+ GetAuthToken getAuthTokenMyPub = new GetAuthToken();
+ getAuthTokenMyPub.setUserID("bob"); //your username
+ getAuthTokenMyPub.setCred("bob"); //your password
+ AuthToken myPubAuthToken = security.getAuthToken(getAuthTokenMyPub);
+ System.out.println(getAuthTokenMyPub.getUserID() + "'s AUTHTOKEN = " + "******* never log auth tokens!");
+````
IMPORTANT: Don't log authentication tokens. In addition, whenever you're done with it, it should be 'discarded'. Think of it as a logout function.
@@ -112,48 +113,48 @@ Now that we have Bob's authorization, we can start publishing.
TIP: You'll note that no credentials have been set on both authorization calls. This is because we're using the default authenticator (which is for testing purposes doesn't require credentials). Most UDDI servers will require authentication.
-----
- // Creating the parent business entity that will contain our service.
- BusinessEntity myBusEntity = new BusinessEntity();
- Name myBusName = new Name();
- myBusName.setValue("My Business");
- myBusEntity.getName().add(myBusName);
-
- // Adding the business entity to the "save" structure, using our publisher's authentication info
- // and saving away.
- SaveBusiness sb = new SaveBusiness();
- sb.getBusinessEntity().add(myBusEntity);
- sb.setAuthInfo(myPubAuthToken.getAuthInfo());
- BusinessDetail bd = publish.saveBusiness(sb);
- String myBusKey = bd.getBusinessEntity().get(0).getBusinessKey();
- System.out.println("myBusiness key: " + myBusKey);
-
- // Creating a service to save. Only adding the minimum data: the parent business key retrieved
- //from saving the business above and a single name.
- BusinessService myService = new BusinessService();
- myService.setBusinessKey(myBusKey);
- Name myServName = new Name();
- myServName.setValue("My Service");
- myService.getName().add(myServName);
- // Add binding templates, etc...
- // <snip> We removed some stuff here to make the example shorter, check out the source for more info</snip>
-
- // Adding the service to the "save" structure, using our publisher's authentication info and
- // saving away.
- SaveService ss = new SaveService();
- ss.getBusinessService().add(myService);
- ss.setAuthInfo(myPubAuthToken.getAuthInfo());
- ServiceDetail sd = publish.saveService(ss);
- String myServKey = sd.getBusinessService().get(0).getServiceKey();
- System.out.println("myService key: " + myServKey);
-
- //and we're done, don't forget to logout!
- security.discardAuthToken(new DiscardAuthToken(myPubAuthToken.getAuthInfo()));
-----
+````
+// Creating the parent business entity that will contain our service.
+BusinessEntity myBusEntity = new BusinessEntity();
+Name myBusName = new Name();
+myBusName.setValue("My Business");
+myBusEntity.getName().add(myBusName);
+
+// Adding the business entity to the "save" structure, using our publisher's authentication info
+// and saving away.
+SaveBusiness sb = new SaveBusiness();
+sb.getBusinessEntity().add(myBusEntity);
+sb.setAuthInfo(myPubAuthToken.getAuthInfo());
+BusinessDetail bd = publish.saveBusiness(sb);
+String myBusKey = bd.getBusinessEntity().get(0).getBusinessKey();
+System.out.println("myBusiness key: " + myBusKey);
+
+// Creating a service to save. Only adding the minimum data: the parent business key retrieved
+//from saving the business above and a single name.
+BusinessService myService = new BusinessService();
+myService.setBusinessKey(myBusKey);
+Name myServName = new Name();
+myServName.setValue("My Service");
+myService.getName().add(myServName);
+// Add binding templates, etc...
+// <snip> We removed some stuff here to make the example shorter, check out the source for more info</snip>
+
+// Adding the service to the "save" structure, using our publisher's authentication info and
+// saving away.
+SaveService ss = new SaveService();
+ss.getBusinessService().add(myService);
+ss.setAuthInfo(myPubAuthToken.getAuthInfo());
+ServiceDetail sd = publish.saveService(ss);
+String myServKey = sd.getBusinessService().get(0).getServiceKey();
+System.out.println("myService key: " + myServKey);
+
+//and we're done, don't forget to logout!
+security.discardAuthToken(new DiscardAuthToken(myPubAuthToken.getAuthInfo()));
+````
To summarize, here we have created and saved a BusinessEntity and then created and saved a BusinessService. We've just added the bare minimum data to each entity. Obviously, you would want to fill out each structure with greater information, particularly with services. However, this is beyond the scope of this article, which aims to simply show you how to programmatically publish entities.
-===== Simple Publishing using Clerks
+##### Simple Publishing using Clerks
The complete source for this example can be found here:
- Clerk http://svn.apache.org/repos/asf/juddi/trunk/juddi-examples/simple-publish-clerk/
@@ -161,21 +162,21 @@ The complete source for this example can be found here:
The sample consists of only one class: SimplePublishPortable. Let's start by taking a look at the constructor:
-----
- public SimplePublishClerk() {
- try {
- // create a client and read the config in the archive;
- // you can use your config file name
- UDDIClient uddiClient = new UDDIClient("META-INF/uddi.xml");
- //get the clerk
- clerk = uddiClient.getClerk("default");
- if (clerk==null)
- throw new Exception("the clerk wasn't found, check the config file!");
- } catch (Exception e) {
- e.printStackTrace();
- }
- }
-----
+````
+public SimplePublishClerk() {
+ try {
+ // create a client and read the config in the archive;
+ // you can use your config file name
+ UDDIClient uddiClient = new UDDIClient("META-INF/uddi.xml");
+ //get the clerk
+ clerk = uddiClient.getClerk("default");
+ if (clerk==null)
+ throw new Exception("the clerk wasn't found, check the config file!");
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+}
+````
Notice that this is already much more streamlined than the previous example. In this scenario, all configuration settings and credentials are stored in "META-INF/uddi.xml".
@@ -187,34 +188,34 @@ The UDDIClerk also handle credentials and authentication to UDDI for you. If you
Moving on, the next function is Publish. Here's the short short version.
-----
+````
public void publish() {
- try {
- // Creating the parent business entity that will contain our service.
- BusinessEntity myBusEntity = new BusinessEntity();
- Name myBusName = new Name();
- myBusName.setValue("My Business");
- myBusEntity.getName().add(myBusName);
- //<snip>we removed a bunch of useful stuff here, see the full example for the rest of it</snip>
-
- //register the business, if the return value is null, something went wrong!
- BusinessEntity register = clerk.register(myBusEntity);
- //don't forget to log out!
- clerk.discardAuthToken();
- if (register == null) {
- System.out.println("Save failed!");
- System.exit(1);
- }
- // Now you have a business and service via
- // the jUDDI API!
- System.out.println("Success!");
-
- } catch (Exception e) {
- e.printStackTrace();
- }
- }
-
-----
+ try {
+ // Creating the parent business entity that will contain our service.
+ BusinessEntity myBusEntity = new BusinessEntity();
+ Name myBusName = new Name();
+ myBusName.setValue("My Business");
+ myBusEntity.getName().add(myBusName);
+ //<snip>we removed a bunch of useful stuff here, see the full example for the rest of it</snip>
+
+ //register the business, if the return value is null, something went wrong!
+ BusinessEntity register = clerk.register(myBusEntity);
+ //don't forget to log out!
+ clerk.discardAuthToken();
+ if (register ## null) {
+ System.out.println("Save failed!");
+ System.exit(1);
+ }
+ // Now you have a business and service via
+ // the jUDDI API!
+ System.out.println("Success!");
+
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+}
+
+````
The UDDIClerk has a register and unregister function for nearly everything for UDDI. Between the UDDIClient and UDDIClerk, there's enough helper functions to significantly reduce the amount of code needed to work with UDDI. Here's a quick list of things they can do for you:
@@ -229,7 +230,7 @@ The UDDIClerk has a register and unregister function for nearly everything for U
We're also looking for the next thing to add to the client library. Have an idea? Please open a ticket on jUDDI's Issue Tracker at https://issues.apache.org/jira/browse/JUDDI.
-==== About UDDI Entity Keys
+#### About UDDI Entity Keys
There are a couple important notes regarding the use of entity keys. Version 3 of the specification allows for publishers to create their own keys but also instructs implementers to have a default method. Here we have gone with the default implementation by leaving each entity's "key" field blank in the save call. jUDDI's default key generator simply takes the node's partition and appends a GUID. In a default installation, it will look something like this:
@@ -238,12 +239,12 @@ uddi:juddi.apache.org:(generated GUID/UUID)
You can, of course, customize all of this, but that is left for another article. The second important point is that when the BusinessService is saved, we have to explicitly set its parent business key (retrieved from previous call saving the business). This is a necessary step when the service is saved in an independent call like this. Otherwise you would get an error because jUDDI won't know where to find the parent entity. I could have added this service to the BusinessEntity's service [...]
-=== A few tips on adding Binding Templates
+### A few tips on adding Binding Templates
Arguably, the most useful useful part of UDDI is advertising your services similar to a phone book or directory. The important part really isn't that Bob's Business exists (BusinessEntity), it's that Bob provides a service (BusinessService) and it's located at this address. This is where the Binding Template comes it. It identifies an instance of a service, its location and any other metadata associated with the endpoint that someone may want to know.
This article skips the binding Template data because it can be lengthy, but the full source for these examples shows you exactly how to build and add binding templates.
-=== Conclusion
+### Conclusion
Hopefully this added clarity to the question, "How do I publish a service using jUDDI?".
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideTCKRunner.asciidoc b/src/site/markdown/ClientGuideTCKRunner.md
similarity index 78%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideTCKRunner.asciidoc
rename to src/site/markdown/ClientGuideTCKRunner.md
index 6d1d6eb07..eb4d6115a 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideTCKRunner.asciidoc
+++ b/src/site/markdown/ClientGuideTCKRunner.md
@@ -1,19 +1,19 @@
-== Using the UDDI Technology Compatibility Kit
+## Using the UDDI Technology Compatibility Kit
Since UDDI is a specification with many complex rules in it, we (the jUDDI team) have had to write test cases to exercise each of the rules and restrictions in UDDI. Knowing that there are a number of open source and commercial UDDI v3 implementations, the jUDDI team took this as an opportunity to create a reusable benchmark for testing the compatibility of UDDI v3 implementations.
IMPORTANT: Although the TCK covers a large number of test cases, the UDDI specification is long and complex. It's more than possible that we missed a few scenarios or test cases. If you run across any, please let us know.
-=== Using the TCK Runner
+### Using the TCK Runner
The TCK Runner requires a few files to operate:
- . juddi-tck-runner-version.jar - This is the executable
- . uddi.xml - This file sets the location of the UDDI services
- . tck.properties - This file controls what tests are ran.
- . truststore and keystore.jks - These files are for digital signature tests
+ - `juddi-tck-runner-<version>.jar` - This is the executable
+ - uddi.xml - This file sets the location of the UDDI services
+ - tck.properties - This file controls what tests are ran.
+ - truststore and keystore.jks - These files are for digital signature tests
-==== Configuration
+#### Configuration
- Edit the uddi.xml file and update all of the UDDI endpoint locations for all supported endpoints of UDDI server being tested. Ignore all credentials and other settings
- Edit tck.properties and update the usernames and passwords of the test users. Enable or disable tests based on the whether or not the UDDI server supports the optional listed capabilities.
@@ -24,30 +24,30 @@ A few of the test cases, such as RMI transport, are not identified by the UDDI s
Although it is possible to run the TCK against a UDDIv2 registry using the UDDIv2 transport adapters, this is not supported. The TCK's test cases and rules apply to the business rules defined in UDDIv3. Unsupported and unmapped functions defined in UDDIv3 that are not supported in UDDIv2 fail ultimately fail.
-===== tck.properties
+##### tck.properties
The TCK properties file contains settings for all of the TCK tests.
- . Credentials - You'll need credentials for a number of user accounts
- . jUDDI optional tests - If you're running the tests against jUDDI, there's a number of additional tests ran to exercise things like user accounts.
- . Load testing - These settings enable you to tweak or disable the load testing.
- . Key stores - These are needed to run the digital signature tests
- . Supported transports - jUDDI supports a number of transports, such as RMI and HTTP (for UDDI service interaction) and SMTP and HTTP for subscription callbacks. RMI is actually not in the spec and SMTP is considered optional, so you'll want to adjusted these based on the available documentation from the vendor.
+ - Credentials - You'll need credentials for a number of user accounts
+ - jUDDI optional tests - If you're running the tests against jUDDI, there's a number of additional tests ran to exercise things like user accounts.
+ - Load testing - These settings enable you to tweak or disable the load testing.
+ - Key stores - These are needed to run the digital signature tests
+ - Supported transports - jUDDI supports a number of transports, such as RMI and HTTP (for UDDI service interaction) and SMTP and HTTP for subscription callbacks. RMI is actually not in the spec and SMTP is considered optional, so you'll want to adjusted these based on the available documentation from the vendor.
-===== uddi.xml
+##### uddi.xml
The only parts used from uddi.xml are the following
- . The endpoints of the UDDI services
- . The client subscription callback settings
+ - The endpoints of the UDDI services
+ - The client subscription callback settings
-==== Running the TCK Runner
+#### Running the TCK Runner
Executing the TCK runner is simple.
-----
+````
java (options) -Duddi.client.xml=uddi.xml -jar juddi-tck-runner-{VERSION}-SNAPSHOT-jar-with-dependencies.jar
-----
+````
Optional parameters
@@ -55,7 +55,7 @@ Optional parameters
* -Duddi.client.xml=uddi.xml - Use this file as the jUDDI Client config file. This specifies where all of the UDDI endpoints are.
* -Dtck.properties=file.properties - Use this to use an alternate tck properties file.
-=== Analyzing the Results
+### Analyzing the Results
There are two ways to identify the result of the tests.
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideUDDIMigrationTool.asciidoc b/src/site/markdown/ClientGuideUDDIMigrationTool.md
similarity index 94%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideUDDIMigrationTool.asciidoc
rename to src/site/markdown/ClientGuideUDDIMigrationTool.md
index 794f18b53..19c88837f 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideUDDIMigrationTool.asciidoc
+++ b/src/site/markdown/ClientGuideUDDIMigrationTool.md
@@ -1,4 +1,4 @@
-== UDDI Migration and Backup Tool
+## UDDI Migration and Backup Tool
The UDDI Migration and Backup Tool can be used to perform a number of administrative tasks such as
@@ -22,13 +22,13 @@ The UDDI Migration and Backup Tool is Command Line Interface program and has a n
TIP: The migration tool will not overwrite data when importing.
-=== Using the tool
+### Using the tool
There are many configuration options and settings for the migration tool. This tool is distributed with the uddi client distribution package.
-==== Get help
+#### Get help
-----
+````
>java -jar juddi-migration-tool-3.2.0-SNAPSHOT-jar-with-dependencies.jar
This tool is used to export and import UDDI data from a UDDI v3 registry
Random TIP: Without the preserveOwnership flag, all imported data will be owned by the username that imported it.
@@ -59,34 +59,34 @@ usage: java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar
default is 'tmodel-export.xml'
-user <arg> Username, if not defined, those is uddi.xml will be
used
-----
+````
-==== Use case: basic import and export
+#### Use case: basic import and export
To export everything without preserving ownership information:
-----
+````
java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar -export
-----
+````
To import everything without preserving ownership information:
-----
+````
java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar -import
-----
+````
-==== Use case: Import and Export while preserving ownership information
+#### Use case: Import and Export while preserving ownership information
To export everything with preserving ownership information:
-----
+````
java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar -export -preserveOwnership
-----
+````
To import everything with preserving ownership information, first edit the mappings file which is entityusermappings.properties by default. Once every user has a password, run the following command
-----
+````
java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar -import -preserveOwnership
-----
+````
TIP: When preserving ownership information, upon import, you'll need every UDDI entity owner's password. If you don't have this and you're using jUDDI, you can temporarily switch jUDDI to the 'DefaultAuthenticator' which doesn't validate passwords (just put anything in the mappings file for each user). Once the import is complete, you can then switch back to whatever authenticator you were using before.
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideUDDIv2Services.asciidoc b/src/site/markdown/ClientGuideUDDIv2Services.md
similarity index 89%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideUDDIv2Services.asciidoc
rename to src/site/markdown/ClientGuideUDDIv2Services.md
index 78519969f..1b17c93f2 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideUDDIv2Services.asciidoc
+++ b/src/site/markdown/ClientGuideUDDIv2Services.md
@@ -1,16 +1,16 @@
-== Using the UDDI v2 Services and Adapters
+## Using the UDDI v2 Services and Adapters
-=== Introduction
+### Introduction
Starting with jUDDI version 3.2, a number of adapters are provided to help you use or access UDDI version 2 based services. There are a multitude of options and will be discussed in the following sections.
-=== Accessing UDDI v2 services using the jUDDI v3 Client
+### Accessing UDDI v2 services using the jUDDI v3 Client
Accessing UDDI v2 services via the jUDDI v3 client is quite simple. All that's required is modification of the uddi.xml client configuration file. Simply set the transport to:
-----
+````
org.apache.juddi.v3.client.transport.JAXWSv2TranslationTransport
-----
+````
...and adjust the 'inquiryUrl' and 'publishUrl' URL endpoints.
@@ -18,31 +18,32 @@ TIP: When accessing UDDI v2, Custody Transfer, Subscription, Replication and Val
That's it. No code changes are required other than to avoid Custody Transfer, Subscription, Replication and Value Set APIs. In addition, digital signatures are not mapped.
-=== Accessing UDDI v2 services using UDDI v2 APIs
+### Accessing UDDI v2 services using UDDI v2 APIs
The jUDDI v3 client now contains the UDDI 2 web service clients. Although, there isn't currently a configuration/transport/client/clerk wrapper for it, you can still get access to web service clients with the following code:
-----
+
+````
org.apache.juddi.v3.client.UDDIServiceV2 svc = new UDDIServiceV2();
Inquire port = svc.getInquire();
((BindingProvider) port).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://localhost:8080/juddiv3/services/inquiryv2");
Publish pub= svc.getPublish();
((BindingProvider) pub).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://localhost:8080/juddiv3/services/publishv2");
-----
+````
All you need to reference the following projects/jars from jUDDI:
* juddi-client
* uddi-ws
-=== Accessing jUDDI v3 services from an existing UDDI v2 based client, plugin or tool
+### Accessing jUDDI v3 services from an existing UDDI v2 based client, plugin or tool
When UDDI v2 was release, many application developers jumped on board to support it. As such, there are many UDDI v2 tools that exist, such as IDE plugins like Eclipse's Web Services Explorer. To support legacy tools, jUDDI now offers UDDI v2 endpoints. Simple point your tool at the following URLs. You'll have to alter them to match your environment.
-----
+````
http://localhost:8080/juddiv3/services/inquiryv2
http://localhost:8080/juddiv3/services/publishv2
-----
+````
-=== Additional Information
+### Additional Information
The UDDI v2 adapters provide basic mappings from to and from UDDI v3. The juddi-client has several mapping functions that are used both client and service side to convert from UDDI v2 to UDDI v3. In addition, the client has as several interface adapters to help with a seamless transition.
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.asciidoc b/src/site/markdown/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.md
similarity index 91%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.asciidoc
rename to src/site/markdown/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.md
index d6701abb4..c9a67f93b 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.asciidoc
+++ b/src/site/markdown/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.md
@@ -1,30 +1,28 @@
-== Using UDDI Annotations
+## Using UDDI Annotations
+
Conventionally Services (BusinessService) and their EndPoints (BindingTemplates) are registered to a UDDI Registry using a GUI, where an admin user manually adds the necessary info. This process tends to make the data in the Registry rather static and the data can grow stale over time. To make the data in the UDDI more dynamic it makes sense to register and EndPoint (BindingTemplate) when it comes online, which is when it gets deployed. The UDDI annotations are designed to just that: reg [...]
-=== UDDI Service Annotation
+### UDDI Service Annotation
+
The UDDIService annotation is used to register a service under an already existing business in the Registry. The annotation should be added at the class level of the java class.
-.UDDIService attributes
-[options="header"]
-|======================================
|attribute| description| required
+| --- | --- | ----------- |
|serviceName| The name of the service, by default the clerk will use the one name specified in the WebService annotation| no
|description| Human readable description of the service| yes
|serviceKey| UDDI v3 Key of the Service| yes
|businessKey| UDDI v3 Key of the Business that should own this Service. The business should exist in the registry at time of registration| yes
|lang| Language locale which will be used for the name and description, defaults to "en" if omitted| no
|categoryBag| Definition of a CategoryBag, see below for details| no
-|======================================
+### UDDIServiceBinding Annotation
-=== UDDIServiceBinding Annotation
The UDDIServiceBinding annotation is used to register a BindingTemplate to the UDDI registry. This annotation cannot be used by itself. It needs to go along side a UDDIService annotation.
-.UDDIServiceBinding attributes
-[options="header"]
-|======================================
+
|attribute| description| required
+| --- | --- | ----------- |
|bindingKey| UDDI v3 Key of the ServiceBinding| yes
|description| Human readable description of the service| yes
||accessPointType UDDI v3 AccessPointType, defaults to wsdlDeployment if omitted| no
@@ -32,11 +30,11 @@ The UDDIServiceBinding annotation is used to register a BindingTemplate to the U
|lang| Language locale which will be used for the name and description, defaults to "en" if omitted| no
|tModelKeys| Comma-separated list of tModelKeys key references| no
|categoryBag| Definition of a CategoryBag, see below for further details| no
-|======================================
-==== Java Web Service Example
+#### Java Web Service Example
The annotations can be used on any class that defines a service. Here they are added to a WebService, a POJO with a JAX-WS 'WebService' annotation.
-----
+
+````
package org.apache.juddi.samples;
import javax.jws.WebService;
@@ -63,42 +61,42 @@ public class HelloWorldImpl implements HelloWorld {
return "Hello " + text;
}
}
-----
+````
On deployment of this WebService, the juddi-client code will scan this class for UDDI annotations and take care of the registration process. The configuration file uddi.xml of the juddi-client is described in the chapter, Using the jUDDI-Client. In the clerk section you need to reference the Service class 'org.apache.juddi.samples.HelloWorldImpl':
-----
+````
<clerk name="BobCratchit" node="default" publisher="sales" password="sales">
<class>org.apache.juddi.samples.HelloWorldImpl</class>
</clerk>
-----
+````
which means that Bob is using the node connection setting of the node with name "default", and that he will be using the "sales" publisher, for which the password it "sales". There is some analogy here as to how datasources are defined.
-==== Wiring it all together
+#### Wiring it all together
The mechanism that triggers the automated registration is the UDDIClient. For each class you annotation, the class needs to be listed in the jUDDI Client Configuration file. When the client reads in the configuration, it will read the uddi.xml config file for the following location:
-----
+````
client/clerks/clerk[].class
-----
+````
In addition, the following flag must be set to true.
-----
+````
client/clerks@registerOnStartup="true"
-----
+````
Here's a full example
-----
+````
<clerks registerOnStartup="false" >
<clerk name="default" node="default" publisher="userjoe" password="******" cryptoProvider="" isPasswordEncrypted="false">
<class>com.mybiz.services.Service1</class>
</clerk>
</clerks>
-----
+````
The next step is to automate the "starting" and "stopping" of UDDIClient. In Java, anything that runs in a servlet container and use the following servlet class:
-----
+````
org.apache.juddi.v3.client.config.UDDIClerkServlet
-----
+````
It will automatically handle registration on start up and it will remove binding Templates on shutdown (this ensuring clients that discover the endpoint won't find a dead link).
Clients that run elsewhere simply need to "start" the UDDIClient.
-----
+````
//start up
UDDIClient clerkManager = new UDDIClient("META-INF/uddi.xml");
// register the clerkManager with the client side container
@@ -107,46 +105,46 @@ clerkManager.start(); //will create business/services/bindings as necessary
//shutdown down
clerkManager.stop(); //will unregister binding templates
-----
+````
-=== .NET Web Service Example
+### .NET Web Service Example
In .NET, the procedure is almost identical to Java. Annotate your web service classes, append the classnames to your uddi.xml client config file. .NET annotations work with any WCF, ASP.NET or any other class.
-==== Wiring it all together
+#### Wiring it all together
In .NET, there's a few options, each with pro's and con's for automating registration.
-===== Use UDDIClient in your service's constructor
+##### Use UDDIClient in your service's constructor
Pro: It's simple
Con: Services often get multiple instances depending on the number of worker threads in the server and thus can cause some concurrency issues.
-===== Use UDDIClient in Global.asa Application_Start
+##### Use UDDIClient in Global.asa Application_Start
Pro: It's simple
Con: You need .NET 4.0 and ASP.NET enabled in order to utilize this function
More information about this can be found here: http://weblogs.asp.net/scottgu/archive/2009/09/15/auto-start-asp-net-applications-vs-2010-and-net-4-0-series.aspx
-=== CategoryBag Attribute
+### CategoryBag Attribute
The CategoryBag attribute allows you to reference tModels. For example the following categoryBag
-----
+````
<categoryBag>
<keyedReference tModelKey="uddi:uddi.org:categorization:types"
keyName="uddi-org:types:wsdl" keyValue="wsdlDeployment" />
<keyedReference tModelKey="uddi:uddi.org:categorization:types"
keyName="uddi-org:types:wsdl2" keyValue="wsdlDeployment2" />
</categoryBag>
-----
+````
can be put in like
-----
+````
categoryBag="keyedReference=keyName=uddi-org:types:wsdl;keyValue=wsdlDeployment;" +
"tModelKey=uddi:uddi.org:categorization:types," +
"keyedReference=keyName=uddi-org:types:wsdl2;keyValue=wsdlDeployment2;" +
"tModelKey=uddi:uddi.org:categorization:types2",
-----
+````
-=== Considerations for clustered or load balanced web servers and automated registration
+### Considerations for clustered or load balanced web servers and automated registration
Most production environments have primary and failover web servers and/or an intelligent load balancer that routers traffic to whichever server is online. When using automated registration with the jUDDI client, care must be taken when enabling automated registration.
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideUsingjUDDIRestServices.asciidoc b/src/site/markdown/ClientGuideUsingjUDDIRestServices.md
similarity index 84%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideUsingjUDDIRestServices.asciidoc
rename to src/site/markdown/ClientGuideUsingjUDDIRestServices.md
index 526058cf9..23329c267 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideUsingjUDDIRestServices.asciidoc
+++ b/src/site/markdown/ClientGuideUsingjUDDIRestServices.md
@@ -1,14 +1,14 @@
-== Using the jUDDI REST Services
+## Using the jUDDI REST Services
jUDDI includes a Inquiry API adapter that exposes some of the basic functionality of UDDI via REST. Data can be retrieved in both XML and JSON encoding for all methods.
-=== URL Patterns and methods
+### URL Patterns and methods
. All jUDDI Inquiry REST service are accessible via HTTP GET.
. Authentication is not yet supported. This also implies that the Inquiry API must be configured for anonymous access (i.e. do not turn on Inquiry Authentication Required).
. The jUDDI Inquiry REST service is not currently portable as an adapter to other UDDI instances (but it could be adapted to it in the future)
-==== Endpoints
+#### Endpoints
All endpoints must be prefixed with http(s)://server:port/juddicontext/ where 'juddicontext' is typically 'juddiv3'.
@@ -16,94 +16,98 @@ WADL Document: http://localhost:8080/juddiv3/services/inquiryRest?_wadl
TIP: All of the examples in this document reference JSON encoded messages. To switch to XML messages, just replace the 'JSON' with 'XML' in the URL. That's it!
-==== Methods
+#### Methods
Each method is accessible using the following pattern:
-----
+````
http://localhost:8080/juddiv3/services/inquiryRest/{encoding}/{method}/{parameters}
//or
http://localhost:8080/juddiv3/services/inquiryRest/{encoding}/{method}?{name=value}
-----
+````
Notes
-* Encoding - Can be 'XML' or 'JSON'
-* Methods - See below
-* Parameters - usually a unique UDDI key
+- Encoding - Can be 'XML' or 'JSON'
+- Methods - See below
+- Parameters - usually a unique UDDI key
-===== xxxList
+##### xxxList
Returns up to 100 items within a KeyBag object, containing a list of all keys for the given object type.
-. serviceList - http://localhost:8080/juddiv3/services/inquiryRest/JSON/serviceList
-. businessList - http://localhost:8080/juddiv3/services/inquiryRest/JSON/businessList
-. tModelList - http://localhost:8080/juddiv3/services/inquiryRest/JSON/tModelList
+- serviceList - http://localhost:8080/juddiv3/services/inquiryRest/JSON/serviceList
+- businessList - http://localhost:8080/juddiv3/services/inquiryRest/JSON/businessList
+- tModelList - http://localhost:8080/juddiv3/services/inquiryRest/JSON/tModelList
-===== endpointsByService/key
+##### endpointsByService/key
Returns all executable endpoints for a given service key, including all binding Templates. This also resolves hosting redirector and a number of other accessPoint useType specifics.
Example:
-----
+````
http://localhost:8080/juddiv3/services/inquiryRest/JSON/endpointsByService/uddi:juddi.apache.org:services-custodytransfer
-----
+````
-===== getDetail
+##### getDetail
Return the details of a specific item using query parameters. This implements the UDDI recommendation for HTTP GET services for UDDI. See http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908158 for further information.
Example:
-----
+
+````
http://localhost:8080/juddiv3/services/inquiryRest/XML/getDetail?businessKey=uddi:juddi.apache.org:businesses-asf
-----
+````
The following query parameters are supported. Only one can be specified at a time
-. businessKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/getDetail?businessKey=uddi:juddi.apache.org:businesses-asf
-. tModelKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/getDetail?tModelKey=uddi:uddi.org:categorization:types
-. bindingKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/getDetail?bindingKey=uddi:juddi.apache.org:servicebindings-inquiry-ws
-. serviceKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/getDetail?serviceKey=uddi:juddi.apache.org:services-inquiry
+- businessKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/getDetail?businessKey=uddi:juddi.apache.org:businesses-asf
+- tModelKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/getDetail?tModelKey=uddi:uddi.org:categorization:types
+- bindingKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/getDetail?bindingKey=uddi:juddi.apache.org:servicebindings-inquiry-ws
+- serviceKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/getDetail?serviceKey=uddi:juddi.apache.org:services-inquiry
-===== xxxKey
+##### xxxKey
Return the details of a specific item. This is similar to getDetail except that it is not based on query parameters. The underlying code of this function is the same as getDetail.
Example:
-. businessKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/businessKey/uddi:juddi.apache.org:businesses-asf
-. tModelKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/tModelKey/uddi:uddi.org:categorization:types
-. bindingKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/bindingKey/uddi:juddi.apache.org:servicebindings-inquiry-ws
-. serviceKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/serviceKey/uddi:juddi.apache.org:services-inquiry
-. opInfo/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/opInfo/uddi:juddi.apache.org:businesses-asf
+- businessKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/businessKey/uddi:juddi.apache.org:businesses-asf
+- tModelKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/tModelKey/uddi:uddi.org:categorization:types
+- bindingKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/bindingKey/uddi:juddi.apache.org:servicebindings-inquiry-ws
+- serviceKey/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/serviceKey/uddi:juddi.apache.org:services-inquiry
+- opInfo/(key) - http://localhost:8080/juddiv3/services/inquiryRest/JSON/opInfo/uddi:juddi.apache.org:businesses-asf
-===== xxxSearch
+##### xxxSearch
Returns the search results for registered entities in XML or JSON using a number of query parameters.
Supported entities:
- . searchService
- . searchBusiness
- . searchTModel
+
+- searchService
+- searchBusiness
+- searchTModel
Supported query parameters
- . name - Filters by the name element. If not specified, the wildcard symbol is used '%'.
- . lang - Filters by language. If not specified, null is used.
- . findQualifiers - Adds sorting or additional find parameters. comma delimited. If not specified, 'approximateMatch' is used
- . maxrows - Maximum rows returned. If not specified, 100 is used.
- . offset - Offset for paging operations. If not specified, 0 is used.
+
+- name - Filters by the name element. If not specified, the wildcard symbol is used '%'.
+- lang - Filters by language. If not specified, null is used.
+- findQualifiers - Adds sorting or additional find parameters. comma delimited. If not specified, 'approximateMatch' is used
+- maxrows - Maximum rows returned. If not specified, 100 is used.
+- offset - Offset for paging operations. If not specified, 0 is used.
-=== Example Output
+### Example Output
-==== XML
+#### XML
The output of all XML encoded messages is identical to the UDDI schema specifications. There should be no surprises.
-==== JSON
+#### JSON
The output of JSON encoded messages is obviously different than XML. The following is an example of what it looks like.
-----
+
+````json
{
"businessEntity": {
"@businessKey": "uddi:juddi.apache.org:businesses-asf",
@@ -204,7 +208,8 @@ The output of JSON encoded messages is obviously different than XML. The followi
}
}
-----
-=== More information
+````
+
+### More information
For more information, please check out the source code: http://svn.apache.org/repos/asf/juddi/trunk/juddi-rest-cxf/
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuideUsingthejUDDIGUI.asciidoc b/src/site/markdown/ClientGuideUsingthejUDDIGUI.md
similarity index 73%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuideUsingthejUDDIGUI.asciidoc
rename to src/site/markdown/ClientGuideUsingthejUDDIGUI.md
index a4e516a0d..424f8fc90 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuideUsingthejUDDIGUI.asciidoc
+++ b/src/site/markdown/ClientGuideUsingthejUDDIGUI.md
@@ -1,5 +1,4 @@
-[[chapter-UsingTheJUDDIGUI]]
-== Using the jUDDI GUI
+## Using the jUDDI GUI
Starting with jUDDI v3.2, a nearly full featured UDDI v3 compliant web user interface is included called the jUDDI Graphical User Interface, or jUDDI GUI. It is also referred to as the jUDDI Console, or jUDDI User Console. The jUDDI GUI is a web application that can run in most web servlet containers, such as Tomcat and can be deployed along side of the jUDDI Web Services war (juddiv3.war). From the jUDDI GUI, users can browse, search, create, update, digitally sign and delete most UDDI [...]
@@ -12,24 +11,23 @@ As of version 3.2, the jUDDI GUI supports the complete functionality of the foll
* Subscription
-=== Requirements
+### Requirements
+
The jUDDI GUI needs two things in order to operate.
* UDDI v3 compliant services
* A J2EE application server, such as Tomcat, Jboss, Jetty or maybe even in Winstone
* Optionally, a container level authentication mechanism that supports role based authentication (for remote configuration)
-=== Tasks
-The following sections detail how to perform basic tasks using the jUDDI GUI. Hopefully, the user interface is intuitive enough that thorough guidance isn't necessary.
+### Tasks
-==== Your first sign on
-Typically, the jUDDI GUI is accessed via a URL in a web browser, such as this: http://localhost:8080/juddi-gui. This URL will probably be different from this if someone else set up jUDDI GUI for you (such as a system administrator), in which case, you'll want to ask them for the correct URL. Once loading the page, you should see something similiar to this.
+The following sections detail how to perform basic tasks using the jUDDI GUI. Hopefully, the user interface is intuitive enough that thorough guidance isn't necessary.
+#### Your first sign on
-[[figure-Using the jUDDI GUI-Welcome]]
-.Welcome to jUDDI, Please select a language.
-image::images/juddi-gui-welcome.png[Welcome to jUDDI, Please select a language]
+Typically, the jUDDI GUI is accessed via a URL in a web browser, such as this: http://localhost:8080/juddi-gui. This URL will probably be different from this if someone else set up jUDDI GUI for you (such as a system administrator), in which case, you'll want to ask them for the correct URL. Once loading the page, you should see something similiar to this.
+
Select a language, then click the button labeled "Go".
@@ -41,22 +39,15 @@ After clicking on "Go", you should see something similar to the next two screen
TIP: Why would it be different? The jUDDI GUI is based on the Twitter Bootstrap API and is designed to automatically rearrange the user interface based on screen size and resolution. Small form factor devices, such as tablets and smart phones generally function as normal, except that the upper navigation bar becomes condensed into a single button.
-[[figure-Using the jUDDI GUI-fullmenu]]
-.Full menu bar for computers or large displays.
-image::images/juddi-gui-fullbootstrap-menu.png[Full menu bar for computers or large displays.]
+
-[[figure-Using the jUDDI GUI-tabletmenusmall]]
-.Tablet/Mobile menu bar for small displays.
-image::images/juddi-gui-tabletbootstrap-menu.png[Tablet/Mobile bar for small displays.]
+
For now, let's just focus on the menu or navigation bar.
-=== The Menu Bar
-
-[[figure-Using the jUDDI GUI-menubar]]
-.The Menu Bar.
-image::images/juddi-gui-menu.png[The Menu Bar]
+### The Menu Bar
+
The menu bar is designed to make navigation simple and intuitive.
@@ -68,78 +59,59 @@ The menu bar is designed to make navigation simple and intuitive.
* Login/Logout - many registries require authentication. These buttons support both HTTP and UDDI Auth Token style of authentication.
-=== Logging in to UDDI Services
+### Logging in to UDDI Services
Assuming that your UDDI services require authentication, you'll probably want to login with your username and password. This is done using the Login/Logout section the Menu bar (top right of the screen).
-[[figure-Using the jUDDI GUI-loginwarn]]
-.Login Warning.
-image::images/juddi-gui-login-warning.png[Login Warning]
-
+
CAUTION: If you happen to notice that a warning symbol next to the Login button, use caution! Your password may be exposed if you proceed.
TIP: The Warning symbol on the Login portion of the Menu bar will be present unless the following conditions are met: Communication from your browser to juddi-gui is encrypted using SSL/TLS AND the communication from juddi-gui to the UDDI services is encrypted using SSL/TLS.
-=== Logging Out
+### Logging Out
-Once logged in, just "Welcome <username>" button to log out.
+Once logged in, just "Welcome `<username>`" button to log out.
-=== Discover (Browse UDDI)
+### Discover (Browse UDDI)
All of the Browse pages support pagination, that is you can flip through the pages of the database, as if it were a phone book.
In addition, search results can be filtered by language. On each Discover page, you will see the following
-[[figure-Using the jUDDI GUI-browseoptions]]
-.Browse Options.
-image::images/juddi-gui-browse-options.png[Browse Options]
-
+
Click on "Click to Edit", enter your desired language code, then either press enter, or click "Ok" and the results will be filtered automatically. See "Language Codes" for more information.
-==== Business Browser
+#### Business Browser
To browse for a UDDI Business, simply click on the word 'Discover' from the top navigation bar and select Businesses.
-[[figure-Using the jUDDI GUI-browsebusiness]]
-.Browse Business.
-image::images/juddi-gui-browse-business.png[Browse Business]
+
When clicking on "Show XX" (XX is the number of services that business has)
-
-[[figure-Using the jUDDI GUI-browsebusiness2]]
-.Browse Business Zoomed in.
-image::images/juddi-gui-browse-business2.png[Browse Business Zoomed in]
-
+
The (+) Plus button will enable you to add a new service that belongs to the business on the same table row.
-==== Service Browser
+#### Service Browser
To browse for a UDDI Service, simply click on the word 'Discover' from the top navigation bar and select Services. Clicking on the Name of the service, will bring you to the Service Editor page. Click on the owning Business key to bring you to the Business Editor page.
-[[figure-Using the jUDDI GUI-servicebrowser]]
-.Service Browser.
-image::images/juddi-gui-browse-services.png[Service Browser]
+
-
-==== tModel Browser
+#### tModel Browser
To browse for a UDDI tModel simply click on the word 'Discover' from the top navigation bar and select tModel. Clicking on the Key of the tModel, will bring you to the tModel Editor page.
-[[figure-Using the jUDDI GUI-tmodelbrowser]]
-.tModel Browser.
-image::images/juddi-gui-browse-tmodel.png[tModel Browser]
+
-==== Search
+#### Search
Searching UDDI provides you with the capabilities to make both simple and complex queries. To search, simply click on the word 'Discover' from the top navigation bar and select 'Search'.
-[[figure-Using the jUDDI GUI-search]]
-.Search.
-image::images/juddi-gui-search.png[Search]
+
You first need to select what you're looking for. You can either search a Business, Service, Binding Template, or tModel.
@@ -149,43 +121,37 @@ IMPORTANT: UDDI offers a wider, richer search capability. The juddi-gui's search
TIP: When using the wildcards (%, ?), you have to add the find qualifier, approximateMatch.
-=== Creating new Entities
+### Creating new Entities
The jUDDI GUI has the ability to create and register new UDDI entities.
-==== Create a tModel
+#### Create a tModel
From the menu, select Create, then tModel. For tModels, the only required item is the Name element.
-==== Create a tModek Key Generator (Partition)
+#### Create a tModek Key Generator (Partition)
IMPORTANT: If you want to create your own UDDI keys (recommended) rather than use the not so user friendly server generated GUID values, then you'll have to make a Key Generator first! Read on!
A tModel Key Generator is a special kind of tModel that enables you to define your own keys (for anything in UDDI) for your own "domain". A "domain" is similar to the Domain Name System used by the Internet to resolve user friendly names, such as www.apache.org, to an IP address. This effectively allows you to define any arbitrary UDDI key prefix that you want. For example, if you wanted a UDDI key defined as "uddi:www.mycompany.com:salesbusiness1", you would first have to create a tMod [...]
-[[figure-Using the jUDDI GUI-keypart]]
-.Create a tModel Key Generator (Partition).
-image::images/juddi-gui-tmodel-keygen.png[Create a tModel Key Generator (Partition)]
+
-TIP: You can also use nested partitions such as "uddi:www.mycompany.com:keygenerator" and "uddi:www.mycompany.com:sales:keygenerator". UDDI uses the colon ":" as a separator for partitions. This will enable you to make UDDI keys such as "uddi:www.mycompany.com:biz1" and "uddi:www.mycompany.com:sales:biz2".
+TIP: You can also use nested partitions such as `uddi:www.mycompany.com:keygenerator` and `uddi:www.mycompany.com:sales:keygenerator`. UDDI uses the colon `:` as a separator for partitions. This will enable you to make UDDI keys such as `uddi:www.mycompany.com:biz1` and `uddi:www.mycompany.com:sales:biz2`.
TIP: UDDI key names can be at MOST 255 characters long!
-==== Create a Business
+#### Create a Business
The UDDI Business entity enables you to define and advertise your business with a variety of ways. To create a new business, simply click on the word 'Create' from the top navigation bar and select 'Business'.
TIP: The "Create", "Business" page is also the same page to use when editing an existing business.
-[[figure-Using the jUDDI GUI-createbiz]]
-.Create Business.
-image::images/juddi-gui-create-business.png[Create a Business]
+
Businesses in UDDI only require you to define at least one name. All of fields are optional. Business entities can have 0 or more of just about everything. For now, let's just make a Name, give it a Value and then save our new business. To add a new Name, click the "+" button next to the "Name". Then click on "Click to edit" next to "Value". If you make a mistake or wish to remove the "Name" or any other element, click on the trash can.
-[[figure-Using the jUDDI GUI-createbiz3]]
-.How to Add and Delete items.
-image::images/juddi-gui-create-business3.png[How to Add and Delete items]
+
If you read the previous section on tModel Key Generators, then you know all about UDDI keys. This is your one and only chance to get it right. Once your done, click "Save". Congrats! You've just made your first UDDI business!
@@ -193,9 +159,7 @@ IMPORTANT: When working with UDDI entities, you cannot change the UDDI key after
The Business Editor/Creator web page, along with the other editor/creator pages, has a ton of other interesting things that you can do. Since there's way too much stuff to look at, we broke them up into logical sections.
-[[figure-Using the jUDDI GUI-createbiz2]]
-.Business Editor's Section.
-image::images/juddi-gui-create-business2.png[Business Editor's Section]
+
In case you can't see the picture above:
@@ -213,25 +177,21 @@ TIP: Clicking on each tab will supply additional information.
TIP: If a business, service, or tModel is signed, the juddi-gui will automatically attempt to validate the signature. You'll see a thumbs up or thumbs down icon to let you know.
-==== Create a Service
+#### Create a Service
Creating a new service is simple so long as you remember that a service must be attached to a business. There are a few ways to create a new business.
The first option is to locate the business that you wish to add a service to via the Business Browser and then click the Plug button.
-[[figure-Using the jUDDI GUI-createservice1]]
-.Add a Service via Business Browser.
-image::images/juddi-gui-service-add1.png[Add a Service via Business Browser]
+
The second option is to bring up the Business Editor for the business you want to add a service to, then click on the Services tab, then "Add a Service".
-[[figure-Using the jUDDI GUI-createservice2]]
-.Add a Service via Business Editor.
-image::images/juddi-gui-service-add2.png[Add a Service via Business Editor]
+
TIP: Services require at least one name. Everything else is considered optional.
-==== Import from WSDL or WADL
+#### Import from WSDL or WADL
The jUDDI client provides programmatic access to convert a WSDL or WADL document into UDDI Service and tModel entries. The juddi-gui takes advantage of this and provides a simple to use interface to quickly and easily import your SOAP and REST services into UDDI.
@@ -244,11 +204,9 @@ The process is pretty straight forward.
1.Pick a business to attach the imported data to.
1.Review and Approve. The Preview button will do all of the processing except saving the content, so it is a good way to get a preview of what will happen. Save will do the processing and save it.
-[[figure-Using the jUDDI GUI-importwsdl]]
-.Importing a Service from WSDL or WADL.
-image::images/juddi-gui-import-wsdl.png[Importing a Service from WSDL or WADL]
+
-=== Custody Transfers
+### Custody Transfers
Custody Transfers are used to give away ownership and edit permission for UDDI business and tModels. It's not used very often, but the workflow is simple.
@@ -259,86 +217,66 @@ Custody Transfers are used to give away ownership and edit permission for UDDI b
All of these actions are processed at the Transfer Ownership page from the Home menu.
-[[figure-Using the jUDDI GUI-custodytransfer]]
-.Custody Transfer.
-image::images/juddi-gui-transfer.png[Custody Transfer]
+
-=== Publisher Assertions
+### Publisher Assertions
Publisher Assertions are how two different businesses can setup a UDDI Business Relationship. This essentially means that other users can see that this is a relationship between business A and B and that they can perform queries based on the relationship.
-[[figure-Using the jUDDI GUI-publisherassertion]]
-.Publisher Assertion.
-image::images/juddi-gui-publisherassertion.png[Publisher Assertion]
-
+
-=== Subscriptions
+### Subscriptions
Subscriptions in UDDI are used to easily detect when changes are made to a UDDI node.
-==== Create a new subscription
+#### Create a new subscription
To create a new subscription, you must first be logged in. Click on Home, then Create Subscription.
Subscriptions can either be for a set of specific items or for search results.
-[[figure-Using the jUDDI GUI-createsub1]]
-.Create a Subscription, Specific Item or Search Results.
-image::images/juddi-gui-subscription1.png[Create a Subscription, Specific Item or Search Results]
+
In our example, we've selected a set of specific items.
-[[figure-Using the jUDDI GUI-createsub2]]
-.Create a Subscription, Select Items.
-image::images/juddi-gui-subscription2.png[Create a Subscription, Select Items
+
To add an item to the list, click on Add. The item chooser will appear. Check each item to add them to the list. To remove, select the item, then click remove.
-[[figure-Using the jUDDI GUI-createsub3]]
-.Create a Subscription, Add an item using the chooser.
-image::images/juddi-gui-subscription3.png[Create a Subscription, Add an item using the chooser]
+
Specific items are added by entity keys.
-[[figure-Using the jUDDI GUI-createsub4]]
-.Create a Subscription, Item Added.
-image::images/juddi-gui-subscription4.png[Create a Subscription, Item added]
+
Next is the delivery mechanism. The UDDI node can deliver the notifications to you if you have your own implementation of the UDDI Subscription Listener service. (The juddi-client contains this for you if you were looking to develop a solution). In addition, the UDDI node can email the results to you (in XML format).
-TIP: Since jUDDI 3.2.1, you can also configure jUDDI to send you a more human readable version of the subscription notification. To configure, all that is needed is to add a special transport tModel instance to your subscription binding, uddi:uddi.org:transport:userfriendlysmtp.
+TIP: Since jUDDI 3.2.1, you can also configure jUDDI to send you a more human readable version of the subscription notification. To configure, all that is needed is to add a special transport tModel instance to your subscription binding, `uddi:uddi.org:transport:userfriendlysmtp`.
The other option is to periodically poll the UDDI server and get your subscription results (see the News Feed).
Here, we've selected the, I'll pick them up, option.
-[[figure-Using the jUDDI GUI-createsub5]]
-.Create a Subscription, Delivery Mechanism.
-image::images/juddi-gui-subscription5.png[Create a Subscription, Delivery Mechanism]
+
The final slider provides subscription options.
* Expiration - a date where the subscription expires
* Notification Interval - this is only used when the UDDI node sends the notifications to you via the Subscription Listener Service
* Brief - If true, the UDDI node will only tell you which items have changed, not what the change was.
-[[figure-Using the jUDDI GUI-createsub6]]
-.Create a Subscription, Options.
-image::images/juddi-gui-subscription6.png[Create a Subscription, Options]
+
-==== View My Subscriptions
+#### View My Subscriptions
To view, edit, and delete existing subscriptions, click on Home, then View Subscriptions.
-[[figure-Using the jUDDI GUI-viewsub]]
-.View Subscriptions.
-image::images/juddi-gui-subscription-view.png[View Subscriptions]
+
-==== View the News Feed
+#### View the News Feed
The New Feed is a simple page designed to show you subscription results for the past 24 hrs. To view the news feed, click on Home, then News Feed.
-[[UsingDigitalSignatures]]
-=== Using Digital Signatures in juddi-gui
+### Using Digital Signatures in juddi-gui
The juddi-gui makes working with digital signatures simple and enables you do digitally sign and protect entities right from the web browser. It allows you to sign business, services and tModels.
@@ -346,54 +284,39 @@ TIP: Digital signatures are performed using the jUDDI Digital Signature Applet w
TIP: You also need to have an X509 Certificate installed in either your Windows My/Current User Certificate Store or your MacOS Key Chain certificate store.
-==== Sign a Business, Service or tModel
+#### Sign a Business, Service or tModel
-[[figure-Using the jUDDI GUI-sign1]]
-.Select an entity, then click Digitally Sign.
-image::images/juddi-gui-sign1.png[Select an entity, then click Digitally Sign]
+
-[[figure-Using the jUDDI GUI-sign2]]
-.Java Plugin Warnings.
-image::images/juddi-gui-sign2.png[Java Plugin Warnings]
+
Select a certificate, then if you're ready to sign, click on "Digitally Sign". This will automatically generate the signature and save it in the UDDI server.
-[[figure-Using the jUDDI GUI-sign3]]
-.Select a Signing Certificate.
-image::images/juddi-gui-signerpanel1.png[Select a Signing Certificate]
+
Click on Certificate Info will display the following panel. This is useful if you have a few certificates that are similarly named.
-[[figure-Using the jUDDI GUI-sign4]]
-.Certificate Details.
-image::images/juddi-gui-signerpanel3.png[Certificate Details]
+
The settings tab gives you a number of options for advanced users. We recommend that you leave the defaults as is.
-[[figure-Using the jUDDI GUI-sign5]]
-.Signature Settings.
-image::images/juddi-gui-signerpanel2.png[Signature Settings]
+
-==== Verify a signed UDDI entity
+#### Verify a signed UDDI entity
Once an entity is signed, the juddi-gui will always attempt to validate the signature and will notify you if its signed and whether or not its valid.
In the following example, the business was signed.
-[[figure-Using the jUDDI GUI-validate]]
-.Valid Signed Entity.
-image::images/juddi-gui-signed-valid.png[Valid Signed Entity]
+
IMPORTANT: UDDI entities are hierarchical. A signed business entities includes all of the data for its services and binding templates. Any change to a service or binding template will cause the business's signature to be invalid. TModels are not affected by this.
In the following example, one of the services own by the business was changed. Note that the signature is now invalid due to the alteration.
-[[figure-Using the jUDDI GUI-invalid]]
-.Invalid Signed Entity.
-image::images/juddi-gui-signed-invalid.png[Invalid Signed Entity]
-
+
-=== Configuration
+### Configuration
The configuration page is usually restricted to system administrators. There are many fields that are displayed. Some of the are editable, others are not. In general, the following settings can be changed (the others are just for troubleshooting and informational purposes).
@@ -401,7 +324,7 @@ Details on configuration is located in chapter, jUDDI Server Configuration.
WARNING: Saving updates to the console configuration in _juddi-gui/WEB-INF/classes/META-INF/uddi.xml_ will only work if the juddi-gui is deployed as a folder.
-=== Language Codes
+### Language Codes
The Language Code is a field supported by UDDI that is inherited from the errata for XML Schema, which references RFC 3066, which can be read here: http://www.ietf.org/rfc/rfc3066.txt/. In general, Language Codes are either 2 or 5 characters but can by up to 26 characters. Here's a few examples
@@ -411,7 +334,7 @@ The Language Code is a field supported by UDDI that is inherited from the errata
More can be found here: http://www.i18nguy.com/unicode/language-identifiers.html
-=== Switching Nodes
+### Switching Nodes
The jUDDI GUI supports connectivity to multiple UDDI nodes. A UDDI Node is simple a collection of UDDI services that are all connected to the same data source. Another way to put it this, 'a UDDI server'. Each browser session to the jUDDI GUI has the ability to select the current Node connection. The current Node select is always saved as a cookie. To avoid any potential confusion, the currently selected Node is available both from the drop down Settings menu, and on the bottom of every page.
@@ -419,9 +342,7 @@ To switch nodes, simply select the desired node from the Settings menu.
IMPORTANT: When switching nodes, any unsaved work that you have will be lost. You will also be logged out of the old node if you were signed in.
-[[figure-Using the jUDDI GUI-noswitcher]]
-.Node Switcher.
-image::images/juddi-gui-nodeswitcher.png[Node Switcher]
+
TIP: Administrators can define the default node via the Setting, Configuration page.
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuidejUDDIClientConfigurationGuide.asciidoc b/src/site/markdown/ClientGuidejUDDIClientConfigurationGuide.md
similarity index 93%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuidejUDDIClientConfigurationGuide.asciidoc
rename to src/site/markdown/ClientGuidejUDDIClientConfigurationGuide.md
index 94abd01ee..7bd2348cd 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuidejUDDIClientConfigurationGuide.asciidoc
+++ b/src/site/markdown/ClientGuidejUDDIClientConfigurationGuide.md
@@ -1,28 +1,31 @@
-jUDDI Client Configuration Guide
---------------------------------
+## jUDDI Client Configuration Guide
+
+
+### Introduction
-Introduction
-~~~~~~~~~~~~
The jUDDI Java and .NET clients use an XML configuration file that dictates settings and behaviors.
This guide provides an overview of the settings. Both .NET and jUDDI use the same configuration file schema. This schema is located within the source tree and with the client distribution packages of jUDDI.
-Client Settings
-~~~~~~~~~~~~~~~
+### Client Settings
+
The root XML node for the jUDDI client configuration file is always "uddi".
-----
+
+````
<!-- applies to Java clients only -->
uddi/reloadDelay
-----
+````
Multiple clients can be defined in each configuration file.
-----
+
+````
uddi/client@name="someName"
-----
+````
+
+#### Nodes
-Nodes
-~~~~~
At least one node is required per client. A node represents a one logical UDDI server (or cluster of servers). Each UDDI node should host at least the inquiry service. A client using the jUDDI client package can be configured to access multiple nodes at the same time.
-----
+
+````
<!-- if isHomeJUDDI is true, then this node is loaded by default, when no node is specified in client code -->
uddi/client/nodes[]/node@isHomeJUDDI=true/false
<!-- the name of the node is referenced in client code -->
@@ -45,9 +48,10 @@ uddi/client/nodes[]/node/subscriptionUrl
uddi/client/nodes[]/node/subscriptionListenerUrl
<!-- note: this is for jUDDI v3.x servers only and is not part of the UDDI standard -->
uddi/client/nodes[]/node/juddiApiUrl
-----
+````
+
+#### Transport Options
-==== Transport Options
The Proxy Transport defines which mechanism is used for 'on the wire' transport of the UDDI XML messages. JAXWS Transport is the most commonly used and assumes SOAP messaging protocol over HTTP transport layer.
RMI Transport using the Java Remote Method Invocation for transport. It's more commonly used for communicating within a J2EE container, but could be used in other cases. It's not required by the UDDI specification and is considered a jUDDI add on.
@@ -56,18 +60,20 @@ InVM Transport is for hosting jUDDI services without a J2EE container.
JAXWSv2TranslationTransport is a bridge for accessing UDDIv2 web services using the UDDIv3 data structures and APIs. Only the Inquiry and Publish services are required and they must point to SOAP/HTTP endpoints for a UDDI v2 node.
-Clerks
-~~~~~~
+#### Clerks
+
Clerks are responsible for mapping stored user credentials to a Node and for automated registration.
-----
+
+````
<!-- if true, the contents of the child node xregister are registered when the UDDIClient object is created, using the credential and node reference.-->
uddi/client/clerks/registerOnStartup=true/false
-----
+````
+
+##### Clerk
-Clerk
-~~~~~
Clerks store credentials and map to a specific node.
-----
+
+````
<!-- the name is a reference to the Node that these credentials apply to-->
uddi/client/clerks[]/clerk@node - This is reference to uddi/client/node/name, it must exist
uddi/client/clerks[]/clerk@name - This is a unique identifier of the clerk
@@ -75,26 +81,28 @@ uddi/client/clerks[]/clerk@publisher - This is the username
uddi/client/clerks[]/clerk@password
uddi/client/clerks[]/clerk@isPasswordEncrypted=true/false
uddi/client/clerks[]/clerk@cryptoProvider=(see Crypto providers)
-----
+````
Credentials can be encrypted using the included batch/bash scripts and then appended to the configuration. Example with encryption:
-----
+
+````
<clerk name="default" node="default" publisher="root" password="(cipher text removed)"
isPasswordEncrypted="true" cryptoProvider="org.apache.juddi.v3.client.cryptor.AES128Cryptor" />
-----
+````
Clerks also have settings for the automated cross registration of Businesses and Services on start up.
-----
+
+````
uddi/client/clerks[]/xregister/service@bindingKey
uddi/client/clerks[]/xregister/service@fromClerk
uddi/client/clerks[]/xregister/service@toClerk
-----
+````
+
+#### Digital Signatures
-Digital Signatures
-~~~~~~~~~~~~~~~~~~
The Signature section contains settings that map to the Digital Signature Utility that makes working with UDDI digital signatures simple. The section contains all of the settings for both signing and validating signatures.
-----
+````
uddi/client/signature/signingKeyStorePath
uddi/client/signature/signingKeyStoreFilePassword
uddi/client/signature/signingKeyStoreFilePassword@isPasswordEncrypted
@@ -122,36 +130,38 @@ uddi/client/signature/keyInfoInclusionSerial
uddi/client/signature/keyInfoInclusionBase64PublicKey
<!-- default is http://www.w3.org/2000/09/xmldsig#sha1 -->
uddi/client/signature/digestMethod
-----
+````
+
+#### Subscription Callbacks
-Subscription Callbacks
-~~~~~~~~~~~~~~~~~~~~~~
The subscriptionCallbacks section defines settings uses by the subscription callback API. This enables developers to create capabilities that need to be notified immediately when something in UDDI changes through the use of subscriptions.
-----
+
+````
uddi/client/subscriptionCallbacks/keyDomain
uddi/client/subscriptionCallbacks/listenUrl this is the URL that is used for callbacks, should be externally resolvable
uddi/client/subscriptionCallbacks/autoRegisterBindingTemplate=true/false
uddi/client/subscriptionCallbacks/autoRegisterBusinessServiceKey=(key) append callback endpoint to this service
uddi/client/subscriptionCallbacks/signatureBehavior=(AbortIfSigned,Sign,DoNothing,SignOnlyIfParentIsntSigned), default DoNothing. Applies when auto registering the endpoint to a business or service that is already signed.
-----
+````
+
+#### XtoWsdl
-XtoWsdl
-~~~~~~~
XtoWsdl represents configuration parameters for importing WSDL or WADL files. Currently, the only setting is for ignoring SSL errors when fetching remote WSDL or WADL files.
-----
+
+````
uddi/client/XtoWsdl/IgnoreSSLErrors=true or false
-----
+````
+
+### Embedded jUDDI server
-Embedded jUDDI server
-~~~~~~~~~~~~~~~~~~~~~
jUDDI has the ability to run in embedded mode. This means that the jUDDI services can operate without a web servlet container, such as Tomcat or JBoss. Typically, this is something that application developers would use for more advanced scenarios and for operation without network connectivity.
-Requirements
-^^^^^^^^^^^^
+#### Requirements
+
A database server, if one is not available, the embedded Derby engine can be used.
-Changes in configuration compared to non-embedded
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+#### Changes in configuration compared to non-embedded
+
* META-INF/embedded-uddi.xml needs to contain the connection settings for InVmTransport.
....
<!-- In VM Transport Settings -->
diff --git a/docs/asciidoc/ClientGuide/en-US/ClientGuidejUDDIClientforNET.asciidoc b/src/site/markdown/ClientGuidejUDDIClientforNET.md
similarity index 80%
rename from docs/asciidoc/ClientGuide/en-US/ClientGuidejUDDIClientforNET.asciidoc
rename to src/site/markdown/ClientGuidejUDDIClientforNET.md
index a230b3c5c..4d1cd557b 100644
--- a/docs/asciidoc/ClientGuide/en-US/ClientGuidejUDDIClientforNET.asciidoc
+++ b/src/site/markdown/ClientGuidejUDDIClientforNET.md
@@ -1,21 +1,23 @@
-== jUDDI Client for NET
+## jUDDI Client for NET
Since 3.2, the majority of the functions in the jUDDI Client for Java have been ported to .NET. This guide will show you how to use it and integrate it with your own .NET based applications.
-=== Procedure
-. Add a reference to jUDDI-Client.NET.dll
-. Add a reference to System.Web.Services
-. Add a reference to System.ServiceModel
-. Add a reference to System.Xml
-. Add a reference to System.Runtime.Serialization
-. Add a reference to System.Configuration
-. Add a reference to System.Security
-. Add a copy of the sample uddi.xml file. Modify it to meet your environment and operational needs.
-. Note, many of the settings are identical to the Java jUDDI-client. The APIs are also nearly identical, so example code should be easily portable from one language to another.
+### Procedure
+
+1. Add a reference to jUDDI-Client.NET.dll
+3. Add a reference to System.Web.Services
+4. Add a reference to System.ServiceModel
+5. Add a reference to System.Xml
+6. Add a reference to System.Runtime.Serialization
+7. Add a reference to System.Configuration
+8. Add a reference to System.Security
+9. Add a copy of the sample uddi.xml file. Modify it to meet your environment and operational needs.
+
+Note, many of the settings are identical to the Java jUDDI-client. The APIs are also nearly identical, so example code should be easily portable from one language to another.
Sample Code
-----
+````
/*
* Copyright 2001-2013 The Apache Software Foundation.
@@ -74,7 +76,7 @@ namespace juddi_client.net_sample
}
}
-----
+````
The sample code above should print out a list of all businesses currently registered in the registry. If credentials are stored in the uddi.xml file and are encrypted, they will be decrypted automatically for you.
diff --git a/src/site/markdown/Guide.md b/src/site/markdown/Guide.md
new file mode 100644
index 000000000..c6eef3b54
--- /dev/null
+++ b/src/site/markdown/Guide.md
@@ -0,0 +1,9 @@
+# Apache jUDDI Guide
+
+## Dedication
+
+We'd like to dedicate this guide to Steve Viens and Andy Cutright who started this project back in 2003.
+
+## Preface
+
+The jUDDI project maintains a UDDIv3 registry that can be deployed to most modern JEE application servers. The jUDDI project is part of the Apache Software Foundation and encourages participation. It is easy to participate and if you discover a simple typo or would like to contribute to this guide in general please read the README page (add link).
diff --git a/docs/asciidoc/Guide/en-US/GuideAdministration.asciidoc b/src/site/markdown/GuideAdministration.md
similarity index 91%
rename from docs/asciidoc/Guide/en-US/GuideAdministration.asciidoc
rename to src/site/markdown/GuideAdministration.md
index fc14b7c28..bf5e24bc9 100644
--- a/docs/asciidoc/Guide/en-US/GuideAdministration.asciidoc
+++ b/src/site/markdown/GuideAdministration.md
@@ -1,43 +1,42 @@
-[[chapter-Administration]]
-== Administration
+## Administration
-=== Changing the Web Server Listen Port
+### Changing the Web Server Listen Port
If you want to change the port Tomcat listens on to something non-standard (something other than 8080), use the following guidance.
jUDDI Server (Tomcat) - This assumes you are using the jUDDI server bundled with Apache Tomcat. For other application servers, consult their documentation, however the juddiv3.xml must still be altered.
-- Edit `conf/server.xml` and change the port within the <Connector> element.
+- Edit `conf/server.xml` and change the port within the `<Connector>` element.
- Edit `webapps/juddiv3/WEB-INF/classes/juddiv3.xml` and change the port number jUDDI Server Baseurl.
- Edit `webapps/juddiv3/WEB-INF/config.properties` and change the port numbers for "securityurl" and "juddipapi".
- Edit `webapps/juddi-gui/META-INF/config.properties` and change the port numbers for all of the URLs listed.
If these changes are made before jUDDI has been started for the first time, then no further action is required. If jUDDI has been previously started, you'll need to either A) update the URL information for the Node's root business entity URLs or B) turn on "Seed Always" in the juddiv3.xml file to auto update the changes.
-=== Administering Users and Access Control
+### Administering Users and Access Control
As of version 3.2, jUDDI Authentication is handled from two perspectives, administrator and end user access.
-==== Administrative Users
+#### Administrative Users
Administrative users have special access to juddi-gui's remote configuration page at http://localhost:8080/juddi-gui/settings.jsp and to the Administrative Console at http://localhost:8080/juddiv3/admin. Access to both of these is configured at the container level (i.e. Jboss, Tomcat, etc). By default, users that need to access these pages need to have the "uddiadmin" role (which is defined in the WEB-INF/web.xml of both web application archives). When you are running on tomcat this conf [...]
-==== End Users
+#### End Users
End users typically will either access jUDDI's services directly at http://localhost:8080/juddiv3/ or via the user interfaces http://localhost:8080/juddi-gui. In both cases, authentication is handled via jUDDI's Authentication providers which is configured in `juddiv3.war/WEB-INF/classes/juddiv3.xml`.
-===== Under the Hood
+##### Under the Hood
In order to enforce proper write access to jUDDI, each request to jUDDI needs a valid authToken. Note that read access is not restricted (by default, but can be enabled) and therefore queries into the registries are not restricted.
To obtain a valid authToken a getAuthToken() request must be made, where a GetAuthToken object is passed. On the GetAuthToken object a userid and credential (password) needs to be set.
-----
+````
org.uddi.api_v3.GetAuthToken ga = new org.uddi.api_v3.GetAuthToken();
ga.setUserID("username");
ga.setCred("password");
org.uddi.api_v3.AuthToken token = securityService.getAuthToken(ga);
-----
+````
The property `juddi/auth/*` in the `juddiv3.xml` configuration file can be used to configure how jUDDI is going to check the credentials passed in on the GetAuthToken request. By default jUDDI uses the JUDDIAuthenticator implementation. You can provide your own authentication implementation or use any of the ones mention below. The implementation needs to implement the org.apache.juddi.auth.Authenticator interface, and `juddi/auth/authenticator/class` property should refer to the impleme [...]
@@ -51,182 +50,201 @@ The identify phase is responsible for turning the authentication token (or the p
The two phases provide compliance with the UDDI authentication structure and grant flexibility for users that wish to provide their own authentication mechanism. Handling of credentials and publisher properties can be done entirely outside of jUDDI. However, jUDDI provides the Publisher entity, which is a sub-class of UddiEntityPublisher, to persist publisher properties within jUDDI. This is used in the default authentication and is the subject of the next section.
-===== Choosing a Cryptographic Provider
+##### Choosing a Cryptographic Provider
jUDDI provides a number of cryptographic providers. Some of them may not be available in your region of the world due to export restrictions. All of these providers are provides that are included with the Oracle Java Runtime Environment.
-====== jUDDI's Cryptographic Providers
+###### jUDDI's Cryptographic Providers
TIP: The AES256Cryptor requires the Sun Java unlimited strength Crypograhpic Extensions to be installed. OpenJDK users are not affected by this.
In the following section, Authentication, a Cryptographic Provider must be selected using the following property in juddiv3.xml:
-----
+````
juddi/cryptor
-----
+````
-====== jUDDI Server Providers
+###### jUDDI Server Providers
* org.apache.juddi.cryptor.DefaultCryptor - Password Based Encryption With MD5 and DES
* org.apache.juddi.cryptor.TripleDESCrytor - Triple DES 168 bit
* org.apache.juddi.cryptor.AES128Cryptor - Advanced Encryption Standard 128 bit
* org.apache.juddi.cryptor.AES256Cryptor - Advanced Encryption Standard 256 bit
-===== jUDDI Client Providers (Java and .NET)
+##### jUDDI Client Providers (Java and .NET)
* org.apache.juddi.v3.client.crypto.DefaultCryptor - Password Based Encryption With MD5 and DES
* org.apache.juddi.v3.client.crypto.TripleDESCrytor - Triple DES 168 bit
* org.apache.juddi.v3.client.crypto.AES128Cryptor - Advanced Encryption Standard 128 bit
* org.apache.juddi.v3.client.crypto.AES256Cryptor - Advanced Encryption Standard 256 bit
-====== Encrypting a Password
+###### Encrypting a Password
To encrypt a password, the jUDDI Tomcat server comes with a basic Windows Batch file and a Unix Bash script which will fire off the correct Java command. It is located at the following path:
-----
+
+````
{tomcat_home}/bin/juddi-cryptor.bat/sh
-----
+````
TIP: The jUDDI-Client (Java only) uses the same encryption keys and the jUDDI Server, therefore encrypted passwords using this tool will work with the jUDDI-client's configuration file.
In addition, an MD5 hashing program is included to assist with setting users passwords for the MD5XMLDocAuthenticator.
-----
+````
{tomcat_home}/bin/juddi-md5.bat/sh
-----
+````
TIP: You can generate new encryption keys using this utility by specifying the System Property -Dgenerate=true option. You can then use them using the System Property -Djuddi.encryptionKeyFile.TripleDESCrytor=path/to/key
-===== jUDDI Authentication
+##### jUDDI Authentication
The default authentication mechanism provided by jUDDI is the JUDDIAuthenticator. The authenticate phase of the JUDDIAuthenticator simply checks to see if the user id passed in has an associated record in the Publisher table. No credentials checks are made. If, during authentication, the publisher does not exist, it the publisher is added on the fly.
WARNING: Do not use jUDDI Default Authenticator in production. It does not compare passwords to anything!
The identify phase uses the publisher id to retrieve the Publisher record and return it. All necessary publisher properties are populated as Publisher inherits from UddiEntityPublisher.
-----
+````
juddi/auth/authenticator/class = org.apache.juddi.auth.JUDDIAuthentication
-----
+````
-===== XMLDocAuthentication
+##### XMLDocAuthentication
The XMLDocAuthentication implementation needs a XML file on the classpath. The juddiv3.xml file would need to look like
-----
+
+````
juddi/auth/authenticator/class = org.apache.juddi.auth.XMLDocAuthentication
juddi/auth/usersfile = juddi-users.xml
-----
+````
+
where the name of the XML can be provided but it defaults to juddi-users.xml, and the content of the file would looks something like
-----
+
+````
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<juddi-users>
<user userid="anou_mana" password="password" />
<user userid="bozo" password="clown" />
<user userid="sviens" password="password" />
</juddi-users>
-----
+````
+
The authenticate phase checks that the user id and password match a value in the XML file. The identify phase simply uses the user id to populate a new UddiEntityPublisher.
-===== CryptedXMLDocAuthentication
+##### CryptedXMLDocAuthentication
The CryptedXMLDocAuthentication implementation is similar to the XMLDocAuthentication implementation, but the passwords are encrypted.
-----
+
+````
juddi/auth/authenticator/class = org.apache.juddi.auth.CryptedXMLDocAuthentication
juddi/auth/usersfile = juddi-users-encrypted.xml
juddi/cryptor = org.apache.juddi.cryptor.DefaultCryptor
-----
+````
+
where the name user credential file is juddi-users-encrypted.xml, and the content of the file would looks something like
-----
+
+````
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<juddi-users>
<user userid="anou_mana" password="+j/kXkZJftwTFTBH6Cf6IQ=="/>
<user userid="bozo" password="Na2Ait+2aW0="/>
<user userid="sviens" password="+j/kXkZJftwTFTBH6Cf6IQ=="/>
</juddi-users>
-----
+````
The DefaultCryptor implementation uses BEWithMD5AndDES and Base64 to encrypt the passwords. Note that the code in the AuthenticatorTest can be used to learn more about how to use this Authenticator implementation. You can plugin your own encryption algorithm by implementing the org.apache.juddi.cryptor.Cryptor interface and referencing your implementation class in the juddi.cryptor property.
The authenticate phase checks that the user id and password match a value in the XML file. The identify phase simply uses the user id to populate a new UddiEntityPublisher.
-===== MD5XMLDocAuthenticator
+##### MD5XMLDocAuthenticator
The MD5XMLDocAuthenticator implementation is similar to the XMLDocAuthentication implementation, but the passwords are hashed using MD5.
-----
+
+````
juddi/auth/authenticator/class = org.apache.juddi.auth.MD5XMLDocAuthenticator
juddi/auth/usersfile = juddi-users-hashed.xml
juddi/cryptor = org.apache.juddi.cryptor.DefaultCryptor
-----
+````
+
where the name user credential file is juddi-users-encrypted.xml, and the content of the file would looks something like
-----
+
+````
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<juddi-users>
<user userid="anou_mana" password="+j/kXkZJftwTFTBH6Cf6IQ=="/>
<user userid="bozo" password="Na2Ait+2aW0="/>
<user userid="sviens" password="+j/kXkZJftwTFTBH6Cf6IQ=="/>
</juddi-users>
-----
+````
+
The DefaultCryptor implementation uses BEWithMD5AndDES and Base64 to encrypt the passwords. Note that the code in the AuthenticatorTest can be used to learn more about how to use this Authenticator implementation. You can plugin your own encryption algorithm by implementing the org.apache.juddi.cryptor.Cryptor interface and referencing your implementation class in the juddi.cryptor property.
The authenticate phase checks that the user id and password match a value in the XML file. The identify phase simply uses the user id to populate a new UddiEntityPublisher.
-===== LDAP Authentication
+##### LDAP Authentication
LdapSimpleAuthenticator provides a way of authenticating users using LDAP simple authentication. It is fairly rudimentary and more LDAP integration is planned in the future, but this class allows you to authenticate a user based on an LDAP prinicipal, provided that the principal (usually the distinguished name) and the juddi publisher ID are the same.
To use this class you must add the following properties to the juddi3v.xml file:
-----
+
+````
juddi/auth/authenticator/class=org.apache.juddi.auth.LdapSimpleAuthenticator
juddi/auth/authenticator/url=ldap://localhost:389
juddi/auth/authenticator/style=simple
-----
+````
+
The juddi/authenticator/url property configures the LdapSimpleAuthenticator class so that it knows where the LDAP server resides. Future work is planned in this area to use the LDAP uid rather than the LDAP principal as the default publisher id.
LdapExpandedAuthenticator provides a slightly more flexible way to authenticate users via LDAP.
-----
+
+````
juddi/auth/authenticator/class=org.apache.juddi.v3.auth.LdapSimpleAuthenticator
juddi/auth/authenticator/url=ldap://localhost:389
juddi/auth/authenticator/style=simple
juddi/auth/authenticator/ldapexp=CN=%s, OU=Users,DC=Domain, etc
-----
+````
-===== JBoss Authentication
+##### JBoss Authentication
Is it possible to hook up to third party credential stores. If for example jUDDI is deployed to the JBoss Application server it is possible to hook up to it's authentication machinery. The JBossAuthenticator class is provided in the docs/examples/auth directory. This class enables jUDDI deployments on JBoss use a server security domain to authenticate users.
TIP: The JBoss authentication is not distributed with jUDDI. It can be found here: http://svn.apache.org/viewvc/juddi/extras/jbossauthenticator/src/org/apache/juddi/auth/JBossAuthenticator.java?view=markup
To use this class you must add the following properties to the juddiv3.xml file:
-----
+
+````
juddi/auth/authenticator/class=org.apache.juddi.auth.JBossAuthenticator
juddi/auth/securityDomain=java:/jaas/other
-----
+````
+
The juddi/auth/authenticator/class property plugs the JbossAuthenticator class into the jUDDI the Authenticator framework. The juddi/sercuityDomain, configures the JBossAuthenticator class where it can lookup the application server's security domain, which it will use to perform the authentication. Note that JBoss creates one security domain for each application policy element on the `$JBOSS_HOME/server/default/conf/login-config.xml` file, which gets bound to the server JNDI tree with na [...]
-===== Container Based Authentication
+##### Container Based Authentication
Certain security configurations may use HTTP based authentication. In this scenario, jUDDI simply trust's that the container will authenticate the user via some mechanism and uses that username for interactions with jUDDI. To configure this setup, use the following configuration settings in juddiv3.xml:
-----
+
+````
juddi/auth/authenticator/class=org.apache.juddi.auth.HTTPContainerAuthenticator
juddi/auth/authenticator@useAuthToken=false
-----
+````
In addition, you'll have to make whatever changes necessary to the juddiv3.war/WEB-INF/web.xml file in order to use the chosen authentication mechanism. See your appliation server's documentation for details on this.
-===== Authentication by Proxy (HTTP Header)
+##### Authentication by Proxy (HTTP Header)
Certain security configurations that enforce authentication before requests come to the web application, such as via Apache HTTPD or a reverse SSL proxy. In these cases, the proxy provided authenticates the user, then passes along the user's identity via a HTTP header. To configure this setup, use the following configuration settings in juddiv3.xml:
-----
+
+````
juddi/auth/authenticator/class=org.apache.juddi.auth.HTTPHeaderAuthenticator
juddi/auth/authenticator/header=(Some HTTP Header)
juddi/auth/authenticator@useAuthToken=false
-----
+````
-[[ConfiguringDatabaseConnections]]
-=== Configuration Database Connections
+### Configuration Database Connections
-==== Derby Out-of-the-Box
+#### Derby Out-of-the-Box
By default jUDDI uses an embedded Derby database. This allows us to build a downloadable distribution that works out-of-the-box, without having to do any database setup work. We recommend switching to an enterprise-level database before going to production. JUDDI uses the Java Persistence API (JPA) in the back end and we've tested with both OpenJPA and Hibernate. To configure which JPA provider you want to use, you will need to edit the configuration in the _juddiv3.war/WEB-INF/class [...]
To make it easy we created different versions for different JPA implementations and target platforms. All JPA implementation have an enhancement phase, where the persistence 'model' classes are enhanced. Hibernate does this at runtime, OpenJPA prefers doing this at compile time. This is the reason we ship two versions of _juddi-core_, where the _juddi-core-openjpa.jar_ contains classes (byte-code) enhanced by OpenJPA. This is the reason this jar is larger then the _juddi-core.jar_.
For Hibernate, for testing the content of this file looks like
-....
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://java.sun.com/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -251,9 +269,11 @@ For Hibernate, for testing the content of this file looks like
</properties>
</persistence-unit>
</persistence>
-....
+````
+
For OpenJPA the persistence.xml looks like
-....
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://java.sun.com/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -280,9 +300,11 @@ For OpenJPA the persistence.xml looks like
</properties>
</persistence-unit>
</persistence>
-....
+````
+
In this case we reference a _jta-data-source_ called _java:comp/env/jdbc/JuddiDS_. Datasource deployment is Application Server specific. If you are using Tomcat, then the datasource is defined in _juddi/META-INF/context.xml_ which by default looks like
-....
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<Context>
<WatchedResource>WEB-INF/web.xml</WatchedResource>
@@ -293,10 +315,11 @@ In this case we reference a _jta-data-source_ called _java:comp/env/jdbc/JuddiDS
maxActive="8"
/>
</Context>
-....
+````
+
By default the juddiv3.war is configured to be used on Tomcat using OpenJPA. However the download bundle lets you specify different target platforms resulting in a different setup. In all cases it will point to the embedded Derby database.
-==== Switching to another Database
+#### Switching to another Database
We recommend switching to an enterprise-level database before going to production. Most JPA providers support a large number of Databases and switching to another database is achieved by updating the configuration settings in both the persistence.xml and datasource files. The recipe is:
@@ -307,18 +330,21 @@ We recommend switching to an enterprise-level database before going to productio
Some examples for specific databases are given below.
-WARNING: Tomcat copies the _context.xml_ to _<tomcat>/conf/CATALINA/localhost/juddiv3.xml_, and if you update the _context.xml_ it may not update this copy. You should simply delete the _juddiv3.xml_ file after updating the _context.xml_.
+WARNING: Tomcat copies the _context.xml_ to `<tomcat>/conf/CATALINA/localhost/juddiv3.xml`, and if you update the _context.xml_ it may not update this copy. You should simply delete the _juddiv3.xml_ file after updating the _context.xml_.
-==== Switch to MySQL on Tomcat using OpenJPA
+#### Switch to MySQL on Tomcat using OpenJPA
Check if you have are using Hibernate of OpenJPA, by looking at the jars in the _juddiv3.war/WEB-INF/lib_.
Edit the dialect in the _persistence.xml_
For OpenJPA:
-....
+
+````
<property name="openjpa.jdbc.DBDictionary" value="mysql"/>
-....
+````
+
Next edit the datasource. For tomcat you need to update the _juddiv3/META-INF/context.xml_ which should look something like
-....
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<Context>
<WatchedResource>WEB-INF/web.xml</WatchedResource>
@@ -328,24 +354,28 @@ Next edit the datasource. For tomcat you need to update the _juddiv3/META-INF/co
url="jdbc:mysql://localhost:3306/juddiv3"
maxActive="8"/>
</Context>
-....
+````
Finally you need to add the MySQL mysql driver (i.e. The _mysql-connector-java-5.1.6.jar_) to the classpath. Note that this jar may already by in the tomcat/lib directory, in which case you can move on to the step and create the mysql juddiv3 database. To create a MySQL database name +juddiv3+ use
-----
+
+````
mysql> create database juddiv3
-----
-and finally you probably want to switch to a user which is a bit less potent then _root_, and delete the _<tomcat>/conf/CATALINA/localhost/juddiv3.xml_ file.
+````
+and finally you probably want to switch to a user which is a bit less potent then _root_, and delete the `<tomcat>/conf/CATALINA/localhost/juddiv3.xml` file.
-==== Switch to Postgres on Tomcat using OpenJPA
+#### Switch to Postgres on Tomcat using OpenJPA
Check if you have are using Hibernate of OpenJPA, by looking at the jars in the _juddiv3.war/WEB-INF/lib_.
Edit the dialect in the _persistence.xml_
For OpenJPA:
-....
+
+````
<property name="openjpa.jdbc.DBDictionary" value="postgres"/>
-....
+````
+
Next edit the datasource. For tomcat you need to update the _juddiv3/META-INF/context.xml_ which should look something like
-....
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<Context>
<WatchedResource>WEB-INF/web.xml</WatchedResource>
@@ -355,25 +385,30 @@ Next edit the datasource. For tomcat you need to update the _juddiv3/META-INF/co
url="jdbc:postgresql://localhost:5432/juddi"
maxActive="8"/>
</Context>
-....
+````
+
To create a MySQL database name _juddi_ use
-----
+
+````
postgres= CREATE USER juddi with PASSWORD 'password';
postgres= CREATE DATABASE juddi;
postgres= GRANT ALL PRIVILEGES ON DATABASE juddi to juddi;
-----
-Be sure to have _postgresql-8.3-604.jdbc4.jar_ to the classpath. Note that this jar may already by in the tomcat/lib directory, in which case the final step is to delete the _<tomcat>/conf/CATALINA/localhost/juddiv3.xml_ file.
+````
+Be sure to have _postgresql-8.3-604.jdbc4.jar_ to the classpath. Note that this jar may already by in the tomcat/lib directory, in which case the final step is to delete the `<tomcat>/conf/CATALINA/localhost/juddiv3.xml` file.
-==== Switch to Postgres on JBoss using Hibernate
+#### Switch to Postgres on JBoss using Hibernate
This was written from a JBoss - jUDDI perspective. Non-JBoss-users may have to tweak this a little bit, but for the most part, the files and information needed is here. Logged in as postgres user, access psql:
-----
+
+````
postgres= CREATE USER juddi with PASSWORD 'password';
postgres= CREATE DATABASE juddi;
postgres= GRANT ALL PRIVILEGES ON DATABASE juddi to juddi;
-----
+````
+
Note, for this example, my database is called juddi, as is the user who has full privileges to the database. The user 'juddi' has a password set to 'password'. Next edit the juddi-ds.xml datasource file with the settings for the postgres connection info:
-....
+
+````
<datasources>
<local-tx-datasource>
<jndi-name>JuddiDS</jndi-name>
@@ -395,56 +430,73 @@ Note, for this example, my database is called juddi, as is the user who has full
</metadata>
</local-tx-datasource>
</datasources>
-....
+````
+
In _persistence.xml_, reference the correct JNDI name of the datasource and remove the derby Dialect and add in the postgresql Dialect, for Hibernate on JBoss use:
-....
+
+````
<jta-data-source>java:comp/env/jdbc/JuddiDS</jta-data-source>
...
+
<property name="hibernate.dialect" value="org.hibernate.dialect.PostgreSQLDialect"/>
-....
+````
+
Be sure to have _postgresql-8.3-604.jdbc4.jar_ in the _lib_ folder.
-==== Switch to Oracle on Tomcat using Hibernate
+#### Switch to Oracle on Tomcat using Hibernate
To switch over to Oracle you need to add the oracle driver (i.e. the_classes12.jar_) to the classpath and you will need to edit the _persistence.xml_
-....
+
+````
<property name="hibernate.dialect" value="org.hibernate.dialect.Oracle10gDialect"/>
-....
+````
+
To create a Oracle database name juddiv3 with the ultimate in minimalism use
-----
+
+````
sqlplus> create database juddiv3;
-----
-then you probably want to switch to a user which is a bit less potent then 'root' and set the appropriate password, and delete the _<tomcat>/conf/CATALINA/localhost/juddiv3.xml_
+````
+
+then you probably want to switch to a user which is a bit less potent then 'root' and set the appropriate password, and delete the `<tomcat>/conf/CATALINA/localhost/juddiv3.xml`
-===== Changing the Oracle Sequence name
+##### Changing the Oracle Sequence name
If you are using Hibernate as a persistence layer for jUDDI, then Oracle will generate a default sequence for you ("HIBERNATE_SEQUENCE"). If you are using hibernate elsewhere, you may wish to change the sequence name so that you do not share this sequence with any other applications. If other applications try to manually create the default hibernate sequence, you may even run into situations where you find conflicts or a race condition.
The easiest way to handle this is to create an orm.xml file and place it within the classpath in a META-INF directory, which will override the jUDDI persistence annotations and will allow you to specify a specific sequence name for use with jUDDI. The orm.xml.example specifies a "juddi_sequence" sequence to be used with jUDDI. Rename this file and update it to your liking.
-==== Switch to HSQL on Tomcat using Hibernate
+#### Switch to HSQL on Tomcat using Hibernate
First make sure you have a running hsqldb. For a standalone server startup use:
-----
+
+````
java -cp hsqldb.jar org.hsqldb.server.Server --port 1747 --database.0 file:juddi --dbname.0 juddi
-----
+````
+
Next, connect the client manager to this instance using:
-----
+
+````
java -classpath hsqldb.jar org.hsqldb.util.DatabaseManagerSwing --driver org.hsqldb.jdbcDriver --url jdbc:hsqldb:hsql://localhost:1747/juddi -user sa
-----
+````
+
and create the juddi user:
-----
+
+````
CREATE USER JUDDI PASSWORD "password" ADMIN;
CREATE SCHEMA JUDDI AUTHORIZATION JUDDI;
SET DATABASE DEFAULT INITIAL SCHEMA JUDDI;
ALTER USER juddi set initial schema juddi;
-----
+````
+
From now on, one can connect as JUDDI user to that database and the database is now ready to go. To switch jUDDI over to HSQL you need to add the hsql driver (i.e. The _hsqldb.jar_) to the classpath and you will need to edit the _persistence.xml_
-....
+
+````
<property name="hibernate.dialect" value="org.hibernate.dialect.HSQLDialect"/>
-....
+````
+
and the datasource. For tomcat you the _context.xml_ should look something like
-....
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<Context>
<WatchedResource>WEB-INF/web.xml</WatchedResource>
@@ -455,53 +507,58 @@ and the datasource. For tomcat you the _context.xml_ should look something like
url="jdbc:hsqldb:hsql://localhost:1747/juddi"
maxActive="8"/>
</Context>
-....
+````
-==== Switch to other db
+#### Switch to other db
If you use another database, please document, and send us what you had to change to make it work and we will include it here.
-==== Override persistence properties in the juddiv3.xml
+#### Override persistence properties in the juddiv3.xml
The juddiv3.xml file can be externalized; if you give the path of juddiv3.xml in the JVM args, the juddiv3.xml will not be picked up from the WAR. To use this set the _juddi.propertiesFile_ to a location of your configuration file. This allows the user to change the jUDDI properties without having to open up the juddiv3.war file. For this use case it makes sense that also persistence properties can be overridden as well in the juddiv3.xml file. The following properties can be set:
-.Hibernate properties that can be referenced in the _juddiv3.xml_ file
-[options="header"]
-|===========================================================================================
+Hibernate properties that can be referenced in the _juddiv3.xml_ file
+
|property name |description |example value
+| --- | --- | --- |
|persistenceProvider |JPA Implementation |Hibernate
|hibernate.connection.datasource |datasource name |java:/jdbc/JuddiDS
|hibernate.hbm2ddl.auto |hibernate to ddl setting |java:/jdbc/JuddiDS
|hibernate.default_schema |Schema name |JuddiSchema
|hibernate.dialect |DataBase vendor name |org.hibernate.dialect.DB2Dialect
-|===========================================================================================
-=== Logging
+### Logging
The jUDDI codebase uses the _commons-logging-api_, and _log4j_ as the default logging implementation. The _juddiv3/WEB-INF/classes/commons-logging.properties_ sets the logging to _log4j_. The default _log4j_ configuration logs to a _juddi.log_ file in the _tomcat/logs_ directory. The _log4j_ configuration lives in the _juddiv3/WEB-INF/classes/log4j.properties_ file, which is referenced in the _web.xml_
-....
+
+````
<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>/WEB-INF/classes/log4j.properties</param-value>
</context-param>
-....
+````
+
The _commons-logging_ and _log4j_ jars are shipped in the _juddiv3/WEB-INF/lib_ directory.
If you are using CXF for the webservice stack you can log the request/response xml by adding
-....
+
+````
log4j.category.org.apache.cxf=INFO
-....
+````
+
to your log4j.properties and the cxf.xml file should contains this:
-....
+
+````
<cxf:bus>
<cxf:features>
<cxf:logging/>
</cxf:features>
</cxf:bus>
-....
+````
+
The jUDDI beans.xml specifies the location of this file at _META-INF/cxf/cxf.xml_.
-=== Administering the GUI (juddi-gui.war)
+### Administering the GUI (juddi-gui.war)
There are a few things worth mentioning for administering the jUDDI Graphical User Interface. The first is user authentication, which is covered in the authentication chapter. The other the the Digital Signature Applet. This applet enables users to digitally signed UDDI entities via the GUI. There are a number of requirements in order for this to work.
@@ -509,19 +566,21 @@ There are a few things worth mentioning for administering the jUDDI Graphical Us
- The Oracle Java browser plugin must be installed. For details on this, visit Oracle's website.
- The end user must have a digital certificate installed that is accessible to the browser. On Windows computers, this is supported by Internet Explorer, Opera and Chrome which use the Windows Certificate Store (Start > Run > MMC, Add Certificates). Firefox uses its own certificate store. On MacOS, Safari uses the Mac Keychain.
-=== Task: Signing the Digital Signature Applet jar file
+### Task: Signing the Digital Signature Applet jar file
-....
+````
jarsigner -keystore your.keystore -storepass yourpass -keypass keypass <pathto>/juddi-gui.war/applets/juddi-gui-dsig-all.jar
-....
+````
+
Note: Jarsigner comes with most JDKs and has many command line options.
-=== Administrating your jUDDI Instance using the Administrative Console
+### Administrating your jUDDI Instance using the Administrative Console
Your instance of the jUDDI (juddiv3.war) can be managed via the administration console. It can be access url the following URL:
-----
+
+````
http://localhost:8080/juddiv3/admin
-----
+````
By default, only users with the role "uddiadmin" are allowed to access this page. In addition, it must be accessed from the same computer hosting juddiv3.war (this can be changed if needed). When accessing the URL, you should be prompted for login via username/password (this can also be changed to another mechanism).
@@ -533,72 +592,72 @@ After authenticating, you will be prompted with a very similar interface to the
*Why is there another login required for the jUDDIv3 API functions?
-The answer is because the admin console will be directly accesses a web service and it requires a user account with juddi admin rights. This may be the same username you use to access the admin console (juddiv3.war/admin) but unfortunately, this double login is unavoidable.
+The answer is because the admin console directly accesses a web service and it requires a user account with juddi admin rights. This may be the same username you use to access the admin console (juddiv3.war/admin) but unfortunately, this double login is unavoidable.
-=== Configure jUDDI
+### Configure jUDDI
From the browser, it is possible to configure jUDDI's web services via the web browser. All of the settings available from the chapter on configuring jUDDI can be set there.
-==== Enabling Remote Access
+#### Enabling Remote Access
The jUDDI Configuration page by default is only accessible via the same host that is hosting the server. To enable remote access, change the setting
-----
+````
config/props/configLocalHostOnly=true
-----
+````
To false.
+jUDDI Server Configuration Page.
+
+
-[[figure-GuideAdministrator-Configure]]
-.jUDDI Server Configuration Page.
-image::images/juddi-admin-configure.png[jUDDI Server Configuration Page]
-=== Monitoring the Status and Statistics
+### Monitoring the Status and Statistics
The Statistics and Status page provides valuable information to administrators and developers looking to trouble shoot or debug problems with jUDDI.
-==== Statistics
+#### Statistics
The Statistics page provides you with access to usage counts and time spent processing on each method of each service that jUDDI provides.
TIP: This information can be pulled and is available in JSON encoded data from the following URL: http://localhost:8080/juddiv3/admin/mbeans.jsp
-[[figure-GuideAdministrator-Statistics]]
-.jUDDI Server Statistics.
-image::images/juddi-admin-stats.png[jUDDI Server Statistics]
+jUDDI Server Statistics.
+
+
or you can hook up the jconsole to look at the jUDDI mbeans
-[[figure-GuideAdministrator-MBeans]]
-.jUDDI MBeans.
-image::images/juddi-admin-mbeans.png[jUDDI MBeans]
+jUDDI MBeans.
+
+
-==== Status
+#### Status
The Status page gives you the former "Happy jUDDI" page from version 2 of jUDDI.
-[[figure-GuideAdministrator-Status]]
-.jUDDI Server Status.
-image::images/juddi-admin-status.png[jUDDI Server Status]
+jUDDI Server Status.
-=== Accessing the jUDDIv3 API
+
+
+### Accessing the jUDDIv3 API
The jUDDI API is a web service that extends the UDDI specification. It provides various functions for both configuring the jUDDI server and for performing administrative functions, such as authorizing a new username as a publisher, user rights assignment and so on. This page will let you access the functions from the web browser.
TIP: You must authenticate using the top right hand side login/password box in order to use this.
-[[figure-GuideAdministrator-API]]
-.jUDDI API.
-image::images/juddi-admin-juddiapi.png[jUDDI API]
+jUDDI API.
+
+
-=== Security Guidance
+### Security Guidance
This guide contains general security guidelines to ensure that your jUDDI server and jUDDI Client based application are relatively safe and to prevent authorized users.
This section is broken down into guidance for the jUDDI server and for the jUDDI Client
-==== jUDDI Server
+#### jUDDI Server
* Always use SSL or TLS for connections to and from the jUDDI server, especially connections where authentication is used. Use encrypted connections to the database server when possible. client configs (uddi.xml), database (juddiv3/WEB-INF/classes/META-INF/persistence.xml)
@@ -622,7 +681,7 @@ This section is broken down into guidance for the jUDDI server and for the jUDDI
* If you're using the replication services, configure your application server to use mutual certification authentication for that deployment (per the specification's recommendation).
-==== jUDDI Client (and developers)
+#### jUDDI Client (and developers)
* Never log auth tokens. Protect it as if it was a password
@@ -630,7 +689,7 @@ This section is broken down into guidance for the jUDDI server and for the jUDDI
* Discard auth tokens when they are no longer needed.
-==== jUDDI GUI (Web user interface)
+#### jUDDI GUI (Web user interface)
* Enable automatic logouts (WEB-ING/classes/META-INF/uddi.xml)
@@ -650,19 +709,19 @@ This section is broken down into guidance for the jUDDI server and for the jUDDI
* The juddi-gui has a settings page that is password protected to prevent unauthorized changes. Use the strongest available mechanism to protect credentials. The default configuration is for HTTP BASIC. It is recommended to use this with SSL/TLS and/or switch to DIGEST based authentication. If the settings page isn't required, it can be removed.
-=== Backups, Upgrading and Data Migration
+### Backups, Upgrading and Data Migration
There are several different strategies for managing your jUDDI backups.
-==== Database Backups
+#### Database Backups
Database backups are vendor specific and are effective for backup/restore to a similar or exact jUDDI version reinstall.
-==== Config Backup
+#### Config Backup
Aside from database backups, you should also make backup copies of all jUDDI configuration files and any files that you have customized to meet your operational needs.
-=== Upgrading jUDDI
+### Upgrading jUDDI
Sometimes, the jUDDI development team has no choice but to alter the database schema. In many cases, OpenJPA or Hibernate (both Java Persistence API provides) will automatically alter database columns when a new version is installed. In some cases, there may actually be data loss.
@@ -670,28 +729,28 @@ TIP: Check the jUDDI distribution notes before attempting an upgrade.
IMPORTANT: Always perform a database level backup of your instance before attempting the upgrade.
-=== Scaling jUDDI and Federation
+### Scaling jUDDI and Federation
The capabilities and components provided by jUDDI are designed to scale. The following will describe the options and known limitations of jUDDI.
-==== Scaling the jUDDI Services (multiple servers)
+#### Scaling the jUDDI Services (multiple servers)
The jUDDI web services (juddiv3.war) is designed to be scaled to multiple servers in a number of ways. The following sub sections outline the available options.
-===== Scaling using a common database
+##### Scaling using a common database
The first and simplest mechanism is for the instances of juddiv3.war to share the same database. All of jUDDI's database calls are transactional SQL, meaning that concurrent changes will function just fine from multiple concurrent users. Each instance of juddiv3.war must point to the same database and must use the same Node ID and configuration settings. See the Database Configuration Chapter for more information.
-===== Scaling using Subscriptions
+##### Scaling using Subscriptions
The second mechanism is to use the Subscription API to import data and updates from a remote registry. Unfortunately, this scenario isn't quite yet supported for jUDDI, but may be in a future release.
-===== Replication API
+##### Replication API
The third mechanism is the Replication API, which is part of the OASIS UDDIv3 specification. Since version 3.3, jUDDI provides support for synchronizating UDDI servers using the techniques described in the specification as Replication. See the Replication Services chapter for additional information,
-==== Limitations of jUDDI
+#### Limitations of jUDDI
jUDDI's web services have no explicit upper bound on the volume of businesses and services registered. Load testing has shown that at least 10,000 are supported for each category. The upper limit is more of a function of both the underlying database implementation and hardware (free disk space). In either case, the likelihood of hitting the limit is low for most instances. If you happen to run into scaling issues, please file a bug report at JUDDI's JIRA site at: https://issues.apache.or [...]
diff --git a/docs/asciidoc/Guide/en-US/GuideArchitecture.asciidoc b/src/site/markdown/GuideArchitecture.md
similarity index 81%
rename from docs/asciidoc/Guide/en-US/GuideArchitecture.asciidoc
rename to src/site/markdown/GuideArchitecture.md
index 7adfc20ec..d4ba9c967 100644
--- a/docs/asciidoc/Guide/en-US/GuideArchitecture.asciidoc
+++ b/src/site/markdown/GuideArchitecture.md
@@ -1,21 +1,18 @@
-[[chapter-jUDDIArchitecture]]
-== jUDDI Architecture
+## jUDDI Architecture
-=== jUDDI Server
+### jUDDI Server
The jUDDI Architecture leverages well known frameworks to minimize the codebase we need to maintain. The API layer uses JAX-WS, while the persistence layer uses JPA. The entire server is packages as a war archive that can be deployed to different servlet containers with minimal configuration changes. The JPA layer uses JDBC to communicate to a relational database. <<figure-jUDDIArchitecture-Architecture>> shows the different components, where the implementation providers marked with a bl [...]
-[[figure-jUDDIArchitecture-Architecture]]
-.jUDDI Architecture
-image::images/jUDDIArchitecture_server.png[jUDDI Architecture Diagram]
+
-==== UDDI API layer `uddi-ws` using JAX-WS
+#### UDDI API layer `uddi-ws` using JAX-WS
The API layer is generated from the WSDL files provided with the UDDI specification. Since the 3.2 release we support both the UDDIv2 as well as the UDDIv3 API. The `uddi-ws` components leverages `JAX-WS` annotations to bring up the UDDIv2 and v3 Endpoints. In addition to these two sets of SOAP based services, we also support a REST based API. The REST based API is a subset of the SOAP API. The default JAX-WS implemention used is Apache CXF, but we also offer scripted deployments for [...]
-The `juddi-client.jar` can be used on the client side to communicate with the API layer. The juddi-client can be configured to use either SOAP, RMI or and inVM protocol, where the inVM protocol is the most performant. For more details on the juddi-client configuration options see the Client Guide <<Guide#stam-oree>>.
+The `juddi-client.jar` can be used on the client side to communicate with the API layer. The juddi-client can be configured to use either SOAP, RMI or and inVM protocol, where the inVM protocol is the most performant. For more details on the juddi-client configuration options see the Client Guide.
-==== Core UDDI `juddi-core` using JPA
+#### Core UDDI `juddi-core` using JPA
The jUDDI server logic is packaged in the `juddi-core.jar`. It implements all of the server side behavior defined in the UDDI specification. For persistence it uses the Java Peristence Api (JPA). The default JPA implemenation used is OpenJPA, but Hibernate is supported as well. The configuration for JPA implementations lives in the `WEB-INF/classes/META-INF/persistence.xml` file. This file also references the datasource that is used to connect to the datasource.
@@ -23,7 +20,7 @@ IMPORTANT: It is important to note that there are two JARs provided through mave
The difference between these JARs is that the persistence classes within juddi-core-openjpa have been enhanced (http://people.apache.org/~mprudhom/openjpa/site/openjpa-project/manual/ref_guide_pc_enhance.html). Unfortunately, the Hibernate classloader does not deal well with these enhanced classes, so it it important to note not to use the juddi-core-openjpa JAR with Hibernate.
-==== Relational Databases
+#### Relational Databases
By default we ship jUDDI preconfigured with a Java based Database called `Derby`. This database persists to the local file system, typically from where the application was started.
@@ -31,7 +28,7 @@ NOTE: To switch databases, you need to change the JDBC driver configuration in t
For details on switching database see the <<GuideAdministration#ConfiguringDatabaseConnections>>.
-==== Servlet Containers
+#### Servlet Containers
The jUDDI server is packaged up a WebArchive (`juddiv3.war`). This war archive can be deployed to different servlet containers with minimal configuration changes. By default we ship on Apache Tomcat but we also have scripted deployment support for GlassFish and JBoss.
@@ -40,25 +37,25 @@ TIP: Most open source EE6 containers (JBoss, Geronimo, Glassfish) ship with jUDD
When switching containers you may need to use different configuration to create a datasource. Some containers already package up a WebServices stack which can be used instead of the CXF packages up in juddiv3.war/WEB-INF/lib. In that case the number of dependent jars in the `juddiv3.war` can be reduced significantly. For details on switching containers see the <<GuideHowToDeployjUDDITo#chapter-HowToDeployjUDDITo>>.
-=== jUDDI GUI `juddi-gui.war`
+### jUDDI GUI `juddi-gui.war`
The jUDDI GUI is also a Web Archive that is deployed along side the `juddiv3` server in the same servlet container. The GUI uses the `juddi-client` to communicate to the UDDI API Endpoints. It can use a SOAP, RMI or an inVM transport protocol, so the GUI can be deployed in a different location then the server as long as it can connect to the UDDI SOAP API.
-[[figure-jUDDIArchitecture-ClientGui]]
-.jUDDI Client and Console Architecture
-image::images/jUDDIArchitecture_clientAndGui.png[jUDDI Client and GUI Diagram]
+jUDDI Client and GUI Architecture
-<<figure-jUDDIArchitecture-ClientGui>> shows the admin console and the juddi-gui. Typically one one run the admin console behind a firewall. The admin console interacts over a jUDDI WS API and, among other things, it can be used to create and delete publishers.
+
+
+The diagram above shows the admin console and the juddi-gui. Typically usage is run the admin console behind a firewall and/or restrict access to localhost connections only. The admin console interacts over a jUDDI WS API and, among other things, it can be used to create and delete publishers.
The `juddi-gui` can be configured to connect to any UDDIv2 or UDDIv3 compliant UDDI server.
-[[figure-jUDDIArchitecture-Gui]]
-.jUDDI Console Architecture
-image::images/jUDDIArchitecture_Gui.png[jUDDI GUI Diagram]
+jUDDI Console Architecture
+
+
You may have a jUDDI v3 Server for each type of environment (Dev, QA and Prod) and you would only need one console to connect to each one of them.
-For details on using the GUI see the Client and GUI Guide <<Guide#stam-oree>>.
+For details on using the GUI see the Client and GUI Guide .
diff --git a/docs/asciidoc/Guide/en-US/GuideConfigurationServer.asciidoc b/src/site/markdown/GuideConfigurationServer.md
similarity index 74%
rename from docs/asciidoc/Guide/en-US/GuideConfigurationServer.asciidoc
rename to src/site/markdown/GuideConfigurationServer.md
index 31f10a0eb..9b11266ad 100644
--- a/docs/asciidoc/Guide/en-US/GuideConfigurationServer.asciidoc
+++ b/src/site/markdown/GuideConfigurationServer.md
@@ -1,60 +1,54 @@
-[[jUDDIServerConfig]]
-== jUDDI Server Configuration (`juddiv3.xml`)
+## jUDDI Server Configuration (`juddiv3.xml`)
jUDDI will look for a `juddiv3.xml` file on the root of the classpath. In the `juddiv3.war` you can find it in `juddiv3.war/WEB_INF/classes/juddiv3.xml`.
-----
+
Since 3.2 the jUDDI server now uses an XML file for configuration. Previous versions uses a properties file.
-----
IMPORTANT: When referring to configuration 'properties', we are really referencing the XPath to specified setting.
-=== Authentication
+### Authentication
+
+Authentication properties that can be referenced in the `juddiv3.xml` file
-.Authentication properties that can be referenced in the juddiv3.xml file
-[options="header"]
-|===========================================================================================
|Property Name |Description |Required |Default Value or [Example Value]
-|_juddi/auth/authenticator/class_ |The jUDDI authenticator class to use. See Chapter <add ref> of the Userguide for the choices provided. |N |_org.apache.juddi.v3.auth.JUDDIAuthenticator_
+| --- | --- | --- | --- |
+|_juddi/auth/authenticator/class_ |The jUDDI authenticator class to use. See the Userguide for the choices provided. |N |_org.apache.juddi.v3.auth.JUDDIAuthenticator_
|_juddi/auth/Inquiry_ |This flag determines whether authentication (the presence of a getAuthToken) is required on queries invoking the Inquiry API. By default, jUDDI sets this to false for ease of use.|N |_false_
-
|_juddi/auth/token/Timeout_ |Time in minutes to expire tokes after inactivity.|N |_15_
|_juddi/auth/token/Expiration_ |As of 3.1.5 Duration of time for tokens to expire, regardless of inactivity.|N |_15_
|_juddi/auth/token/enforceSameIPRule_ |As of 3.2 This setting will enable or disable the auth token check to ensure that auth tokens can only be used from the same IP address that they were issued to..|N |_true_
|_juddi/auth/authenticator@useAuthToken_ | Indicates that the authenticator is use requires a UDDI auth token. Set to false when using HTTP based authenticators | N | _true_
-|===========================================================================================
-=== Startup
+### Startup
+
+Startup properties that can be referenced in the `juddiv3.xml` file
-.Startup properties that can be referenced in the _juddiv3.xml_ file
-[options="header"]
-|===========================================================================================
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/server/baseurl_ |Token that can be accessed in accessPointURLs and resolved at runtime. Currently this is only used during the Installation process (seeding root data) |N |_http://localhost:8080_
|_juddi/root/publisher_ | The username for the jUDDI root publisher. This is usually just set to "root". |N|_root_
|_juddi/seed/always_ | Forces seeding of the jUDDI data. This will re-apply all files with the exception of the root data files. Note that this can lead to losing data that was added to the entities that are re-seeded, since data is not merged.|N |_false_
-
|_juddi/server/name_ | This token is referenced in the install data. Note that you can use any tokens, and that their values can be set here or as system parameters..|N |_false_
|_juddi/server/port_ | This token is referenced in the install data. Note that you can use any tokens, and that their values can be set here or as system parameters..|N |_false_
|_juddi/nodeId_ | The Node ID uniquely identifies this server. Use caution when changing the Node ID after jUDDI has been started, you may not be able to edit any existing entities! ..|N |_uddi:juddi.apache.org:node1_
-
|_juddi//load/install/data_ | This property allows you to cancel loading of the jUDDI install data.|N | false
|_juddi/locale_ | The default local to use. This currently is not used. |N|_en_US_
|_juddi/operatorEmailAddress_ | The UDDI Operator Contact Email Address. This currently is not used. |N|_admin@juddi.org_
-|_juddi/persistenceunit.name_ | The persistence name for the jUDDI database that is specified in the persistence.xml file.|N
-|juddiDatabase
+|_juddi/persistenceunit.name_ | The persistence name for the jUDDI database that is specified in the persistence.xml file.|N |juddiDatabase
|_juddi/configuration/reload/delay_ |The time in milliseconds in which juddiv3.xmlis polled for changes.|N|5000
-|===========================================================================================
+
CAUTION: Take caution in changing the jUDDI Node ID. (Updated at 3.3) jUDDI can now change Node IDs via the Admin console. However care must be taken to prevent changes to data while the rename is in progress. It is recommended to use the Admin console to change the Node ID. It will automatically update the database and the _juddiv3.xml_ configuration file.
-=== Email
+### Email
+
+As of 3.1.5, jUDDI supports Email delivery options for Subscription API functions. Email properties can be referenced in the _juddiv3.xml_ file
-.As of 3.1.5, jUDDI supports Email delivery options for Subscription API functions. Email properties can be referenced in the _juddiv3.xml_ file.
Starting with 3.2.1, jUDDI can now send a test email via the juddiv3.war/admin console.
-[options="header"]
-|===========================================================================================
+
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/mail/smtp/from_ |The Operator's Email address|Y|[_jUDDI@example.org_]
|_juddi/mail/smtp/host_ |The hostname of the SMTP server|Y|[_localhost_]
|_juddi/mail/smtp/port_ |The portname of the SMTP server|Y|[_25_]
@@ -67,55 +61,51 @@ Starting with 3.2.1, jUDDI can now send a test email via the juddiv3.war/admin c
|_juddi/mail/smtp/password_|Username used to authenticate to the SMTP server|Y, if _juddi/mail/smtp/auth_ is true|[_secret_]
|_juddi/mail/smtp/password@encrypted_|If the password is encrypted, the setting juddi/cryptor is the Cryptographic provider used to decrypt at runtime.|Y, if _juddi/mail/smtp/auth_ is true|false
-|===========================================================================================
+### Query Properties
+
+Query properties that can be referenced in the _juddiv3.xml_ file
-=== Query Properties
-.Query properties that can be referenced in the _juddiv3.xml_ file
-[options="header"]
-|===========================================================================================
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/maxBusinessesPerPublisher_ |The maximum number of UDDI Businesses that can be registered per publisher. A value of '-1' indicates any number of businesses is allowed (These values can be overridden at the individual publisher level)| N| -1
-|_juddi/maxServicesPerBusiness_|The maximum number of UDDI BusinessServices allowed per Business. A value of '-1' indicates any number of artifacts is valid (These values can be
-# overridden at the individual publisher level).|N|-1
+|_juddi/maxServicesPerBusiness_|The maximum number of UDDI BusinessServices allowed per Business. A value of '-1' indicates any number of artifacts is valid (These values can be overridden at the individual publisher level).|N|-1
|_juddi/maxBindingsPerService_ | The maximum number of UDDI TemplateBindings allowed per BusinessService. A value of '-1' indicates any number of artifacts is valid (These values can be overridden at the individual publisher level).|N|-1
|_juddi/maxTModelsPerPublisher_|The maximum number of TModels allowed per publisher. A value of '-1' indicates any number of artifacts is valid (These values can be overridden at the individual publisher level).|N|-1
|_juddi/maxInClause_ | The maximum number of "IN" clause parameters. Some RDMBS limit the number of parameters allowed in a SQL "IN" clause. |Y|[_1000_]
|_juddi/maxNameElementsAllowed_| The maximum name size and maximum number of name elements allows in several of the _FindXxxx_ and _SaveXxxx_ UDDI functions |N|[_5_]
|_juddi/maxNameLength_ | The maximum name size of name elements|N|[_255_]
|_juddi/maxRows_ | The maximum number of rows returned in a find* operation. Each call can set this independently, but this property defines a global maximum. This is related to the _maxInClause_ setting (the same?).|N|1000
-|===========================================================================================
-=== RMI Proxy
+### RMI Proxy
-.These properties are used to bring up RMI server socket. The settings allow for registering this service to JNDI.
+These properties are used to bring up RMI server socket. The settings allow for registering this service to JNDI.
RMI Proxy properties that can be referenced in the _juddiv3.xml_ file and is only used by RMITransport.
-[options="header"]
-|===========================================================================================
+
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/proxy/factory/initial_ | JNDI Contect Facory |N|[_org.jnp.interfaces.NamingContextFactory_]
|_juddi/proxy/provider/url_ | JNDI Provider Address |N|[_jnp://localhost:1099_]
|_juddi/proxy/factory/url/pkg_ | JNDI Naming Convention |N|[_org.jboss.naming_]
-|===========================================================================================
-=== Key Generation and Cryptography
-.UDDI Key generation properties that can be referenced in the `juddiv3.xml` file.
-[options="header"]
-|===========================================================================================
+### Key Generation and Cryptography
+
+UDDI Key generation properties that can be referenced in the `juddiv3.xml` file.
+
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/cryptor_ | jUDDI Cryptor implementation class that jUDDI will use to encrypt and decrypt password settings |N|_org.apache.juddi.cryptor.DefaultCryptor_
|_juddi/keygenerator_ | Key generator implementation that jUDDI will use to create UDDI keys if no key is passed in by the user.|N|_org.apache.juddi.keygen.KeyGenerator_
|_juddi/uuidgen_ | UUID generator implementation that jUDDI will use to create UUIDs.|N|_org.apache.juddi.uuidgen.DefaultUUIDGen_
-|===========================================================================================
-=== Subscription
+### Subscription
+
+Subscription properties that can be referenced in the _juddiv3.xml_ file.
-.Subscription properties that can be referenced in the _juddiv3.xml_ file.
-[options="header"]
-|===========================================================================================
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/subscription/expiration/days_|Days before a subscription expires|N|[_30_]
|_juddi/subscription/chunkexpiration/minutes_| Minutes before a "chunked" subscription call expires|N|[_5_]
|_juddi/notification/interval_|Specifies the interval at which the notification timer triggers. This is the upper boundary set by the registry. Between the user defined endDate of a Subscription and this value, the registry will pick the earliest date. (in ms)|N|_3000000_
@@ -124,24 +114,22 @@ RMI Proxy properties that can be referenced in the _juddiv3.xml_ file and is onl
|_juddi/notification/maxTries_|Specifies the number of times to attempt the delivery of messages to subscribers.|N|3
|_juddi/notification/maxTriesResetInterval_|Once the maximum delivery attempts have been made, the server will add that endpoint to an ignore list, which is reset every N ms.|N|600000
|_juddi/notification/sendAuthTokenWithResultList_|Sends a valid authentication token for the owning user of the subscription in the subscription notification result message. Unless it is specifically needed, this is recommended to be set to false.|N|false
-|===========================================================================================
-=== Custody Transfer
+### Custody Transfer
+
+Transfer properties that can be referenced in the _juddiv3.xml_ file.
-.Transfer properties that can be referenced in the _juddiv3.xml_ file.
-[options="header"]
-|===========================================================================================
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/transfer/expiration/days_|Days before a transfer request expires.|N|[_3_]
-|===========================================================================================
-=== Validation
+### Validation
+
+These settings are for validating the data that users store in jUDDI. They can be referenced in the _juddiv3.xml_ file.
-.These settings are for validating the data that users store in jUDDI. They can be referenced in the _juddiv3.xml_ file.
-[options="header"]
-|===========================================================================================
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/validation/enforceReferentialIntegrity_|As of 3.1.5 This setting will force referential integrity for all tModels (except keyGenerators), category bags, bindingTemplate/AccessPoint/hostingRedirector (referencing another host), tModelInstanceParms and anything else that references a KeyName default value is true. Set to false for backwards compatibility or for a more lax registry.|N|[_true_]
|_juddi/validation/rejectInvalidSignatures/enable_ | Enables or Disables the validation of signatures when a publisher attempts to save an entity | N | false
|_juddi/validation/rejectInvalidSignatures/enable/trustStorePath_ | Path to the trust store. Can be overridden via system properties. If not specified, the Windows trust store will be used, else the default JRE trust store will be used. | N | [truststore.jks]
@@ -152,48 +140,47 @@ RMI Proxy properties that can be referenced in the _juddiv3.xml_ file and is onl
|_juddi/validation/rejectInvalidSignatures/checkTimestamps_ | If true, certificates are checked against the time validity | N | false
|_juddi/validation/rejectInvalidSignatures/checkTrust_ | If true, the certificates trust chain is validated against the trust store | N | false
|_juddi/validation/rejectInvalidSignatures/checkRevocationCRL_ | If true, the certificate will attempted to be validated using online certificate revocation protocols | N | false
-|===========================================================================================
-=== Logging
+### Logging
-.These properties are used to enable additional logging capabilities.
+These properties are used to enable additional logging capabilities.
Logging properties that can be referenced in the _juddiv3.xml_ file.
-[options="header"]
-|===========================================================================================
+
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/logging/logInquirySearchPayloads_| Enables request payload logging for the Inquiry Find apis |N| false
-|===========================================================================================
-=== Performance
-.These properties are used to enable or disable certain capabilities based on performance considerations.
+### Performance
+
+These properties are used to enable or disable certain capabilities based on performance considerations.
Perofrmance properties are referenced in the _juddiv3.xm_ file.
-[options="header"]
-|===========================================================================================
+
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/performance/enableFindBusinessTModelBagFiltering_ | UDDI defines a mechansim to filter findBusiness relates based on tModelInstanceInfo within their service's binding templates. This is an expensive operation and will cause significant performance degredation on larger registries. For spec complliance, it should be set to true. We suspect it's not a commonly used feature and recommend setting this to false. |N| true
-|===========================================================================================
-=== Replication
-.These properties are used to tweak the replication service capabilities.
+### Replication
+
+These properties are used to tweak the replication service capabilities.
These properties are referenced in the _juddiv3.xml_ file.
-[options="header"]
-|===========================================================================================
+
+
|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
|_juddi/replication/getChangeRecordsMax_ | The maximum number of records to return from a getChangeRecord request |N| 100
|_juddi/replication/start/buffer_ | Specifies the amount of time to wait before the replication timer initially fires. (in ms) | N | 5000
|_juddi/replication/interval_ | Specifies the interval at which the replication timer triggers (in ms). | N | 5000
-|===========================================================================================
-=== Deploying two or more jUDDI server on the same application server
+### Deploying two or more jUDDI server on the same application server
-.It is possible to deploy one or more jUDDI servers to the same application server. You will need copy the juddiv3.war archive (let's say you copied it to juddiv3a.war), and change the following settings to have it connect to a different database:
+It is possible to deploy one or more jUDDI servers to the same application server. You will need copy the juddiv3.war archive (let's say you copied it to juddiv3a.war), and change the following settings to have it connect to a different database:
1. edit the `juddiv3a/META-INF/context.xml` (and `conf/Catalina/localhost/juddiv3a.xml`) to use the _jdbc/JuddiADS_ datasource, and add 'a' to the url: `url="jdbc:derby:target/juddi-derby-test-db-v3a;create=true"`
2. edit the _juddiv3a/WEB-INF/classes/META-INF/persistence.xml_ to use `<non-jta-data-source>java:comp/env/jdbc/JuddiADS` and `persistence-unit name="juddiADatabase"`
@@ -203,53 +190,45 @@ These properties are referenced in the _juddiv3.xml_ file.
This will create a new jUDDI server under the http://localhost:8080/juddiv3a url which connects to the juddi-derby-test-db-v3a Derby database.
-=== jUDDI GUI Configuration
+### jUDDI GUI Configuration
The jUDDI GUI (juddi-gui.war) has one place for configuration settings, the jUDDI Client config file.
-=== jUDDI Client uddi.xml Settings
+### jUDDI Client uddi.xml Settings
Defined in WEB-INF/classes/META-INF/uddi.xml, there are many settings to configure. All of these are clearly defined by the jUDDI Client Configuration Guide. The juddi-gui, uses things a bit differently, so here are the relevant parts to use. Note: this is xpath notation.
* uddi/client/nodes/properties, not used
-
* uddi/client/clerks, not used
-
* uddi/client/nodes/node, all URLs except juddiApiUrl (not used)
-
* uddi/client/signature, all validation related settings
-
* uddi/client/subscriptionCallbacks, not used
-
* uddi/client/XtoWsdl, not used
In addition, there a special section added just for the juddi-gui.war
-.jUDDI GUI Configuration
-[options="header"]
-|===========================================================================================
-|Property Name |Description |Required |Default Value or [Example Value]
-|_uddi/config/props/authtype_ |This controls the authentication mode to connect to a UDDI server. Most implementations of UDDI use the security service, however others use HTTP based authentication. In this case, us the value of 'HTTP', otherwise 'UDDI_AUTH' |Y |_UDDI_AUTH_
-
-|_uddi/config/props/enableAutomaticLogouts_ |This flag determines whether automatic logouts is enabled. By default, jUDDI-gui sets this to false for ease of use. (true/false)|N |_false_
+jUDDI GUI Configuration
-|_udddi/config/props/enableAutomaticLogouts/duration_ |Time in milliseconds to force an automatic logout after inactivity.|N |_900000_
+|Property Name |Description |Required |Default Value or [Example Value]
+| --- | --- | --- | --- |
+|_uddi/config/props/authtype_ |This controls the authentication mode to connect to a UDDI server. Most implementations of UDDI use the security service, however others use HTTP based authentication. In this case, us the value of 'HTTP', otherwise 'UDDI_AUTH' |Y | _UDDI_AUTH_
+|_uddi/config/props/enableAutomaticLogouts_ | This flag determines whether automatic logouts is enabled. By default, jUDDI-gui sets this to false for ease of use. (true/false)|N |_false_
+|_udddi/config/props/enableAutomaticLogouts/duration_ | Time in milliseconds to force an automatic logout after inactivity.|N | _900000_
|_uddi/config/props/configLocalHostOnly_ |If false, the configuration page will be available from anywhere. If true, it will only be accessible from the server hosting juddi-gui. (true/false) |N |_true_
-|===========================================================================================
+### Encryption Keys
-=== Encryption Keys
+By default, the juddi-gui will use a randomly generated AES encryption key to help protect user credentials stored in the session object. This key is generated using the "StartupServlet" defined in the web.xml file of juddi-gui.war/WEB-INF/web.xml and then it is stored at the path `juddi-gui.war/META-INF/config.properties@key`.
-By default, the juddi-gui will use a randomly generated AES encryption key to help protect user credentials stored in the session object. This key is generated using the "StartupServlet" defined in the web.xml file of juddi-gui.war/WEB-INF/web.xml and then it is stored at the path juddi-gui.war/META-INF/config.properties@key.
+If the start up servlet fails to start, any authenticatation operation of the juddi-gui will fail.
-If the start up servlet fails to start, any authenticate operation of the juddi-gui will fail.
+IMPORTANT: The user account that the container for juddi-gui runs as must have write access to the file `juddi-gui.war/META-INF/config.properties`.
-IMPORTANT: The user account that the container for juddi-gui runs as must have write access to the file juddi-gui.war/META-INF/config.properties.
-
-=== Customizing the juddi-gui
+### Customizing the juddi-gui
The juddi-gui has a mechanism that you can use to alter the appearance of every page. This is typically used for organizations that require legal notifications, banners or warnings on every page for one reason or another. To add your own html to every page, edit the file in
-----
+
+````
juddi-gui/user/banner.jsp
-----
+````
diff --git a/docs/asciidoc/Guide/en-US/GuideContributingtojUDDI.asciidoc b/src/site/markdown/GuideContributingtojUDDI.md
similarity index 70%
rename from docs/asciidoc/Guide/en-US/GuideContributingtojUDDI.asciidoc
rename to src/site/markdown/GuideContributingtojUDDI.md
index dc57d09ab..29a8741e2 100644
--- a/docs/asciidoc/Guide/en-US/GuideContributingtojUDDI.asciidoc
+++ b/src/site/markdown/GuideContributingtojUDDI.md
@@ -1,35 +1,36 @@
-== Contributing to jUDDI
+## Contributing to jUDDI
We welcome contributions to jUDDI. Visit the jUDDI web set at http://juddi.apache.org for more information.
-=== License guidance
+### License guidance
Apache jUDDI is released under the Apache Software Foundation v2.0 License. Details on the license is located at the following link: http://apache.org/licenses/LICENSE-2.0.
If you wish to bring in 3rd libraries, please keep in mind that certain libraries cannot be used due to license restrictions. See http://www.apache.org/legal/3party.html for details.
-=== SVN access
+### SVN access
Source code is accessible at the following link: https://svn.apache.org/viewvc/juddi/trunk/.
-=== Project structure
+### Project structure
jUDDI, from a developer's perspective, is divided into a number of smaller, more manageable modules. In general, each module contains all of the necessary unit tests in order to ensure functionality.
-=== Building and testing jUDDI
+### Building and testing jUDDI
jUDDI has a number of components, however it is mostly Java based. The following sections describe the particulars for each language.
-==== All Java Components
+#### All Java Components
+
Procedure
-. Acquire a Subversion client.
-. Execute svn co https://svn.apache.org/viewvc/juddi/trunk/
-. Acquire a JDK5 or higher and setup the JAVA_HOME environment variable.
-. Acquire Apache Maven. Known working version: 3.0.4
-. Setup an environment variable, MAVEN_OPTS=-Xmx768m -XX:MaxPermSize=512m
-. Make sure the Maven/bin folder and the JDK/bin folders are in the current path
-. Execute "mvn clean install"
+1. Acquire a Subversion client.
+2. Execute svn co https://svn.apache.org/viewvc/juddi/trunk/
+3. Acquire a JDK5 or higher and setup the JAVA_HOME environment variable.
+4. Acquire Apache Maven. Known working version: 3.0.4
+5. Setup an environment variable, MAVEN_OPTS=-Xmx768m -XX:MaxPermSize=512m
+6. Make sure the Maven/bin folder and the JDK/bin folders are in the current path
+7. Execute "mvn clean install"
This will build, test and package all of the Java components of jUDDI. This includes the Technical Conformance Kit (TCK), a live Tomcat server, the user interfaces, and more.
@@ -37,23 +38,23 @@ For additional build output, add -Ddebug-true for Java.
To prepare a deployable jUDDI war for an alternate deployment scenario (other than Tomcat with CXF and OpenJPA), use the following procedure:
-. Execute "mvn clean package -P<packageName>"
+Execute `mvn clean package -P<packageName>`
-Where <packageName> is one of the following
+Where `<packageName>`is one of the following
-. openjpa-jboss7up for EAP 6 and up, GA 7 and up
-. hibernate-jbossws-native for EAP 5, Jboss GA 6 and down with the JbossWS Native soap stack
-. hibernate-jbossws-cxf for EAP 5, Jboss GA 6 and down with the JbossWS Native soap stack
-. hibernate (includes CXF in the war, used for Tomcat)
-. openjpa (includes CXF in the war, used for Tomcat)
-. axis2 (includes Axis2 in the war)
+- openjpa-jboss7up for EAP 6 and up, GA 7 and up
+- hibernate-jbossws-native for EAP 5, Jboss GA 6 and down with the JbossWS Native soap stack
+- hibernate-jbossws-cxf for EAP 5, Jboss GA 6 and down with the JbossWS Native soap stack
+- hibernate (includes CXF in the war, used for Tomcat)
+- openjpa (includes CXF in the war, used for Tomcat)
+- axis2 (includes Axis2 in the war)
TIP: When altering the TCK based modules, make sure you clean install in the root check out location. Due to the build order, you may end up with strange results when just executing the tests, even with clean install.
TIP: To attach the debugger to the build process try "mvn -Dmaven.surefire.debug clean install". It listens on port 5005 by default. More info on debugging maven projects is here http://maven.apache.org/surefire/maven-surefire-plugin/examples/debugging.html
-==== .NET
+#### .NET
jUDDI also has a .NET based jUDDI Client. To build this, only the .NET Framework needs to be installed, version 3.5 or higher. A Visual Studio solution file is included, but it is not required for building.
@@ -61,14 +62,15 @@ Procedure - Windows
* Add MSBuild.exe to your system path. It's usually in %SYSTEMROOT%\Microsoft.NET\Framework(64)\v4.x.x. If you haven't installed .NET 4 yet, replace v4.x.x with v2.x.x
* Build the solution. This will build the juddi-client.net.dll, the same application(s) and the test project(s).
-----
+````
MSBuild.exe juddi-client.net.sln /p:Configuration=Debug /p:Platform="Any CPU"
-----
+````
For additional debug output set the environment variable 'debug=true'
-----
+
+````
set debug=true
-----
+````
Procedure - *nix using Mono
@@ -77,47 +79,52 @@ TIP: Support on Mono is very experimental. There are still many APIs that have n
To build the .NET assemblies on a Linux or Unix based computer:
* Install Mono (apt-get install mono-complete mono-develop
* Build it
-----
+
+````
cd juddi-client.net
xbuild judddi-client.net-mono.sln
cd juddi-client.net-sample/bin/Debug/
mono juddi-client.net-sample.exe
-----
+````
-=== Other ways to Contribute to jUDDI
+### Other ways to Contribute to jUDDI
There are many ways you can contribute to jUDDI. We welcome all kinds and types contributions.
-==== Bug Reports
+#### Bug Reports
Bug reports and feature requests are low effort tasks that do not require a high level of technical proficiency.
-==== Internationalization
+#### Internationalization
The jUDDI GUI user interface is designed to be multi-lingual. For the 3.2 release, English and Spanish are provided for the user interface. The jUDDI server administration user interface is also available in English and Spanish.
-==== Contributing Source code
+#### Contributing Source code
When contributing source code, you must own the code and be will to donate the code to the Apache Software Foundation. For those without SVN access, the process is as follows:
-. Open a JIRA on the jUDDI Issue Tracker
-. Write your code and test it (mvn clean install)
-. Use Subversion to create a patch (svn patch)
-. Upload the patch as an attachment for the JIRA
+
+1. Open a JIRA on the jUDDI Issue Tracker
+2. Write your code and test it (mvn clean install)
+3. Use Subversion to create a patch (svn patch)
+4. Upload the patch as an attachment for the JIRA
Once accepted, your code will be added to the baseline. Code submissions may be modified for style, content, documentation and any other reason that we see fit.
-===== Coding Standards
+##### Coding Standards
The majority of jUDDI's source code is formatted using 8 space tabs and using Javadoc style documentation. In general, test cases are often more useful and more valuable that the code being tested.
-==== Releases
+#### Releases
For the latest information on jUDDI's release process, visit http://juddi.apache.org/committers.html
-=== What the?
+### What the?
Having ran into a number of strange issues when developing with jUDDI, we decided to write a few of them down.
-. I added a new class to juddi-core but it doesn't end up in the packaged tomcat instance? A: Modify the pom and make sure the package name is added to juddi-core-openjpa
+Q:I added a new class to juddi-core but it doesn't end up in the packaged tomcat instance?
+
+A: Modify the pom and make sure the package name is added to juddi-core-openjpa
-. Some unit tests fail, but only under windows. A: This is specifically for the SubscriptionListerner Tests and most likely has something to do with ports getting locked up by the Java process.
\ No newline at end of file
+Q: Some unit tests fail, but only under windows.
+A: This is specifically for the SubscriptionListerner Tests and most likely has something to do with ports getting locked up by the Java process.
\ No newline at end of file
diff --git a/docs/asciidoc/Guide/en-US/GuideExtendingUDDI.asciidoc b/src/site/markdown/GuideExtendingUDDI.md
similarity index 52%
rename from docs/asciidoc/Guide/en-US/GuideExtendingUDDI.asciidoc
rename to src/site/markdown/GuideExtendingUDDI.md
index b787fc545..dc14db3f9 100644
--- a/docs/asciidoc/Guide/en-US/GuideExtendingUDDI.asciidoc
+++ b/src/site/markdown/GuideExtendingUDDI.md
@@ -1,43 +1,44 @@
-== Extending UDDI
+## Extending UDDI
jUDDI has extensively uses the Interface/Factory pattern to enable configuration runtime options and to provide you, the developer easy insertion points to customize the behavior of jUDDI. The remaining sections of this chapter outline the different technology insertion points.
-=== Authentication modules
+### Authentication modules
Authentication modules are used when the UDDI's AuthToken is utilized on the Security web service. It's function is to point to some kind of user credential store to validate users. See the User Guide for details on what's available out of the box.
-All of the provided classes implement the interface .org.apache.juddi.v3.auth.Authenticator.. So, if you wanted something a bit more functional than what's provided out of the box. you'll need to implement your own Authenticator. To wire it in, edit the juddiv3.xml file, specifying your class name as the value to the property "juddi/auth/authenticator/class" and then add the class or jar containing your implementation to juddiv3.war/WEB-INF/classes or judiv3.war/WEB-INF/lib respectively.
+All of the provided classes implement the interface .org.apache.juddi.v3.auth.Authenticator. So, if you wanted something a bit more functional than what's provided out of the box. you'll need to implement your own Authenticator. To wire it in, edit the `juddiv3.xml` file, specifying your class name as the value to the property `juddi/auth/authenticator/class` and then add the class or jar containing your implementation to `juddiv3.war/WEB-INF/classes` or `judiv3.war/WEB-INF/lib` respectively.
-=== Subscription Notification Handlers
+### Subscription Notification Handlers
Subscription Notification Handlers are used to asynchronously notify users that something has changed in UDDI. In order to do this, a UDDI Subscription is created that references a specific Binding Template key which represents the service that will be called whens something changes. jUDDI comes with support for Email delivery and the UDDI Subscription Listener Web Service (HTTP) delivery. In addition, jUDDI comes with an example for publishing to an Apache Qpid AMQP pub/sub server, whic [...]
-. Make a new Java library projects in your IDE of choice. Reference the juddi-core, and uddi-ws projects or JAR files or the Maven dependency equivalent
-. Create a class of your own within the following package name: org.apache.juddi.subscription.notify
-. The class name MUST follow this pattern: PROTOCOLNotifier Where PROTOCOL is the prefix of whatever URL you want users to be able to use. Here's an example using Apache Qpid. Example URL: amqp://guest:guest@client1/development?brokerlist='tcp://localhost:5672' Class Name: AMQPNotifier. The Notification class basically takes the protocol of the Access Point's value, splits it on the character ":" and then grabs the first token "amqp" and converts to upper case. Using this pattern you sho [...]
-. Our new shinny class, AMQPNotifier, must implement the interface org.apache.juddi.subscription.notify.Notifier. From there, all you need to do is to add in the jars necessary for your transport mechanism and wire in your own code.
-. Deployment is simple. Add your PROTOCOLNotifier jar and its dependencies to the juddiv3.war/WEB-INF/lib folder.
+1. Make a new Java library projects in your IDE of choice. Reference the juddi-core, and uddi-ws projects or JAR files or the Maven dependency equivalent
+2. Create a class of your own within the following package name: `org.apache.juddi.subscription.notify`
+3. The class name MUST follow this pattern: PROTOCOLNotifier Where PROTOCOL is the prefix of whatever URL you want users to be able to use. Here's an example using Apache Qpid. Example URL: amqp://guest:guest@client1/development?brokerlist='tcp://localhost:5672' Class Name: AMQPNotifier. The Notification class basically takes the protocol of the Access Point's value, splits it on the character ":" and then grabs the first token "amqp" and converts to upper case. Using this pattern you sh [...]
+4. Our new shinny class, AMQPNotifier, must implement the interface org.apache.juddi.subscription.notify.Notifier. From there, all you need to do is to add in the jars necessary for your transport mechanism and wire in your own code.
+5. Deployment is simple. Add your PROTOCOLNotifier jar and its dependencies to the juddiv3.war/WEB-INF/lib folder.
Note: be careful and watch for conflicting jar file versions. In general, usually moving up a version is ok, but moving down may cause the services to fail unexpectedly.
To test, create a Service with the BindingTemplate's Access Point's value equal to whatever you need.
Next, setup a subscription and reference the BindingTemplate key that represents your call back handler's end point. Finally, change an item that is covered by the subscription's filter and monitor the log files. Hopefully, you won't see an unexpected errors.
-=== KeyedReference Value Set Validation Services
+### KeyedReference Value Set Validation Services
Since jUDDI 3.2.1, we now have support for the Value Set Validation Service. This allows you to define a validator that will check when a user saves a UDDI entity that references a given tModel that contains a keyed reference to uddi:uddi.org:identifier:validatedby (which points to the VSV service).
To defined your own validator, use the following steps
-# Create you tModel with a named key
-# Implement the org.apache.juddi.validation.vsv.ValueSetValidator interface
-# Name your implementation class using the naming schema defined in the ConvertKeyToClass function of UDDIValueSetValidationImpl (first letter is upper, all else is lower. Numbers and letters only. Class must be in the package org.apache.juddi.validation.vsv
-# Update your saved tModel and add a keyed reference for uddi:uddi.org:identifier:validatedby using the value of uddi:juddi.apache.org:servicebindings-valueset-cp
-# Get your class in the class path of jUDDI and give it a shot
-=== Cryptographic Providers
+1. Create you tModel with a named key
+2. Implement the org.apache.juddi.validation.vsv.ValueSetValidator interface
+3. Name your implementation class using the naming schema defined in the ConvertKeyToClass function of UDDIValueSetValidationImpl (first letter is upper, all else is lower. Numbers and letters only. Class must be in the package org.apache.juddi.validation.vsv
+4. Update your saved tModel and add a keyed reference for uddi:uddi.org:identifier:validatedby using the value of `uddi:juddi.apache.org:servicebindings-valueset-cp`
+5. Get your class in the class path of jUDDI and give it a shot
+
+### Cryptographic Providers
jUDDI provides cryptographic functions via (Java) juddi-client.jar/org.apache.juddi.v3.client.cryptor and implement the Cryptor interface which provides two simple functions, encrypt and decrypt. (Note: .NET has similar functionality).
-=== jUDDI Client Transport
+### jUDDI Client Transport
The juddi-client's Transport class is an abstract class that you can you alter the transport mechanism used by jUDDI's client APIs. Included is what would be used in most cases, such as JAXWS, RMI, and InVM (Embedded mode). This can be extended to use whatever you may need.
diff --git a/docs/asciidoc/Guide/en-US/GuideGettingStarted.asciidoc b/src/site/markdown/GuideGettingStarted.md
similarity index 68%
rename from docs/asciidoc/Guide/en-US/GuideGettingStarted.asciidoc
rename to src/site/markdown/GuideGettingStarted.md
index f9bebd9d1..da3280277 100644
--- a/docs/asciidoc/Guide/en-US/GuideGettingStarted.asciidoc
+++ b/src/site/markdown/GuideGettingStarted.md
@@ -1,13 +1,12 @@
-[[chapter-GettingStarted]]
-== Getting Started
+## Getting Started
The jUDDI project is an open source implementation of the UDDI specification. The registry implementation is a WebArchive (war) _juddiv3.war_ which is deployable to any JEE container. The application exposes a WebService API which can be accessed using any generic SOAP client, the _juddi-gui_ or, if you are looking to integrate the UDDI api in your application, the Java or .NET version of the _juddi-client_.
-=== Prerequisites
+### Prerequisites
jUDDI is written in Java and minimally requires
-* JDK1.6+, although jUDDI should run on JDK1.6, please use the latest JDK if possible
+* JDK1.6+, although jUDDI can run on JDK1.6, please use the latest JDK if possible
optionally
@@ -16,100 +15,82 @@ optionally
The versions mentioned above are minimal versions and it is recommended to use the latest version available. By default jUDDI ships and uses a _Derby_ database. After evaluation you probably want to move to a more full featured database.
-=== What should I Download?
+### What should I Download?
At the jUDDI download page http://juddi.apache.org/releases.html, you have the chioce of two distributions; the _juddi-client_ distro or the juddi-distro, where the latter includes both client and server. Each distribution contains signed binaries, source, examples and documentation. It you are not sure which distribution to download, then take the _juddi-distro_ since it contains everything which is by far the easiest way to get going.
-=== Running jUDDI
+### Running jUDDI
-After downloading and unpacking of the _juddi-distro_, you can start the preconfigured tomcat server by going into the _juddi-distro-<version>_ directory and running startup
+After downloading and unpacking of the _juddi-distro_, you can start the preconfigured tomcat server by going into the `juddi-distro-<version>` directory and running startup
-----
+````
$ cd apache-tomcat-<version>/bin
$ ./startup.sh
-----
+````
Once the server is up and running can make sure the root data was properly installed by browsing to http://localhost:8080/juddiv3
-You should see the screen show in <<figure-GettingStarted-Welcome>>, the jUDDI Welcome Page.
+You should see the screen show in the jUDDI Welcome Page below.
-[[figure-GettingStarted-Welcome]]
-.jUDDI welcome page
-image::images/GettingStarted-jUDDI_welcome.png[Welcome to jUDDI]
+
-Before continuing please check the jUDDI instalation Status on this page and make sure it says: "jUDDI has been successfully installed!". If the page won't load or the status is anything else please check the _apache-tomcat-x.x.x/logs/juddi.log_ and if you need help you can contact us via the jUDDI user mailing list. Also note that it created a _root_ partition, using seed data. You can modify or add to the seed, for that see <<GuideRootSeedData#chapter-UDDISeedData>>.
+Before continuing please check the jUDDI instalation Status on this page and make sure it says: "jUDDI has been successfully installed!". If the page won't load or the status is anything else please check the `apache-tomcat-x.x.x/logs/juddi.log`nd if you need help you can contact us via the jUDDI user mailing list. Also note that it created a `root` partition, using seed data. You can modify or add to the seed, for that see <<GuideRootSeedData#chapter-UDDISeedData>>.
-=== Using the jUDDI Administrative Interface
+### Using the jUDDI Administrative Interface
The juddi admin console runs at http://localhost:8080/juddiv3/admin and requires a login with the role of uddiadmin via the basic authentication popup dialog box. Check the _apache-tomcat-x.x.x/conf/tomcat-users.conf_ file for the password of the _uddiadmin_ user. Please change the password before going live.
-[[figure--GettingStarted-Admin]]
-.jUDDI admin
-image::images/GettingStarted-jUDDI_admin.png[jUDDI Admin]
+
-By popular demand we brought back the happy jUDDI!' page. Just click on _Status and Statistics_ page. By default we run on CXF, so it is normal if says the AxisServlet is not found. There should be no other red on this page.
+By popular demand we brought back the happy jUDDI!' page. Just click on `Status and Statistics` page. By default we run on CXF, so it is normal if says the AxisServlet is not found. There should be no other red on this page.
-[[figure-GettingStarted-HappyjUDDI]]
-.Happy jUDDI.
-image::images/GettingStarted-happy_juddi.png[Happy jUDDI!]
+
By default jUDDI ships with 2 publishers: _root_ and _uddi_. Root is the owner of the repository, while the _uddi_ user is the owner of all the default tmodels and categorizations. Please use the _root_ user to log into the form login in the admin console.
-IMPORTANT: Please use the _root_ user to log into the form login in the admin console.
+IMPORTANT: Please use the `root` user to log into the form login in the admin console.
-[[figure-GettingStarted-FormLogin]]
-.Form login
-image::images/GettingStarted-form_login.png[Form Login]
+
You will now be able to do more then simple browsing. Navigate to the Administration and select _save_publisher_ from the dropdown. This will allow you to add your own publisher.
-[[figure-GettingStarted-AddPublisher]]
-.Add Publisher
-image::images/GettingStarted-add_publisher.png[Add Publisher]
+
-=== Using jUDDI Web Services
+### Using jUDDI Web Services
OK now that we have verified that jUDDI is good to go we can inspect the UDDI WebService API by browsing to http://localhost:8080/juddiv3/services
You should see an overview of all the SOAP Services and their WSDLs.
-[[figure-GettingStarted-jUDDIServices]]
-.jUDDI Services
-image::images/GettingStarted-juddi_services.png[jUDDI Services]
+
The services page shows you the available endpoints and methods available. Using any SOAP client, you should be able to import the wsdls into a tool like SoapUI as shown in <<figure-GettingStarted-SoapUI>> and send some sample requests to jUDDI to test:
-[[figure-GettingStarted-SoapUI]]
-.Getting an authToken using SoapUI
-image::images/GettingStarted-authToken_SoapUI.png[Getting an authToken using SoapUI]
+
TIP: Try obtaining an authToken for the publisher you created earlier.
-=== Using jUDDI GUI to create your keygenerator and business
+### Using jUDDI GUI to create your keygenerator and business
-Navigate to http://localhost:8080/juddi-gui/ to get to the jUDDI-GUI. Please use the Form Login and use the credentials of the publisher you created above. You can browse around, but really the first thing that needs to be done is to create a Key Generator or Partition at http://localhost:8080/juddi-gui/tmodelPartitions.jsp. A Key Generator is needed to save human readable, universally unique UDDIv3 keys. Please read more about UDDI v3 formatted keys, but the short story is that UDDI v3 [...]
-
-[[figure-GettingStarted-CreateKeygenerator]]
-.Create Key Generator
-image::images/GettingStarted-create_keygenerator.png[Create Key Generator]
+Navigate to http://localhost:8080/juddi-gui/ to get to the jUDDI-GUI. Please use the Form Login and use the credentials of the publisher you created above. You can browse around, but really the first thing that needs to be done is to create a Key Generator or Partition at http://localhost:8080/juddi-gui/tmodelPartitions.jsp. A Key Generator is needed to save human readable, universally unique UDDIv3 keys. Please read more about UDDI v3 formatted keys, but the short story is that UDDI v3 [...]
+
+
Next create your business using the key generator format you just registered. For example in <<figure-GettingStarted-CreateBusiness>> we use a businessKey of _uddi:www.mycompany.com:mybusiness_.
-[[figure-GettingStarted-CreateBusiness]]
-.Create Business
-image::images/GettingStarted-create_business.png[Create Business]
+
-See the Client and GUI Guide <<Guide#stam-oree>> for more details on how to use the GUI.
+See the Client and GUI Guide for more details on how to use the GUI.
-=== Running the demos in the disto
+### Running the demos in the disto
-The jUDDI distribution ships with a lot of demos to get yourself more familiarized with the features of jUDDI. You are encouraged to go over the demos and follow the instructions in the README files. To ensure the demos work they use the root publisher. In practice you should not be using the root publisher for this, but rather your own publisher you created above. To reference your own publisher simply update the uddi.xml file in each demo. For more details on running the demos see the [...]
+The jUDDI distribution ships with a lot of demos to get yourself more familiarized with the features of jUDDI. You are encouraged to go over the demos and follow the instructions in the README files. To ensure the demos work they use the root publisher. In practice you should not be using the root publisher for this, but rather your own publisher you created above. To reference your own publisher simply update the uddi.xml file in each demo. For more details on running the demos see the [...]
-=== Examples on the jUDDI blog
+### Examples on the jUDDI blog
The jUDDI blog at http://apachejuddi.blogspot.com/ has examples as well as screencasts. This can be a useful resource to learn about some new feature or to simply get started.
-=== What is new in jUDDI 3.2?
+### What is new in jUDDI 3.2?
Here's the change log for version 3.2
diff --git a/docs/asciidoc/Guide/en-US/GuideHowToDeployjUDDITo.asciidoc b/src/site/markdown/GuideHowToDeployjUDDITo.md
similarity index 87%
rename from docs/asciidoc/Guide/en-US/GuideHowToDeployjUDDITo.asciidoc
rename to src/site/markdown/GuideHowToDeployjUDDITo.md
index 1483df2d2..42db2d04b 100644
--- a/docs/asciidoc/Guide/en-US/GuideHowToDeployjUDDITo.asciidoc
+++ b/src/site/markdown/GuideHowToDeployjUDDITo.md
@@ -1,99 +1,106 @@
-[[chapter-HowToDeployjUDDITo]]
-== How to deploy jUDDI To?
+## How to deploy jUDDI To?
-The jUDDI distribution ships preconfigured on Tomcat - it runs out of the box. All you have to do in go into the `juddi-distro-<version>/juddi-tomcat-<version>/bin` directory and start up Tomcat. All of this just as described in <<chapter-GettingStarted>>.
+The jUDDI distribution ships preconfigured on Tomcat - it runs out of the box. All you have to do in go into the `juddi-distro-<version>/juddi-tomcat-<version>/bin` directory and start up Tomcat. All of this just as described in `<chapter-GettingStarted>`.
By default the `juddiv3.war` is configured to use OpenJPA and CXF. If you want to change your JPA or WS provider, or you'd like to run on a different container then this chapter may come in handy, as there a number of scripted 'profiles' to change the configuration and dependencies in the `juddiv3.war`. To run these maven based scripts you need to go into `juddi-distro-<version>/juddiv3-war` directory.
-=== Tomcat
+### Tomcat
+
+#### OpenJPA and CXF
-==== OpenJPA and CXF
Target platform Tomcat and Derby using OpenJPA and CXF. Both OpenJPA and CXF are packaged up in the juddiv3.war.
-----
+
+````
mvn clean package -P openjpa
-----
+````
+
Then copy the `target/juddiv3.war` to the `<tomcat>/webapps` directory.
-==== Hibernate and CXF
+#### Hibernate and CXF
+
Target platform Tomcat and Derby using Hibernate and CXF. Both Hibernate and CXF are packaged up in the juddiv3.war.
-----
+
+````
mvn clean package -P hibernate
-----
+````
+
Then copy the `target/juddiv3.war` to the `<tomcat>/webapps` directory.
-==== OpenJPA and Axis2
+#### OpenJPA and Axis2
Target platform Tomcat and Derby using OpenJPA and Apache Axis2. Both Hibernate and Axis2 are packaged up in the juddiv3.war.
-----
+
+````
mvn clean package -P axis2
-----
+````
+
Then copy the `target/juddiv3.war` to the `<tomcat>/webapps` directory.
-=== JBoss
+### JBoss
-==== JBossAS 6.0.0.GA
+#### JBossAS 6.0.0.GA
This section describes how to deploy juddi to JBoss 6.0.0.GA.
First, download jboss-6.0.0.GA - the zip or tar.gz bundle may be found at http://www.jboss.org/jbossas/downloads/. Download the bundle and uncompress it.
-===== Hibernate and JBossWS-Native
+##### Hibernate and JBossWS-Native
Target platform JBoss-6.x and HSQL using Hibernate and JBossWS-native. The juddiv3.war relies on Hibernate and JBossWS-native in the appserver.
-----
+````
mvn clean package -P hibernate-jbossws-native
-----
+````
Then copy the `target/juddiv3.war` to the `<jboss>/server/default/deploy` directory.
-===== Hibernate and JBossWS-CXF
+##### Hibernate and JBossWS-CXF
Target platform JBoss-6.x and HSQL using Hibernate and JBossWS-cxf. The juddiv3.war relies on Hibernate and JBossWS-cxf in the appserver.
-----
+
+````
mvn clean package -P hibernate-jbossws-cxf
-----
+````
[knownissues]
.KNOWN ISSUES
Issue 1::
+
-----
+````
15:14:37,275 SEVERE [RegistryServlet] jUDDI registry could not be started. org.apache.commons.configuration.ConfigurationException: java.util.zip.ZipException: error in opening zip file: org.apache.commons.configuration.ConfigurationException: org.apache.commons.configuration.ConfigurationException: java.util.zip.ZipException: error in opening zip file
-----
+````
+
Workaround: deploy juddiv3.war as a directory (not a zip file).
Issue 2::
+
JBoss-5.x Note that configuration 3 and 4 will also run on JBoss-5.x, but you may run into the following
+
-----
+````
ERROR [org.jboss.ws.metadata.wsdl.xmlschema.JBossXSErrorHandler] (main) [domain:http://www.w3.org/TR/xml-schema-1]::[key=src-resolve]::Message=src-resolve: Cannot resolve the name ns1:Signature to a element declaration component.
-----
+````
+
Workaround: Unzip the deployers/jbossws.deployer/jbossws-native-core.jar and add the xmldsig-core-schema.xsd in the schema directory,
+
-----
+````
10293 Fri May 27 14:40:40 EDT 2011 schema/xmldsig-core-schema.xsd
-----
+````
+
Edit the file META-INF/jbossws-entities.properties by adding a line at the bottom saying:
+
-----
+````
http\://www.w3.org/2000/09/xmldsig#=schema/xmldsig-core-schema.xsd
-----
+````
Copy juddiv3.war to server/default/deploy and unpack it.
Insert jboss-web.xml into the juddiv3.war/WEB-INF directory , should look like the following :
-----
+
+````
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE jboss-web PUBLIC
"-//JBoss//DTD Web Application 2.3V2//EN"
"http://www.jboss.org/j2ee/dtd/jboss-web_3_2.dtd">
-
-<jboss-web>
-
+ <jboss-web>
<resource-ref>
<res-ref-name>jdbc/JuddiDS</res-ref-name>
<jndi-name>java:JuddiDS</jndi-name>
@@ -101,17 +108,22 @@ Insert jboss-web.xml into the juddiv3.war/WEB-INF directory , should look like t
<depends>jboss.jdbc:datasource=JuddiDS,service=metadata</depends>
</jboss-web>
-----
-===== Change web.xml
+````
+##### Change web.xml
+
Replace the WEB-INF/web.xml with the jbossws-native-web.xml within docs/examples/appserver.
-===== Configure Datasource
-The first step for configuring a datasource is to copy your JDBC driver into the classpath. Copy your JDBC driver into ${jboss.home.dir}/server/${configuration}/lib, where configuration is the profile you wish to start with (default, all, etc.). Example :
-----
+##### Configure Datasource
+
+The first step for configuring a datasource is to copy your JDBC driver into the classpath. Copy your JDBC driver into `${jboss.home.dir}/server/${configuration}/lib`, where configuration is the profile you wish to start with (default, all, etc.). Example :
+
+````
cp mysql-connector-java-5.0.8-bin.jar /opt/jboss-5.1.0.GA/server/default/lib
-----
+````
+
Next, configure a JBoss datasource file for your db. Listed below is an example datasource for MySQL :
-----
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<datasources>
<local-tx-datasource>
@@ -128,35 +140,36 @@ Next, configure a JBoss datasource file for your db. Listed below is an example
</metadata>
</local-tx-datasource>
</datasources>
-----
-Next, make a few changes to the juddiv3.war/classes/META-INF/persistence.xml. Change the "hibernate.dialect" property to match the database you have chosen for persistence. For MySQL, change the value of hibernate.dialect to "org.hibernate.dialect.MySQLDialect". A full list of dialects available can be found in the hibernate documentation (https://www.hibernate.org/hib_docs/v3/api/org/hibernate/dialect/package-summary.html). Next, change the <jta-data-source> tags so that it reads <non-j [...]
+````
+
+Next, make a few changes to the juddiv3.war/classes/META-INF/persistence.xml. Change the "hibernate.dialect" property to match the database you have chosen for persistence. For MySQL, change the value of hibernate.dialect to "org.hibernate.dialect.MySQLDialect". A full list of dialects available can be found in the hibernate documentation (https://www.hibernate.org/hib_docs/v3/api/org/hibernate/dialect/package-summary.html). Next, change the `<jta-data-source>` tags so that it reads `<no [...]
-==== JBossAS 7.x/JBossEAP-6.x
+#### JBossAS 7.x/JBossEAP-6.x
This section describes how to deploy juddi to JBossAS 7, WildFly and JBossEAP 6
-===== Hibernate and JBossWS-CXF
+##### Hibernate and JBossWS-CXF
Target platform Wildfly/EAP and H2 using Hibernate and JBossWS-cxf. The juddiv3.war relies on Hibernate and JBossWS-cxf modules in the appserver. To build the correct juddiv3.war run
-----
+````
mvn clean package -P jboss7up
-----
+````
Use the JBoss add-user.sh script to create an application user with the uddiadmin role.
-=== Deploying to Glassfish
+### Deploying to Glassfish
This section describes how to deploy juddi to Glassfish 2.1.1. These instructions will use CXF as a webservice framework.
First, download the glassfish-v2.1.1 installer JAR. Once downloaded,install using the JAR and then run the ant setup script :
-----
+````
java -jar glassfish-installer-v2.1.1-b31g-linux.jar
cd glassfish
ant -f setup.xml
-----
+````
-==== Glassfish jars
+#### Glassfish jars
Copy the following JARs into domains/domain1/lib/ext. Note that for the purposes of this example, we have copied the MySQL driver to domains/domain1/lib/ext :
-----
+````
antlr-2.7.6.jar
cglib-nodep-2.1_3.jar
commons-collections-3.2.1.jar
@@ -172,11 +185,13 @@ jboss-common-core-2.0.4.GA.jar
jta-1.0.1B.jar
mysql-connector-java-5.0.8-bin.jar
persistence-api-1.0.jar
-----
+````
+
+#### Configure the JUDDI datasource
-==== Configure the JUDDI datasource
First, using the asadmin administration tool, import the following file :
-----
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE resources PUBLIC "-//Sun Microsystems Inc.//DTD Application Server 9.0 Domain//EN" "*<install directory>/lib/dtds/sun-resources_1_3.dtd*">
<resources>
@@ -187,17 +202,21 @@ First, using the asadmin administration tool, import the following file :
</jdbc-connection-pool>
<jdbc-resource enabled="true" jndi-name="jdbc/mysql-resource" object-type="user" pool-name="mysql-pool"/>
</resources>
-----
-----
+````
+
+````
asadmin add-resources resource.xml
-----
+````
+
Then use the Glassfish administration console to create a "jdbc/juddiDB" JDBC datasource resource based on the mysql-pool Connection Pool.
-==== Add juddiv3-cxf.war
+#### Add juddiv3-cxf.war
+
Unzip the juddiv3-cxf WAR into domains/domain1/autodeploy/juddiv3.war .
Add a sun-web.xml file into juddiv3.war/WEB-INF. Make sure that the JNDI references matches the JNDI location you configured in the Glassfish administration console.
-----
+
+````
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sun-web-app PUBLIC '-//Sun Microsystems, Inc.//DTD
Application Server 9.0 Servlet 2.5//EN'
@@ -208,13 +227,17 @@ Application Server 9.0 Servlet 2.5//EN'
<jndi-name>jdbc/juddiDB</jndi-name>
</resource-ref>
</sun-web-app>
-----
-Next, make a few changes to juddiv3.war/WEB-INF/classes/META-INF/persistence.xml . Change the "hibernate.dialect" property to match the database that you have chosen for persistence. For MySQL, change the value of hibernate.dialect to "org.hibernate.dialect.MySQLDialect". A full list of dialects available can be found in the hibernate documentation (https://www.hibernate.org/hib_docs/v3/api/org/hibernate/dialect/package-summary.html). Next, change the <jta-data-source> change the value f [...]
+````
+
+Next, make a few changes to juddiv3.war/WEB-INF/classes/META-INF/persistence.xml . Change the "hibernate.dialect" property to match the database that you have chosen for persistence. For MySQL, change the value of hibernate.dialect to "org.hibernate.dialect.MySQLDialect". A full list of dialects available can be found in the hibernate documentation (https://www.hibernate.org/hib_docs/v3/api/org/hibernate/dialect/package-summary.html). Next, change the `<jta-data-source>` change the value [...]
+
+#### Run jUDDI
-==== Run jUDDI
Start up the server :
-----
+
+````
cd bin
asadmin start-domain domain1
-----
+````
+
Once the server is deployed, browse to http://localhost:8080/juddiv3
\ No newline at end of file
diff --git a/docs/asciidoc/Guide/en-US/GuideReplication.asciidoc b/src/site/markdown/GuideReplication.md
similarity index 96%
rename from docs/asciidoc/Guide/en-US/GuideReplication.asciidoc
rename to src/site/markdown/GuideReplication.md
index a088f67ed..b8ef1d46b 100644
--- a/docs/asciidoc/Guide/en-US/GuideReplication.asciidoc
+++ b/src/site/markdown/GuideReplication.md
@@ -1,17 +1,16 @@
-[[chapter-Replication]]
-== Replication Services
+## Replication Services
-=== Introduction
+### Introduction
The UDDIv3 specification introduced a Replication API that outlines a mechansim for maintaing data ownership and data synchronization across more than one UDDI node. The replication specification has a number of facets that to the casual reader, can see overwhelmingly complex. jUDDI v3 provides support for the majority of the UDDIv3 replication API. This article will attempt to describe the in's and out's of the specification, what jUDDI supports and doesn't, finally, how to use it with [...]
-=== UDDIv3 Replication Overview
+### UDDIv3 Replication Overview
The UDDIv3 replication API defines a number of web service methods that are used to manage and replicate UDDI data. Each node is responsible for maintaining a record of all changes made both locally and at all remote nodes. Everytime a Business, Service, Binding, tModel, or Publisher Assertion changes, all nodes are notified of the change. Once receiving the notification of the change, all nodes are then responsible to obtain the change set, apply it locally, and then retransmit (if need [...]
There's one important note to remember. Each piece of data in UDDI is owned by a given node.
-==== UDDIv3 Replication Topology
+#### UDDIv3 Replication Topology
The specification identifies two scenarios for replication topology.
@@ -22,11 +21,11 @@ The Non-directed graph is easier to implement and to understand. During the "not
In a directed graph, the node where the change originates only notifies the nodes designated nodes. This typically forms some kind of ring in which one node notifies the next and so on until the original change ends up at the origin.
-==== Conflict handling
+#### Conflict handling
The specification defines a mechanism that is similar to a two step commit (for those familiar with database terminology). Esscentially, when a given change (typically a new record) is created, it then notifies all other nodes to put a block on the new record's keys and waits for all nodes to respond with an "OK" to commit message. This prevents the same record from being created in multiple locations. These types of messages are refered to in the specification as NewDataConditional. As [...]
-=== Configuring your jUDDI Node for replication
+### Configuring your jUDDI Node for replication
Prerequisites:
@@ -34,15 +33,15 @@ Prerequisites:
2. Each node must have the UDDI v3 Replication service (juddiv3replication.war) deployed and configured for CLIENT-CERT authentication using SSL/TLS.
3. Each node must have a configured JKS key store and trust store.
-==== Changing the Node ID
+#### Changing the Node ID
Forgot to change the Node ID before starting jUDDI for the first time? No problem. Visit the jUDDI Administration console at http://localhost:8080/juddiv3/admin, then go to the Admin page and select "Change Node Id" from the drop down menu.
-==== Setting up CLIENT-CERT authentication
+#### Setting up CLIENT-CERT authentication
Since a registry can be corrupted via the replication endpoint, it is important to provide adequate security. The UDDI spec recommends using mutual certificate authentication. This is somtimes returned to as "CLIENT-CERT", certificate based authentication, or two-way SSL. All of these terms really refer to the same thing. jUDDI comes prebundled with Apache Tomcat that is configured for mutal certificate authentication out of the box (with self signed certificates). To setup CLIENT-CERT a [...]
-===== Special notes on key stores and trust stores
+##### Special notes on key stores and trust stores
jUDDI's use of key stores and trust stores for replication purposes using the standard system properties
- -Djavax.net.ssl.keyStore
@@ -54,21 +53,21 @@ These are used for transport layer security (node to node). On a side node, jUDD
For Tomcat, all you need is a connector with "clientAuth=want". Here's an example:
-----
+````
<Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true"
maxThreads="150" scheme="https" secure="true"
clientAuth="want" sslProtocol="TLS"
truststoreFile="truststore.jks" truststorePass="password"
keystoreFile="conf/keystore.jks" keystorePass="password"/>
-----
+````
-===== Mapping certificates to roles
+##### Mapping certificates to roles
For each certificate that is used by a jUDDI node to authenticate to another, you'll have to map the Subject DN of the certificate to a user with the role "replication". In our example, we'll use tomcat's _tomcat-users.xml_ file.
-----
+````
<user username="CN=localhost, OU=jUDDI Test, O=Apache Software Foundation, L=Anytown, ST=MD, C=US" password="null" roles="replication"/>
-----
+````
In this example, we've added our test certificate's subject DN to the role of "replication".
@@ -90,7 +89,7 @@ Then the certificates must be setup as follows (assuming that each node's SSL ce
- Node 1's public and private keys must be in a keystore on Node 1 (and the Java -D properties set)
- Node 2's public and private keys must be in a keystore on Node 2 (and the Java -D properties set)
-==== Setting the Replication Configuration
+#### Setting the Replication Configuration
To set the replication configuration, you'll need to go to http://localhost:8080/juddiv3/admin then click on "Admin" in the top navigation bar and login. Once logged in, select "set_ReplicationNodes" from the drop down menu. The text entry field is actually resizable, so you'll probably want to make it bigger. This text box should be pre-populated with an example replication configuration. Edit the replication as needed, then click the "Go!" button to save it.
@@ -99,7 +98,7 @@ Note: when saving the configuration, several of the fields (time stamp, serial n
Additional notes:
jUDDI doesn't currently support maximumTimeToSyncRegistry, maximumTimeToGetChanges, and controlledMessage. Due to the way the specification was written, these fields are mandatory (they must be in the Replication Configuration XML), but jUDDI wont't respect them.
-===== Replication Configuration
+##### Replication Configuration
When using jUDDI's Admin console to set the replication config, here's a few things to keep in mind (using xpath notation).
@@ -115,7 +114,8 @@ When using jUDDI's Admin console to set the replication config, here's a few thi
Everytime the configuration changes, an audit log is required in jUDDI log file.
Here's an example default configuration
-----
+
+````
<?xml version="1.0" encoding="UTF-8"?><replicationConfiguration xmlns="urn:uddi-org:repl_v3" xmlns:ns2="urn:uddi-org:api_v3" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#">
<serialNumber>1424114880586</serialNumber>
<timeOfConfigurationUpdate>201502161428-0500</timeOfConfigurationUpdate>
@@ -137,10 +137,11 @@ Here's an example default configuration
<maximumTimeToSyncRegistry>1</maximumTimeToSyncRegistry>
<maximumTimeToGetChanges>1</maximumTimeToGetChanges>
</replicationConfiguration>
-----
+````
Here's an example non-directed replicaton graph. In this example, all changes perform on all nodes get set to all the other nodes.
-----
+
+````
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<replicationConfiguration xmlns="urn:uddi-org:repl_v3" xmlns:ns2="urn:uddi-org:api_v3" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#">
<serialNumber>0</serialNumber>
@@ -174,10 +175,11 @@ Here's an example non-directed replicaton graph. In this example, all changes pe
<maximumTimeToSyncRegistry>1</maximumTimeToSyncRegistry>
<maximumTimeToGetChanges>1</maximumTimeToGetChanges>
</replicationConfiguration>
-----
+````
In this example, we have a directed graph where Node 1 sends to Node2, Node 2 to Node 3, and Node 3 to Node 1. Note the addition of the replicationConfiguration/communicationGraph/edge() that defines this interaction pattern. Again all nodes defined in edges must also be defined both in the communicationGraph and as operator() XML elements.
-----
+
+````
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<replicationConfiguration xmlns="urn:uddi-org:repl_v3" xmlns:ns2="urn:uddi-org:api_v3" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#">
<serialNumber>0</serialNumber>
@@ -231,16 +233,16 @@ In this example, we have a directed graph where Node 1 sends to Node2, Node 2 to
<maximumTimeToSyncRegistry>1</maximumTimeToSyncRegistry>
<maximumTimeToGetChanges>1</maximumTimeToGetChanges>
</replicationConfiguration>
-----
+````
One last point of interest, Edge's can have a list of alternate message receivers and it is supported by jUDDI.
-==== Performing Custody Transfer between nodes
+#### Performing Custody Transfer between nodes
Custody transfer (from a user's perspective) happens exacty the same way as it would to transfer between two users on the same node. The only change is that the Replication API plays a signficant role in this process and is thus a requirement.
-==== What's Supported and What's Not
+#### What's Supported and What's Not
Here's a quick summary of what is and isn't supported for jUDDI replication capabilities. Want more support? Open a ticket and contribute.
diff --git a/docs/asciidoc/Guide/en-US/GuideRootSeedData.asciidoc b/src/site/markdown/GuideRootSeedData.md
similarity index 93%
rename from docs/asciidoc/Guide/en-US/GuideRootSeedData.asciidoc
rename to src/site/markdown/GuideRootSeedData.md
index ab7a74315..336c9b632 100644
--- a/docs/asciidoc/Guide/en-US/GuideRootSeedData.asciidoc
+++ b/src/site/markdown/GuideRootSeedData.md
@@ -1,29 +1,31 @@
-[[chapter-UDDISeedData]]
-== UDDI Seed Data
+## UDDI Seed Data
This information is relevant for both understanding how jUDDI's default data is set when jUDDI first runs (i.e. to a new database). It's also useful for scripting or automating the deployment of a jUDDI server within your organization which will enable you to prepopulate the data.
As of UDDI v3, each registry need to have a "root" publisher. The root publisher is the owner of the UDDI services (inquiry, publication, etc). There can only be one root publisher per node. JUDDI ships some default seed data for the root account. The default data can be found in the juddi-core-3.x.jar, under juddi_install_data/. By default jUDDI installs two Publishers: "root" and "uddi". Root owns the root partition, and uddi owns all the other seed data such as pre-defined tModels.
-=== Seed Data Files
+### Seed Data Files
For each publisher there are four seed data files that will be read the first time you start jUDDI:
-----
+
+````
<publisher>_Publisher.xml
<publisher>_tModelKeyGen.xml
<publisher>_BusinessEntity.xml
<publisher>_tModels.xml
-----
+````
For example the content of the root_Publisher.xml looks like
-----
+
+````
<publisher xmlns="urn:juddi-apache-org:api_v3" authorizedName="root">
<publisherName>root publisher</publishername>
<isAdmin>true</isadmin>
</publisher>
-----
+````
Each publisher should have its own key generator schema so that custom generated keys cannot end up being identical to keys generated by other publishers. It is therefor that the each publisher need to define their own KenGenerator tModel. The tModel Key Generator is defined in the file root_tModelKeyGen.xml and the content of this file is
-----
+
+````
<tModel tModelKey="uddi:juddi.apache.org:keygenerator" xmlns="urn:uddi-org:api_v3">
<name>uddi-org:keyGenerator</name>
<description>Root domain key generator</description>
@@ -38,11 +40,13 @@ Each publisher should have its own key generator schema so that custom generated
keyValue="keyGenerator" />
</categorybag>
</tmodel>
-----
+````
+
+This means that the legal format of keys used by the root publisher need to be in the form uddi:juddi.apache.org:<text-of-chioce></text-of-chioce> The use of other types of format will lead to an 'illegal key' error. The root publisher can only own one KeyGenerator while any other publisher can own more then one KeyGenerator. KeyGenerators should not be shared unless there is a good reason to do so. If you want to see your publisher with more then just the one KeyGenerator tModel, you ca [...]
+
+Finally, in the `<publisher></publisher>_BusinessEntity.xml` file can be used to setup Business and Service data. In the root_BusinessEntity.xml we specified the ASF Business, and the UDDI services; Inquiry, Publish, etc.:
-This means that the legal format of keys used by the root publisher need to be in the form uddi:juddi.apache.org:<text-of-chioce></text-of-chioce> The use of other types of format will lead to an 'illegal key' error. The root publisher can only own one KeyGenerator while any other publisher can own more then one KeyGenerator. KeyGenerators should not be shared unless there is a good reason to do so. If you want to see your publisher with more then just the one KeyGenerator tModel, you ca [...]
-Finally, in the <publisher></publisher>_BusinessEntity.xml file can be used to setup Business and Service data. In the root_BusinessEntity.xml we specified the ASF Business, and the UDDI services; Inquiry, Publish, etc.:
-----
+````
<businessEntity xmlns="urn:uddi-org:api_v3" xmlns:xml="http://www.w3.org/XML/1998/namespace" businessKey="uddi:juddi.apache.org:businesses-asf">
<!-- Change the name field to represent the name of your registry -->
<name xml:lang="en">An Apache jUDDI Node</name>
@@ -91,23 +95,28 @@ Finally, in the <publisher></publisher>_BusinessEntity.xml file can be used to s
</businessService>
<!-- snip -->
</businessService>
-----
+````
Note that the seeding process only kicks off if no publishers exist in the database. So this will only work with a clean database, unless you set juddi/seed/always to true. Then it will re-apply all files with the exception of the root data files. Note that this can lead to losing data that was added to entities that are re-seeded, since data is not merged.
-=== Tokens in the Seed Data
+### Tokens in the Seed Data
+
You may have noticed the tokens in the root_BusinessEntity.xml file (${juddi.server.baseurl}. The value of this tokens can set in the juddiv3.xml file. The value substitution takes place at runtime, so that different nodes can do the substitution with their own value if needed.
-=== Customer Seed Data
+### Customer Seed Data
+
In your deployment you probably do not want to use the Seed Data shipped with the default jUDDI install. The easiest way to overwrite this data is to add it to a directory call juddi_custom_install_data in the juddiv3.war/WEB-INF/classes/ directory. That way you don't have to modify the juddi-core-3.x.jar. Additionally if your root publisher is not called "root" you will need to set the juddi/root/publisher property in the juddiv3.xml file to something other then
-----
+
+````
juddi/root/publisher=root
-----
+````
+
The juddiv3.war ships with two example data directory. One for the Sales Affiliate, and one for the Marketing Affiliate. To use the Sales Seed Data, in the juddiv3.war/WEB-INF/classes/, rename the directory
-----
+
+````
*nix
mv RENAME4Sales_juddi_custom_install_data juddi_custom_install_data
Win*
ren RENAME4Sales_juddi_custom_install_data juddi_custom_install_data
-----
+````
before you start jUDDI the first time. It will then use this data to populate the database. If you want to rerun you can trash the database it created and restart tomcat. Don't forget to set the tokens in the juddiv3.xml file.
diff --git a/docs/asciidoc/Guide/en-US/GuideTroubleshootingjUDDI.asciidoc b/src/site/markdown/GuideTroubleshootingjUDDI.md
similarity index 89%
rename from docs/asciidoc/Guide/en-US/GuideTroubleshootingjUDDI.asciidoc
rename to src/site/markdown/GuideTroubleshootingjUDDI.md
index 0a818828f..acc5c4ef4 100644
--- a/docs/asciidoc/Guide/en-US/GuideTroubleshootingjUDDI.asciidoc
+++ b/src/site/markdown/GuideTroubleshootingjUDDI.md
@@ -1,14 +1,14 @@
-== Troubleshooting jUDDI
+## Troubleshooting jUDDI
Here are some tips to help you troubleshoot problems with jUDDI, jUDDI-GUI, jUDDI Client and more.
-=== jUDDI Web Services, juddiv3.war
+### jUDDI Web Services, juddiv3.war
-==== Enable debugging logging
+#### Enable debugging logging
You can adjust the logging level to provide additional output for troubleshooting purposes. To do so, see the Administration Guide, Logging.
-=== jUDDI GUI, juddi-gui.war
+### jUDDI GUI, juddi-gui.war
Problem: Can't authentication from juddi-gui's top right hand side login box to juddiv3.war services
Solutions:
@@ -19,16 +19,17 @@ Solutions:
* Increase the logging level of jUDDI by changing the commons-logging.properties file
* If you're having problems with Email delivery of subscription updates, enable debug logging by setting config/uddi/mail/debug=true in juddiv3.xml
-=== jUDDI Client Java
+### jUDDI Client Java
-==== Enable debugging logging
+#### Enable debugging logging
You can adjust the logging level to provide additional output for troubleshooting purposes. To do so, see the Administration Guide, Logging.
-=== jUDDI Client .NET
+### jUDDI Client .NET
-Components based on jUDDI's Client for the .NET Framework can configure logging from their application's config file. This is usually app.config or web.config. To configure logging, the following three settings must appear in the configuration/appSetttings section.
-----
+Components based on jUDDI's Client for the .NET Framework can configure logging from their application's config file. This is usually app.config or web.config. To configure logging, the following three settings must appear in the `configuration/appSetttings` section.
+
+````
<!-- DEBUG, INFO, WARN, ERROR -->
<add key="org.apache.juddi.v3.client.log.level" value="INFO" />
<!-- options are CONSOLE, EVENTLOG, FILE multiple values can be specified, comma delimited.
@@ -36,11 +37,12 @@ Components based on jUDDI's Client for the .NET Framework can configure logging
<add key="org.apache.juddi.v3.client.log.target" value="CONSOLE" />
<!-- only used when target=FILE -->
<add key="org.apache.juddi.v3.client.log.logger.file" value="pathToOutputFile" />
-----
+````
+
If nothing is defined, the default log level is "WARN" and the target is "CONSOLE" which is standard out.
-=== Getting help
+### Getting help
There are many different ways to get help with your jUDDI instance. Please refer to the following URLs for more information.
diff --git a/src/site/markdown/GuideUDDIRegistryIntroduction.md b/src/site/markdown/GuideUDDIRegistryIntroduction.md
new file mode 100644
index 000000000..c53a7db45
--- /dev/null
+++ b/src/site/markdown/GuideUDDIRegistryIntroduction.md
@@ -0,0 +1,101 @@
+## Universal Description, Discovery and Integration (UDDI)
+
+### UDDI Protocol, Specification
+
+The Universal Description, Discovery and Integration (UDDI) protocol is one of the major building blocks required for successful Web services. UDDI creates a standard interoperable platform that enables companies and applications to quickly, easily, and dynamically find and use Web services over the Internet (or Intranet). UDDI also allows operational registries to be maintained for different purposes in different contexts. UDDI is a cross-industry effort driven by major platform and sof [...]
+
+### UDDI Registry
+
+The UDDI Registry (((UDDI,registry))) implements the UDDI specification (((UDDI,specification))). UDDI is a Web-based _distributed_ _directory_ (((directory))) that enables businesses to list themselves on the Internet (or Intranet) and discover each other, similar to a traditional phone book's yellow and white pages. The UDDI registry is both a white pages business directory and a technical specifications library. The Registry is designed to store information about Businesses and Servic [...]
+
+
+
+In step 1, it is shown how a business publishes services to the UDDI registry. In step 2, a client looks up the service in the registry and receives service binding information. Finally in step 3, the client then uses the binding information to invoke the service. The UDDI APIs are SOAP based for interoperability reasons. In this example we've three APIs specified in the UDDI v3 specification, Security, Publication and Inquiry. The UDDI v3 specification defines 9 APIs:
+
+. UDDI_Security_PortType, defines the API to obtain a security token. With a valid security token a publisher can publish to the registry. A security token can be used for the entire session.
+. UDDI_Publication_PortType, defines the API to publish business and service information to the UDDI registry.
+. UDDI_Inquiry_PortType, defines the API to query the UDDI registry. Typically this API does not require a security token.
+. UDDI_CustodyTransfer_PortType, this API can be used to transfer the custody of a business from one UDDI node to another.
+. UDDI_Subscription_PortType, defines the API to register for updates on a particular business of service.
+. UDDI_SubscriptionListener_PortType, defines the API a client must implement to receive subscription notifications from a UDDI node.
+. UDDI_Replication_PortType, defines the API to replicate registry data between UDDI nodes.
+. UDDI_ValueSetValidation_PortType, by nodes to allow external providers of value set validation. Web services to assess whether keyedReferences or keyedReferenceGroups are valid.
+. UDDI_ValueSetCaching_PortType, UDDI nodes may perform validation of publisher references themselves using the cached values obtained from such a Web service.
+
+### jUDDI Project
+
+Apache jUDDI is server and client-side implementation of the UDDI v3 specification. The server side is the UDDI Registry, the client side are the juddi-client libraries. There is a Java as well as a C# version of the client libraries. The jUDDI GUI uses the client libraries to connect to a UDDI Registry. For more details please see the <<GuideGettingStarted#chapter-GettingStarted>>.
+
+The following is a list of all supported UDDI interfaces provided by this release of jUDDI
+
+Supported UDDI Interfaces
+
+| API | Spec | Supported | Notes
+| --- | --- | --- | --- |
+| [Inquiry](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908076) | Required | All Methods | |
+| [Inquiry HTTP GET](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908158) | Optional | All Methods | Plus a number of additional methods
+| [Publication](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908095) | Required | All Methods | |
+| [Security](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908115) | Optional | All Methods | Pluggable authentication
+| [Subscription](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908128) | Optional | All Methods | HTTP, SMTP delivery implemented, pluggable
+| [Subscription Listener](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908336) |Optional | All Methods | Client and Server side implementations
+| [Value Set Caching](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908141) | Optional | Partial | Scheduled for 3.3
+| [Value Set Validation](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908141) | Optional | Implemented | Scheduled for 3.3
+| [Replication](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908180) | Optional | Partial | Scheduled for 3.3
+| [Custody and Ownership Transfer](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908118) | Optional | All Methods | Only supports user to user transfers on the same node
+| [UDDIv2 Inquiry](http://uddi.org/pubs/ProgrammersAPI-V2.04-Published-20020719.htm#_Toc25137711) | Required | BETA | Supported via API translator
+| [UDDIv2 Publish](http://uddi.org/pubs/ProgrammersAPI-V2.04-Published-20020719.htm#_Toc25137722 | Required | BETA | Supported via API translator
+
+
+The following is a list of other features of interest that was either defined in the UDDI specifications or in technical notes.
+
+jUDDI Features
+
+
+| API | Spec | Supported | Notes
+| --- | --- | --- | --- |
+| Digital Signatures | Server req | Full support | Java and .NET clients and in browser signing
+| Client side Subscription Listener | Optional | Full support | Java and .NET clients
+| [WSDL to UDDI](https://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-tn-wsdl-v2.htm) | Recommendation| Full support | Java, .NET clients and web GUI
+| [WADL to UDDI]https://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-tn-wsdl-v2.htm) | Recommendation| Full support | Java, .NET clients and web GUI
+| [BPEL to UDDI](https://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-tn-bpel-20040725.htm) | Recommendation| Full support | Java client
+| UDDI Technical Compliance Kit | - | Full support | Provides a standalone UDDI testing capability
+| Internationalization | Recommendation| Yes | Both end user interfaces (User and Admin web apps) are supported. Error messages from the server are external and can be overwritten.
+| Registration via Annotations | - | Full support | Provides automated registration of classes via Java/.NET Annotations
+
+
+UDDI defines a number of http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908080[sorting mechanisms].
+
+Supported Sort Orders
+
+| Find Qualifier | Spec | Supported | Notes
+| --- | --- | --- | --- |
+| [binarySort](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#sortOrd) | Required | yes |
+| [caseInsensitiveSort](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#caseInsensSort) | Required | partialy | Only when using caseInsentitiveMatch, https://issues.apache.org/jira/browse/JUDDI-785[JIRA opened]
+| [caseSensitiveSort](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908355) | Required | yes | |
+| [sortByNameAsc](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908356) | Required | yes | |
+| [sortByNameDesc](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908357) | Required | yes | |
+| [sortByDateAsc](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908358) | Required | yes | |
+| [sortByDateDesc](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908359) | Required | yes | |
+| [JIS-X4061](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc42047570) | Optional | no | Japanese Character Strings
+| [UTS-10](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#UCASort) | Recommended | yes | |
+
+Supported Find Qualifiers
+
+| Find Qualifier | Spec |Supported
+| --- | --- | --- |
+| [andAllKeys](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908360) | Required | yes
+| [approximateMatch](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908346) | Required | yes
+| [bindingSubset](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908365) | Required | yes
+| [caseInsensitiveMatch](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908348) | Required | yes
+| [caseSensitiveMatch](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908349) | Required | yes
+| [combineCategoryBags](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908363) | Required | yes
+| [diacriticInsensitiveMatch](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908350) | Optional | yes
+| [diacriticSensitiveMatch](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908351) | Required | yes
+| [exactMatch](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908347) | Required | yes
+| [signaturePresent](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908367) | Required | yes
+| [orAllKeys](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908361) | Required | yes
+| [orLikeKeys](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908362) | Required | yes
+| [serviceSubset](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908364) | Required | yes
+| [suppressProjectedServices](http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908366) | Required | yes
+
+
diff --git a/docs/asciidoc/Guide/en-US/GuideUDDISubscriptions.asciidoc b/src/site/markdown/GuideUDDISubscriptions.md
similarity index 94%
rename from docs/asciidoc/Guide/en-US/GuideUDDISubscriptions.asciidoc
rename to src/site/markdown/GuideUDDISubscriptions.md
index b485796e6..f9a20fa08 100644
--- a/docs/asciidoc/Guide/en-US/GuideUDDISubscriptions.asciidoc
+++ b/src/site/markdown/GuideUDDISubscriptions.md
@@ -1,4 +1,4 @@
-== UDDI Subscriptions
+## UDDI Subscriptions
Subscriptions come to play in a multi-registry setup. Within your company you may have the need to run with more then one UDDI, let's say one for each department, where you limit access to the systems in each department to just their own UDDI node. However you may want to share some services cross departments. The subscription API can help you cross registering those services and keeping them up to date by sending out notifications as the registry information in the parent UDDI changes.
@@ -11,50 +11,52 @@ There are two type of subscriptions:
Save a subscription and invoke the get_Subscription and get a synchronous reply.
The notification can be executed in a synchronous and an asynchronous way. The asynchronous way requires a listener service to be installed on the node to which the notifications should be sent.
-=== Two node example setup: Sales and Marketing
+### Two node example setup: Sales and Marketing
+
In this example we are setting up a node for 'sales' and a node for 'marketing'. For this you need to deploy jUDDI to two different services, then you need to do the following setup:
Procedure 10.1. Setup Node 1: Sales
Create juddi_custom_install_data.
-----
+
+````
cd juddiv3/WEB-INF/classes
mv RENAME4SALES_juddi_custom_install_data juddi_custom_install_data
-----
+````
edit: webapps/juddiv3/WEB-INF/classes/juddiv3.properties and set the following property values where 'sales' is the DNS name of your server.
-----
+````
juddi.server.name=sales
juddi.server.port=8080
-----
+````
Start the server (tomcat), which will load the UDDI seed data (since this is the first time you're starting jUDDI, see , Root Seed Data)
-----
+````
bin/startup.sh
-----
+````
Open your browser to http://sales:8080/juddiv3. You should see:
-image::images/sales_node_installation.png
+
Figure Sales Node Installation
Procedure 10.2. Setup Node 2: Marketing
Create juddi_custom_install_data.
-----
+````
cd juddiv3/WEB-INF/classes
mv RENAME4MARKETING_juddi_custom_install_data juddi_custom_install_data
-----
+````
edit: webapps/juddiv3/WEB-INF/classes/juddiv3.properties and set the following property values where 'marketing' is the DNS name of your server.
-----
+````
juddi.server.name=marketing
juddi.server.port=8080
-----
+````
Start the server (tomcat), which will load the UDDI seed data (since this is the first time you're starting jUDDI, see Chapter 5, Root Seed Data)
-----
+````
bin/startup.sh
-----
+````
Open your browser to http://marketing:8080/juddiv3 . You should see:
-image::images/marketing_node_installation.png
+
Figure 10.2. Marketing Node Installation
@@ -62,45 +64,45 @@ Note that we kept the root partition the same as sales and marketing are in the
Finally you will need to replace the sales server's uddi-portlets.war/WEB-INF/classes/META-INF/uddi.xml with uddi-portlets.war/WEB-INF/classes/META-INF/uddi.xml.sales. Then, edit the uddi-portlets.war/WEB-INF/classes/META-INF/uddi.xml and set the following properties:
-----
+````
<name>default</name>
<properties>
<property name="serverName" value="sales"/>
<property name="serverPort" value="8080"/>
<property name="rmiPort" value="1099"/>
</properties>
-----
+````
Log into the sales portal: http://sales:8080/pluto with username/password: sales/sales.
-image::images/sales_services.png
+
Figure 10.3. Sales Services
Before logging into the marketing portal, replace marketing's uddi-portlet.war/WEB-INF/classes/META-INF/uddi.xml with udd-portlet.war/WEB-INF/classes/META-INF/uddi.xml.marketing. Then you will need to edit the uddi-portlet.war/WEB-INF/classes/META_INF/uddi.xml and set the following properties:
-----
+````
<name>default</name>
<properties>
<property name="serverName" value="marketing"/>
<property name="serverPort" value="8080"/>
<property name="rmiPort" value="1099"/>
</properties>
-----
+````
Now log into the marketing portal http://marketing:8080/pluto with username/password: marketing/ marketing. In the browser for the marketing node we should now see:
-image::images/marketing_services.png
+
Figure 10.4. Marketing Services
Note that the subscriptionlistener is owned by the Marketing Node business (and not the Root Marketing Node). The Marketing Node Business is managed by the marketing publisher.
-=== Deploy the HelloSales Service
+### Deploy the HelloSales Service
The sales department developed a service called HelloSales. The HelloSales service is provided in the juddiv3-samples.war, and it is annotated so that it will auto-register. Before deploying the war, edit the juddiv3-samples.war/WEB-INF/classes/META-INF/uddi.xml file to set some property values to 'sales'.
-----
+````
<?xml version="1.0" encoding="ISO-8859-1" ?>
<uddi>
<reloadDelay>5000</reloadDelay>
@@ -135,7 +137,7 @@ The sales department developed a service called HelloSales. The HelloSales servi
</nodes>
</manager>
</uddi>
-----
+````
Now deploy the juddiv3-samples.war to the sales registry node, by building the juddiv3-samples.war and deploying. The HelloWorld service should deploy
@@ -146,11 +148,11 @@ Figure 10.5. Registration by Annotation, deploying the juddi-samples.war to the
On the Marketing UDDI we'd like to subscribe to the HelloWord service, in the Sales UDDI Node. As mentioned before there are two ways to do this; synchronously and asynchronously.
-==== Configure a user to create Subscriptions
+#### Configure a user to create Subscriptions
For a user to create and save subscriptions the publisher needs to have a valid login to both the sales and the marketing node. Also if the marketing publisher is going to create registry objects in the marketing node, the marketing publisher needs to own the sales keygenerator tModel. Check the marketing_*.xml files in the root seed data of both the marketing and sales node, if you want to learn more about this. It is important to understand that the 'marketing' publisher in the marketi [...]
-----
+````
<save_tModel xmlns="urn:uddi-org:api_v3">
<tModel tModelKey="uddi:marketing.apache.org:keygenerator" xmlns="urn:uddi-org:api_v3">
<name>marketing-apache-org:keyGenerator</name>
@@ -198,9 +200,11 @@ For a user to create and save subscriptions the publisher needs to have a valid
</categoryBag>
</tModel>
</save_tModel>
-----
+````
+
If we are going to user the marketing publisher to subscribe to updates in the sales registry, then we need to provide this publisher with two clerks in the uddi.xml of the uddi-portlet.war.
-----
+
+````
<clerks registerOnStartup="false">
<clerk name="MarketingCratchit" node="default"
publisher="marketing" password="marketing"/>
@@ -215,20 +219,21 @@ If we are going to user the marketing publisher to subscribe to updates in the s
</xregister>
-->
</clerks>
-----
+````
+
Here we created two clerks for this publisher called 'MarketingCratchit' and 'SalesCratchit'. This will allow the publisher to check the existing subscriptions owned by this publisher in each of the two systems.
-=== Synchronous Notifications
+### Synchronous Notifications
While being logged in as the marketing publisher on the marketing portal, we should see the following when selecting the UDDISubscription Portlet.
-image::images/a_bothup_b_sales_down.png
+
Figure 10.6. Subscriptions. In (a) both nodes are up while in (b) the sales node is down
When both nodes came up green you can lick on the 'new subscription' icon in the toolbar. Since we are going to use this subscription synchronously only the Binding Key and Notification Interval should be left blank, as shown in Figure 10.7, "Create a New Subscription". Click the save icon to save the subscription.
-image::images/create_new_subscription.png
+
Figure 10.7. Create a New Subscription
@@ -242,18 +247,18 @@ Figure 10.9. Set the Coverage Period
Click the green arrows icon again to invoke the synchronous subscription request. The example finder request will go out to the sales node and look for updates on the HelloWorld service. The raw XML response will be posted in the UDDISubscriptionNotification Portlet.
-image::images/raw_XML_response_synchronous_subscription_request.png
+
Figure 10.10. The Raw XML response of the synchronous Subscription request
The response will also be consumed by the marketing node. The marketing node will import the HelloWorld subscription information, as well as the sales business. So after a successful sync you should now see three businesses in the Browser Portlet of the marketing node, see Figure 10.11, "The registry info of the HelloWorld Service information was imported by the subscription mechanism.".
-image::images/registry_info_helloworld.png
+
Figure 10.11. The registry info of the HelloWorld Service information was imported by the subscription mechanism.
-=== Using the 3.2+ Subscription callback API
+### Using the 3.2+ Subscription callback API
Since 3.2, a newer simplified subscription API was included in the juddi-client JAR file. See the sample in the uddi-samples project.
\ No newline at end of file
diff --git a/docs/asciidoc/Guide/en-US/GuideUsingDigitalSignaturesinUDDI.asciidoc b/src/site/markdown/GuideUsingDigitalSignaturesinUDDI.md
similarity index 90%
rename from docs/asciidoc/Guide/en-US/GuideUsingDigitalSignaturesinUDDI.asciidoc
rename to src/site/markdown/GuideUsingDigitalSignaturesinUDDI.md
index 0b564c0ee..f3f3aa9db 100644
--- a/docs/asciidoc/Guide/en-US/GuideUsingDigitalSignaturesinUDDI.asciidoc
+++ b/src/site/markdown/GuideUsingDigitalSignaturesinUDDI.md
@@ -1,18 +1,16 @@
-[[DigitalSignatures]]
-== Digital Signatures
+## Digital Signatures
Users of UDDI can use digital signatures to ensure that no unauthorized users alter the content of UDDI. We're sure that one of the first questions one would ask is "can't access control rules handle this problem for us?" The answer is yes, however it does not mitigate the risk of a number of opportunities for electronic attack.
-=== Requirements
+### Requirements
UDDI supports both the XML Digital Signature specification, which effectively means that you can use PGP Keys and X509 certificates. jUDDI provides out of the box support for X509 certificates and the Public Key Infrastructure (PKI). If you require direct PGP signing support, please open a JIRA ticket.
-=== Using Digital Signatures using the jUDDI GUI
+### Using Digital Signatures using the jUDDI GUI
-Please see <<GuideUsingthejUDDIGUI#UsingDigitalSignatures>>.
+Please see the jUDDI Client Guide.
-[qanda]
-=== Frequently Asked Questions
+### Frequently Asked Questions
Doesn't UDDI access control rules prevent alteration of the content?::
Yes, however it does not mitigate the man in the middle attack vectors. Since UDDI is used to determine the location of the thing you want, it's possible that falsified endpoints can be interjected in transport. The target service requires authentication, then the end user's credentials could be compromised without their knowledge.
diff --git a/src/site/pdf-client.xml b/src/site/pdf-client.xml
new file mode 100644
index 000000000..8138f33c5
--- /dev/null
+++ b/src/site/pdf-client.xml
@@ -0,0 +1,56 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<!-- START SNIPPET: docDescriptor -->
+<document xsi:schemaLocation="http://maven.apache.org/DOCUMENT/1.0.1 http://maven.apache.org/xsd/document-1.0.1.xsd"
+outputName="juddi-client-guide" xmlns="http://maven.apache.org/DOCUMENT/1.0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<meta>
+<title>Apache jUDDI Client Guide</title>
+<author>Alex O'Ree</author>
+</meta>
+<!-- depth of the TOC can be controlled by adding a depth attribute-->
+<toc name="Table of Contents">
+ <item name="Introduction" ref="ClientGuide.md"/>
+ <item name="Simple Publishing" ref="ClientGuideSimplePublishingUsingthejUDDIAPI.md"/>
+ <item name="Client Config Guide" ref="ClientGuidejUDDIClientConfigurationGuide.md"/>
+ <item name="Key Formats" ref="ClientGuideKeyFormatTemplates.md"/>
+ <item name="Using the jUDDI GUI" ref="ClientGuideUsingthejUDDIGUI.md"/>
+ <item name="WADL and WSDL to UDDI" ref="ClientGuideMappingWADLandWSDLtoUDDI.md"/>
+ <item name="UDDI Annotations" ref="ClientGuideUsingUDDIAnnotationstoAutomateRegistration.md"/>
+ <item name="UDDI v2 Services" ref="ClientGuideUDDIv2Services.md"/>
+ <item name="UDDI Migration Tool" ref="ClientGuideUDDIMigrationTool.md"/>
+ <item name="jUDDI REST Services" ref="ClientGuideUsingjUDDIRestServices.md"/>
+ <item name="jUDDI for .NET" ref="ClientGuidejUDDIClientforNET.md"/>
+ <item name="TCK Runner" ref="ClientGuideTCKRunner.md"/>
+
+
+
+</toc>
+<cover>
+<coverTitle>${project.name}</coverTitle>
+<coverSubTitle>v. ${project.version}</coverSubTitle>
+<coverType>User Guide</coverType>
+<projectName>${project.name}</projectName>
+<projectLogo>images\logo.png</projectLogo>
+<companyName>The Apache Software Foundation</companyName>
+<companyLogo>http://www.apache.org/images/asf_logo_wide.png</companyLogo>
+<author>Alex O'Ree, alexoree@apache.org</author>
+</cover>
+</document>
+
+
\ No newline at end of file
diff --git a/src/site/pdf-server.xml b/src/site/pdf-server.xml
new file mode 100644
index 000000000..c919e9d82
--- /dev/null
+++ b/src/site/pdf-server.xml
@@ -0,0 +1,58 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<!-- START SNIPPET: docDescriptor -->
+<document xsi:schemaLocation="http://maven.apache.org/DOCUMENT/1.0.1 http://maven.apache.org/xsd/document-1.0.1.xsd"
+outputName="juddi-server-guide" xmlns="http://maven.apache.org/DOCUMENT/1.0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<meta>
+<title>Apache jUDDI Server Guide</title>
+<author>Alex O'Ree</author>
+</meta>
+<!-- depth of the TOC can be controlled by adding a depth attribute-->
+<toc name="Table of Contents">
+ <item name="UDDI Registry Introduction" ref="Guide.md"/>
+ <item name="UDDI Registry Introduction" ref="GuideUDDIRegistryIntroduction.md"/>
+ <item name="Getting Started" ref="GuideGettingStarted.md"/>
+ <item name="Architecture" ref="GuideArchitecture.md"/>
+ <item name="Administration" ref="GuideAdministration.md"/>
+ <item name="Server Configuration" ref="GuideConfigurationServer.md"/>
+ <item name="Replication" ref="GuideReplication.md"/>
+ <item name="Root Seed Data" ref="GuideRootSeedData.md"/>
+ <item name="How to Deploy jUDDI" ref="GuideHowToDeployjUDDITo.md"/>
+ <item name="Extending jUDDI" ref="GuideExtendingUDDI.md"/>
+ <item name="Troubleshooting jUDDI" ref="GuideTroubleshootingjUDDI.md"/>
+ <item name="Contributing to jUDDI" ref="GuideContributingtojUDDI.md"/>
+ <item name="UDDI Subscriptions" ref="GuideUDDISubscriptions.md"/>
+ <item name="Digital Signatures in UDDI" ref="GuideUsingDigitalSignaturesinUDDI.md"/>
+
+
+
+</toc>
+<cover>
+<coverTitle>${project.name}</coverTitle>
+<coverSubTitle>v. ${project.version}</coverSubTitle>
+<coverType>Admin Guide</coverType>
+<projectName>${project.name}</projectName>
+<projectLogo>images\logo.png</projectLogo>
+<companyName>The Apache Software Foundation</companyName>
+<companyLogo>http://www.apache.org/images/asf_logo_wide.png</companyLogo>
+<author>Alex O'Ree, alexoree@apache.org</author>
+</cover>
+</document>
+
+
\ No newline at end of file
diff --git a/docs/asciidoc/images/GettingStarted-add_publisher.png b/src/site/resources/images/GettingStarted-add_publisher.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-add_publisher.png
rename to src/site/resources/images/GettingStarted-add_publisher.png
diff --git a/docs/asciidoc/images/GettingStarted-authToken_SoapUI.png b/src/site/resources/images/GettingStarted-authToken_SoapUI.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-authToken_SoapUI.png
rename to src/site/resources/images/GettingStarted-authToken_SoapUI.png
diff --git a/docs/asciidoc/images/GettingStarted-create_business.png b/src/site/resources/images/GettingStarted-create_business.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-create_business.png
rename to src/site/resources/images/GettingStarted-create_business.png
diff --git a/docs/asciidoc/images/GettingStarted-create_keygenerator.png b/src/site/resources/images/GettingStarted-create_keygenerator.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-create_keygenerator.png
rename to src/site/resources/images/GettingStarted-create_keygenerator.png
diff --git a/docs/asciidoc/images/GettingStarted-form_login.png b/src/site/resources/images/GettingStarted-form_login.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-form_login.png
rename to src/site/resources/images/GettingStarted-form_login.png
diff --git a/docs/asciidoc/images/GettingStarted-happy_juddi.png b/src/site/resources/images/GettingStarted-happy_juddi.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-happy_juddi.png
rename to src/site/resources/images/GettingStarted-happy_juddi.png
diff --git a/docs/asciidoc/images/GettingStarted-jUDDI_admin.png b/src/site/resources/images/GettingStarted-jUDDI_admin.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-jUDDI_admin.png
rename to src/site/resources/images/GettingStarted-jUDDI_admin.png
diff --git a/docs/asciidoc/images/GettingStarted-jUDDI_welcome.png b/src/site/resources/images/GettingStarted-jUDDI_welcome.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-jUDDI_welcome.png
rename to src/site/resources/images/GettingStarted-jUDDI_welcome.png
diff --git a/docs/asciidoc/images/GettingStarted-juddi_services.png b/src/site/resources/images/GettingStarted-juddi_services.png
similarity index 100%
rename from docs/asciidoc/images/GettingStarted-juddi_services.png
rename to src/site/resources/images/GettingStarted-juddi_services.png
diff --git a/docs/asciidoc/images/UDDI_Registry_invocation_pattern.png b/src/site/resources/images/UDDI_Registry_invocation_pattern.png
similarity index 100%
rename from docs/asciidoc/images/UDDI_Registry_invocation_pattern.png
rename to src/site/resources/images/UDDI_Registry_invocation_pattern.png
diff --git a/docs/asciidoc/images/UDDI_services_overview.png b/src/site/resources/images/UDDI_services_overview.png
similarity index 100%
rename from docs/asciidoc/images/UDDI_services_overview.png
rename to src/site/resources/images/UDDI_services_overview.png
diff --git a/docs/asciidoc/images/a_bothup_b_sales_down.png b/src/site/resources/images/a_bothup_b_sales_down.png
similarity index 100%
rename from docs/asciidoc/images/a_bothup_b_sales_down.png
rename to src/site/resources/images/a_bothup_b_sales_down.png
diff --git a/docs/asciidoc/images/community/community_doc.png b/src/site/resources/images/community/community_doc.png
similarity index 100%
rename from docs/asciidoc/images/community/community_doc.png
rename to src/site/resources/images/community/community_doc.png
diff --git a/docs/asciidoc/images/community/jbossorglogo.png b/src/site/resources/images/community/jbossorglogo.png
similarity index 100%
rename from docs/asciidoc/images/community/jbossorglogo.png
rename to src/site/resources/images/community/jbossorglogo.png
diff --git a/docs/asciidoc/images/community/title_hdr.png b/src/site/resources/images/community/title_hdr.png
similarity index 100%
rename from docs/asciidoc/images/community/title_hdr.png
rename to src/site/resources/images/community/title_hdr.png
diff --git a/docs/asciidoc/images/create_new_subscription.png b/src/site/resources/images/create_new_subscription.png
similarity index 100%
rename from docs/asciidoc/images/create_new_subscription.png
rename to src/site/resources/images/create_new_subscription.png
diff --git a/docs/asciidoc/images/icon.svg b/src/site/resources/images/icon.svg
similarity index 100%
rename from docs/asciidoc/images/icon.svg
rename to src/site/resources/images/icon.svg
diff --git a/docs/asciidoc/images/jUDDIArchitecture_Gui.png b/src/site/resources/images/jUDDIArchitecture_Gui.png
similarity index 100%
rename from docs/asciidoc/images/jUDDIArchitecture_Gui.png
rename to src/site/resources/images/jUDDIArchitecture_Gui.png
diff --git a/docs/asciidoc/images/jUDDIArchitecture_clientAndGui.png b/src/site/resources/images/jUDDIArchitecture_clientAndGui.png
similarity index 100%
rename from docs/asciidoc/images/jUDDIArchitecture_clientAndGui.png
rename to src/site/resources/images/jUDDIArchitecture_clientAndGui.png
diff --git a/docs/asciidoc/images/jUDDIArchitecture_server.png b/src/site/resources/images/jUDDIArchitecture_server.png
similarity index 100%
rename from docs/asciidoc/images/jUDDIArchitecture_server.png
rename to src/site/resources/images/jUDDIArchitecture_server.png
diff --git a/src/site/resources/images/jUDDIbyKimWood300x300ish - Copy.png b/src/site/resources/images/jUDDIbyKimWood300x300ish - Copy.png
new file mode 100644
index 000000000..965f1fb1e
Binary files /dev/null and b/src/site/resources/images/jUDDIbyKimWood300x300ish - Copy.png differ
diff --git a/docs/asciidoc/images/juddi-admin-configure.png b/src/site/resources/images/juddi-admin-configure.png
similarity index 100%
rename from docs/asciidoc/images/juddi-admin-configure.png
rename to src/site/resources/images/juddi-admin-configure.png
diff --git a/docs/asciidoc/images/juddi-admin-home.png b/src/site/resources/images/juddi-admin-home.png
similarity index 100%
rename from docs/asciidoc/images/juddi-admin-home.png
rename to src/site/resources/images/juddi-admin-home.png
diff --git a/docs/asciidoc/images/juddi-admin-juddiapi.png b/src/site/resources/images/juddi-admin-juddiapi.png
similarity index 100%
rename from docs/asciidoc/images/juddi-admin-juddiapi.png
rename to src/site/resources/images/juddi-admin-juddiapi.png
diff --git a/docs/asciidoc/images/juddi-admin-mbeans.png b/src/site/resources/images/juddi-admin-mbeans.png
similarity index 100%
rename from docs/asciidoc/images/juddi-admin-mbeans.png
rename to src/site/resources/images/juddi-admin-mbeans.png
diff --git a/docs/asciidoc/images/juddi-admin-stats.png b/src/site/resources/images/juddi-admin-stats.png
similarity index 100%
rename from docs/asciidoc/images/juddi-admin-stats.png
rename to src/site/resources/images/juddi-admin-stats.png
diff --git a/docs/asciidoc/images/juddi-admin-status.png b/src/site/resources/images/juddi-admin-status.png
similarity index 100%
rename from docs/asciidoc/images/juddi-admin-status.png
rename to src/site/resources/images/juddi-admin-status.png
diff --git a/docs/asciidoc/images/juddi-gui-browse-business.png b/src/site/resources/images/juddi-gui-browse-business.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-browse-business.png
rename to src/site/resources/images/juddi-gui-browse-business.png
diff --git a/docs/asciidoc/images/juddi-gui-browse-business2.png b/src/site/resources/images/juddi-gui-browse-business2.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-browse-business2.png
rename to src/site/resources/images/juddi-gui-browse-business2.png
diff --git a/docs/asciidoc/images/juddi-gui-browse-options.png b/src/site/resources/images/juddi-gui-browse-options.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-browse-options.png
rename to src/site/resources/images/juddi-gui-browse-options.png
diff --git a/docs/asciidoc/images/juddi-gui-browse-services.png b/src/site/resources/images/juddi-gui-browse-services.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-browse-services.png
rename to src/site/resources/images/juddi-gui-browse-services.png
diff --git a/docs/asciidoc/images/juddi-gui-browse-tmodel.png b/src/site/resources/images/juddi-gui-browse-tmodel.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-browse-tmodel.png
rename to src/site/resources/images/juddi-gui-browse-tmodel.png
diff --git a/docs/asciidoc/images/juddi-gui-create-business.png b/src/site/resources/images/juddi-gui-create-business.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-create-business.png
rename to src/site/resources/images/juddi-gui-create-business.png
diff --git a/docs/asciidoc/images/juddi-gui-create-business2.png b/src/site/resources/images/juddi-gui-create-business2.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-create-business2.png
rename to src/site/resources/images/juddi-gui-create-business2.png
diff --git a/docs/asciidoc/images/juddi-gui-create-business3.png b/src/site/resources/images/juddi-gui-create-business3.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-create-business3.png
rename to src/site/resources/images/juddi-gui-create-business3.png
diff --git a/docs/asciidoc/images/juddi-gui-fullbootstrap-menu.png b/src/site/resources/images/juddi-gui-fullbootstrap-menu.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-fullbootstrap-menu.png
rename to src/site/resources/images/juddi-gui-fullbootstrap-menu.png
diff --git a/docs/asciidoc/images/juddi-gui-import-wsdl.png b/src/site/resources/images/juddi-gui-import-wsdl.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-import-wsdl.png
rename to src/site/resources/images/juddi-gui-import-wsdl.png
diff --git a/docs/asciidoc/images/juddi-gui-login-warning.png b/src/site/resources/images/juddi-gui-login-warning.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-login-warning.png
rename to src/site/resources/images/juddi-gui-login-warning.png
diff --git a/docs/asciidoc/images/juddi-gui-menu.png b/src/site/resources/images/juddi-gui-menu.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-menu.png
rename to src/site/resources/images/juddi-gui-menu.png
diff --git a/docs/asciidoc/images/juddi-gui-mybuz.png b/src/site/resources/images/juddi-gui-mybuz.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-mybuz.png
rename to src/site/resources/images/juddi-gui-mybuz.png
diff --git a/docs/asciidoc/images/juddi-gui-nodeswitcher.png b/src/site/resources/images/juddi-gui-nodeswitcher.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-nodeswitcher.png
rename to src/site/resources/images/juddi-gui-nodeswitcher.png
diff --git a/docs/asciidoc/images/juddi-gui-publisherassertion.png b/src/site/resources/images/juddi-gui-publisherassertion.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-publisherassertion.png
rename to src/site/resources/images/juddi-gui-publisherassertion.png
diff --git a/docs/asciidoc/images/juddi-gui-publisherassertion2.png b/src/site/resources/images/juddi-gui-publisherassertion2.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-publisherassertion2.png
rename to src/site/resources/images/juddi-gui-publisherassertion2.png
diff --git a/docs/asciidoc/images/juddi-gui-publisherassertion3.png b/src/site/resources/images/juddi-gui-publisherassertion3.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-publisherassertion3.png
rename to src/site/resources/images/juddi-gui-publisherassertion3.png
diff --git a/docs/asciidoc/images/juddi-gui-search.png b/src/site/resources/images/juddi-gui-search.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-search.png
rename to src/site/resources/images/juddi-gui-search.png
diff --git a/docs/asciidoc/images/juddi-gui-service-add1.png b/src/site/resources/images/juddi-gui-service-add1.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-service-add1.png
rename to src/site/resources/images/juddi-gui-service-add1.png
diff --git a/docs/asciidoc/images/juddi-gui-service-add2.png b/src/site/resources/images/juddi-gui-service-add2.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-service-add2.png
rename to src/site/resources/images/juddi-gui-service-add2.png
diff --git a/docs/asciidoc/images/juddi-gui-sign1.png b/src/site/resources/images/juddi-gui-sign1.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-sign1.png
rename to src/site/resources/images/juddi-gui-sign1.png
diff --git a/docs/asciidoc/images/juddi-gui-sign2.png b/src/site/resources/images/juddi-gui-sign2.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-sign2.png
rename to src/site/resources/images/juddi-gui-sign2.png
diff --git a/docs/asciidoc/images/juddi-gui-signed-invalid.png b/src/site/resources/images/juddi-gui-signed-invalid.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-signed-invalid.png
rename to src/site/resources/images/juddi-gui-signed-invalid.png
diff --git a/docs/asciidoc/images/juddi-gui-signed-valid.png b/src/site/resources/images/juddi-gui-signed-valid.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-signed-valid.png
rename to src/site/resources/images/juddi-gui-signed-valid.png
diff --git a/docs/asciidoc/images/juddi-gui-signerpanel1.png b/src/site/resources/images/juddi-gui-signerpanel1.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-signerpanel1.png
rename to src/site/resources/images/juddi-gui-signerpanel1.png
diff --git a/docs/asciidoc/images/juddi-gui-signerpanel2.png b/src/site/resources/images/juddi-gui-signerpanel2.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-signerpanel2.png
rename to src/site/resources/images/juddi-gui-signerpanel2.png
diff --git a/docs/asciidoc/images/juddi-gui-signerpanel3.png b/src/site/resources/images/juddi-gui-signerpanel3.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-signerpanel3.png
rename to src/site/resources/images/juddi-gui-signerpanel3.png
diff --git a/docs/asciidoc/images/juddi-gui-subscription-view.png b/src/site/resources/images/juddi-gui-subscription-view.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-subscription-view.png
rename to src/site/resources/images/juddi-gui-subscription-view.png
diff --git a/docs/asciidoc/images/juddi-gui-subscription1.png b/src/site/resources/images/juddi-gui-subscription1.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-subscription1.png
rename to src/site/resources/images/juddi-gui-subscription1.png
diff --git a/docs/asciidoc/images/juddi-gui-subscription2.png b/src/site/resources/images/juddi-gui-subscription2.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-subscription2.png
rename to src/site/resources/images/juddi-gui-subscription2.png
diff --git a/docs/asciidoc/images/juddi-gui-subscription2a.png b/src/site/resources/images/juddi-gui-subscription2a.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-subscription2a.png
rename to src/site/resources/images/juddi-gui-subscription2a.png
diff --git a/docs/asciidoc/images/juddi-gui-subscription3.png b/src/site/resources/images/juddi-gui-subscription3.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-subscription3.png
rename to src/site/resources/images/juddi-gui-subscription3.png
diff --git a/docs/asciidoc/images/juddi-gui-subscription4.png b/src/site/resources/images/juddi-gui-subscription4.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-subscription4.png
rename to src/site/resources/images/juddi-gui-subscription4.png
diff --git a/docs/asciidoc/images/juddi-gui-subscription5.png b/src/site/resources/images/juddi-gui-subscription5.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-subscription5.png
rename to src/site/resources/images/juddi-gui-subscription5.png
diff --git a/docs/asciidoc/images/juddi-gui-subscription6.png b/src/site/resources/images/juddi-gui-subscription6.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-subscription6.png
rename to src/site/resources/images/juddi-gui-subscription6.png
diff --git a/docs/asciidoc/images/juddi-gui-tabletbootstrap-menu.png b/src/site/resources/images/juddi-gui-tabletbootstrap-menu.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-tabletbootstrap-menu.png
rename to src/site/resources/images/juddi-gui-tabletbootstrap-menu.png
diff --git a/docs/asciidoc/images/juddi-gui-tmodel-keygen.png b/src/site/resources/images/juddi-gui-tmodel-keygen.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-tmodel-keygen.png
rename to src/site/resources/images/juddi-gui-tmodel-keygen.png
diff --git a/docs/asciidoc/images/juddi-gui-transfer.png b/src/site/resources/images/juddi-gui-transfer.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-transfer.png
rename to src/site/resources/images/juddi-gui-transfer.png
diff --git a/docs/asciidoc/images/juddi-gui-welcome.png b/src/site/resources/images/juddi-gui-welcome.png
similarity index 100%
rename from docs/asciidoc/images/juddi-gui-welcome.png
rename to src/site/resources/images/juddi-gui-welcome.png
diff --git a/docs/asciidoc/images/marketing_node_installation.png b/src/site/resources/images/marketing_node_installation.png
similarity index 100%
rename from docs/asciidoc/images/marketing_node_installation.png
rename to src/site/resources/images/marketing_node_installation.png
diff --git a/docs/asciidoc/images/marketing_services.png b/src/site/resources/images/marketing_services.png
similarity index 100%
rename from docs/asciidoc/images/marketing_services.png
rename to src/site/resources/images/marketing_services.png
diff --git a/docs/asciidoc/images/newly_saved_subscription.png b/src/site/resources/images/newly_saved_subscription.png
similarity index 100%
rename from docs/asciidoc/images/newly_saved_subscription.png
rename to src/site/resources/images/newly_saved_subscription.png
diff --git a/docs/asciidoc/images/raw_XML_response_synchronous_subscription_request.png b/src/site/resources/images/raw_XML_response_synchronous_subscription_request.png
similarity index 100%
rename from docs/asciidoc/images/raw_XML_response_synchronous_subscription_request.png
rename to src/site/resources/images/raw_XML_response_synchronous_subscription_request.png
diff --git a/docs/asciidoc/images/registration_by_annotation.png b/src/site/resources/images/registration_by_annotation.png
similarity index 100%
rename from docs/asciidoc/images/registration_by_annotation.png
rename to src/site/resources/images/registration_by_annotation.png
diff --git a/docs/asciidoc/images/registry_info_helloworld.png b/src/site/resources/images/registry_info_helloworld.png
similarity index 100%
rename from docs/asciidoc/images/registry_info_helloworld.png
rename to src/site/resources/images/registry_info_helloworld.png
diff --git a/docs/asciidoc/images/sales_node_installation.png b/src/site/resources/images/sales_node_installation.png
similarity index 100%
rename from docs/asciidoc/images/sales_node_installation.png
rename to src/site/resources/images/sales_node_installation.png
diff --git a/docs/asciidoc/images/sales_services.png b/src/site/resources/images/sales_services.png
similarity index 100%
rename from docs/asciidoc/images/sales_services.png
rename to src/site/resources/images/sales_services.png
diff --git a/docs/asciidoc/images/set_coverage_period.png b/src/site/resources/images/set_coverage_period.png
similarity index 100%
rename from docs/asciidoc/images/set_coverage_period.png
rename to src/site/resources/images/set_coverage_period.png
diff --git a/docs/asciidoc/images/subscriptions_portal.png b/src/site/resources/images/subscriptions_portal.png
similarity index 100%
rename from docs/asciidoc/images/subscriptions_portal.png
rename to src/site/resources/images/subscriptions_portal.png
diff --git a/docs/asciidoc/images/uddi_core_datastructures.gif b/src/site/resources/images/uddi_core_datastructures.gif
similarity index 100%
rename from docs/asciidoc/images/uddi_core_datastructures.gif
rename to src/site/resources/images/uddi_core_datastructures.gif
diff --git a/src/site/site.xml b/src/site/site.xml
index 7ae956838..f4685f9c7 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -83,7 +83,45 @@
<item name="Javadocs v3" href="apidocs/index.html"/>
<item name="XRef v3" href="xref/index.html"/>
<item name="jUDDI Blog" href="http://apachejuddi.blogspot.com/" />
+
+ <item name="Client Guide">
+
+ <item name="Introduction" href="ClientGuide.html"/>
+ <item name="Simple Publishing" href="ClientGuideSimplePublishingUsingthejUDDIAPI.html"/>
+ <item name="Client Config Guide" href="ClientGuidejUDDIClientConfigurationGuide.html"/>
+ <item name="Key Formats" href="ClientGuideKeyFormatTemplates.html"/>
+ <item name="Using the jUDDI GUI" href="ClientGuideUsingthejUDDIGUI.html"/>
+ <item name="WADL and WSDL to UDDI" href="ClientGuideMappingWADLandWSDLtoUDDI.html"/>
+ <item name="UDDI Annotations" href="ClientGuideUsingUDDIAnnotationstoAutomateRegistration.html"/>
+ <item name="UDDI v2 Services" href="ClientGuideUDDIv2Services.html"/>
+ <item name="UDDI Migration Tool" href="ClientGuideUDDIMigrationTool.html"/>
+ <item name="jUDDI REST Services" href="ClientGuideUsingjUDDIRestServices.html"/>
+ <item name="jUDDI for .NET" href="ClientGuidejUDDIClientforNET.html"/>
+ <item name="TCK Runner" href="ClientGuideTCKRunner.html"/>
+
+ </item>
+
+ <item name="Admin Guide">
+ <item name="UDDI Registry Introduction" href="Guide.html"/>
+ <item name="UDDI Registry Introduction" href="GuideUDDIRegistryIntroduction.html"/>
+ <item name="Getting Started" href="GuideGettingStarted.html"/>
+ <item name="Architecture" href="GuideArchitecture.html"/>
+ <item name="Administration" href="GuideAdministration.html"/>
+ <item name="Server Configuration" href="GuideConfigurationServer.html"/>
+ <item name="Replication" href="GuideReplication.html"/>
+ <item name="Root Seed Data" href="GuideRootSeedData.html"/>
+ <item name="How to Deploy jUDDI" href="GuideHowToDeployjUDDITo.html"/>
+ <item name="Extending jUDDI" href="GuideExtendingUDDI.html"/>
+ <item name="Troubleshooting jUDDI" href="GuideTroubleshootingjUDDI.html"/>
+ <item name="Contributing to jUDDI" href="GuideContributingtojUDDI.html"/>
+ <item name="UDDI Subscriptions" href="GuideUDDISubscriptions.html"/>
+ <item name="Digital Signatures in UDDI" href="GuideUsingDigitalSignaturesinUDDI.html"/>
+
+ </item>
+
</menu>
+
+
<menu name="Subprojects">
<item name="Apache Scout" href="http://juddi.apache.org/scout/" />
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org