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/09/25 18:55:02 UTC
[juddi] branch feature/JUDDI-978 updated: JUDDI-1020 resolves all known formating and packaging issues with maven pdf plugin switch (from docbook)
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
The following commit(s) were added to refs/heads/feature/JUDDI-978 by this push:
new 76d055283 JUDDI-1020 resolves all known formating and packaging issues with maven pdf plugin switch (from docbook)
76d055283 is described below
commit 76d055283912aaad65dd1d1bac4ebc5d9f6c18e7
Author: Alex O'Ree <al...@apache.org>
AuthorDate: Sun Sep 25 14:54:56 2022 -0400
JUDDI-1020 resolves all known formating and packaging issues with maven pdf plugin switch (from docbook)
---
juddi-dist/pom.xml | 7 ++
juddi-dist/src/main/assembly/assembly.xml | 14 ++-
pom.xml | 29 +++++
src/site/markdown/ClientGuideKeyFormatTemplates.md | 22 ++--
.../ClientGuideMappingWADLandWSDLtoUDDI.md | 31 +++--
.../ClientGuideSimplePublishingUsingthejUDDIAPI.md | 38 +++---
src/site/markdown/ClientGuideTCKRunner.md | 4 +-
src/site/markdown/ClientGuideUDDIMigrationTool.md | 75 +++++++-----
src/site/markdown/ClientGuideUDDIv2Services.md | 8 +-
...deUsingUDDIAnnotationstoAutomateRegistration.md | 25 ++--
.../markdown/ClientGuideUsingjUDDIRestServices.md | 88 ++------------
.../ClientGuidejUDDIClientConfigurationGuide.md | 96 ++++++++++-----
src/site/markdown/ClientGuidejUDDIClientforNET.md | 28 ++---
src/site/markdown/GuideAdministration.md | 129 ++++++++++++++-------
src/site/markdown/GuideContributingtojUDDI.md | 3 +-
src/site/markdown/GuideHowToDeployjUDDITo.md | 61 ++++++----
src/site/markdown/GuideReplication.md | 96 +++++++++++----
src/site/markdown/GuideRootSeedData.md | 74 ++++++++----
src/site/markdown/GuideTroubleshootingjUDDI.md | 12 +-
src/site/markdown/GuideUDDISubscriptions.md | 96 ++++++++-------
uddi-client-dist/pom.xml | 7 ++
uddi-client-dist/src/main/assembly/assembly.xml | 36 +++---
22 files changed, 603 insertions(+), 376 deletions(-)
diff --git a/juddi-dist/pom.xml b/juddi-dist/pom.xml
index 7ea0805cd..907d2f9b2 100644
--- a/juddi-dist/pom.xml
+++ b/juddi-dist/pom.xml
@@ -53,6 +53,13 @@
<groupId>org.apache.juddi</groupId>
<artifactId>uddi-ws</artifactId>
<version>${project.parent.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.juddi</groupId>
+ <artifactId>juddi-parent</artifactId>
+ <version>${project.parent.version}</version>
+ <classifier>server</classifier>
+ <type>pdf</type>
</dependency>
<dependency>
<groupId>org.apache.juddi</groupId>
diff --git a/juddi-dist/src/main/assembly/assembly.xml b/juddi-dist/src/main/assembly/assembly.xml
index e4a52b280..d495c7db7 100644
--- a/juddi-dist/src/main/assembly/assembly.xml
+++ b/juddi-dist/src/main/assembly/assembly.xml
@@ -100,7 +100,7 @@
<dependencySet>
<outputDirectory>docs</outputDirectory>
<includes>
- <include>org.apache.juddi.juddi-docs:juddi-docs-dist:zip</include>
+ <include>org.apache.juddi:juddi-docs:juddi-docs-dist:zip</include>
</includes>
<unpack>true</unpack>
<useProjectArtifact>false</useProjectArtifact>
@@ -110,6 +110,8 @@
<directoryMode>0755</directoryMode>
<fileMode>0755</fileMode>
</dependencySet>
+
+
<dependencySet>
<outputDirectory>docs/javadoc</outputDirectory>
@@ -156,6 +158,16 @@
<include>LICENSE</include>
</includes>
</fileSet>
+ <fileSet>
+ <directory>../target/site</directory>
+ <outputDirectory>docs</outputDirectory>
+ <filtered>false</filtered>
+ <directoryMode>0755</directoryMode>
+ <fileMode>0755</fileMode>
+ <includes>
+ <include>juddi-server-guide.pdf</include>
+ </includes>
+ </fileSet>
<fileSet>
<directory>../juddi-examples</directory>
<outputDirectory>examples</outputDirectory>
diff --git a/pom.xml b/pom.xml
index 19645b50d..349d378e4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -538,6 +538,35 @@ under the License.
</executions>
</plugin>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>build-helper-maven-plugin</artifactId>
+ <version>3.3.0</version>
+ <executions>
+ <execution>
+ <id>attach-artifact</id>
+ <phase>compile</phase>
+ <goals>
+ <goal>attach-artifact</goal>
+ </goals>
+ <configuration>
+ <artifacts>
+ <artifact>
+ <file>target/site/juddi-server-guide.pdf</file>
+ <type>pdf</type>
+ <classifier>server</classifier>
+ </artifact>
+ <artifact>
+ <file>target/site/juddi-client-guide.pdf</file>
+ <type>pdf</type>
+ <classifier>client</classifier>
+ </artifact>
+ </artifacts>
+ <runOnlyAtExecutionRoot>true</runOnlyAtExecutionRoot>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
diff --git a/src/site/markdown/ClientGuideKeyFormatTemplates.md b/src/site/markdown/ClientGuideKeyFormatTemplates.md
index 4b9e31c0e..a9ef450c7 100644
--- a/src/site/markdown/ClientGuideKeyFormatTemplates.md
+++ b/src/site/markdown/ClientGuideKeyFormatTemplates.md
@@ -23,7 +23,8 @@ 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}
+uddi:${keyDomain}:\
+ binding_${serverName}_${serviceName}_${portName}_${serverPort}
````
where tokens are expressed using `${}`. The templates are defined in the UDDIKeyConvention class.
@@ -33,15 +34,19 @@ where tokens are expressed using `${}`. The templates are defined in the UDDIKey
At runtime a serviceKey can be obtained using
````
-String serviceKey = UDDIKeyConvention.getServiceKey(properties, serviceName);
+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}`;
-properties.add(Property.SERVICE_KEY_FORMAT, myCustomServiceFormat);
-String myCustomFormattedServiceKey = UDDIKeyConvention.getServiceKey(properties, 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?
@@ -69,8 +74,11 @@ You can define the properties in your code, or you can obtain and pass in the pr
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/src/site/markdown/ClientGuideMappingWADLandWSDLtoUDDI.md b/src/site/markdown/ClientGuideMappingWADLandWSDLtoUDDI.md
index 7504c0953..846d503ec 100644
--- a/src/site/markdown/ClientGuideMappingWADLandWSDLtoUDDI.md
+++ b/src/site/markdown/ClientGuideMappingWADLandWSDLtoUDDI.md
@@ -20,18 +20,24 @@ properties.put("businessName", domain);
properties.put("serverName", url.getHost());
properties.put("serverPort", url.getPort());
wsdlURL = wsdlDefinition.getDocumentBaseURI();
-WSDL2UDDI wsdl2UDDI = new WSDL2UDDI(null, new URLLocalizerDefaultImpl(), properties);
+WSDL2UDDI wsdl2UDDI = new WSDL2UDDI(null, new
+ URLLocalizerDefaultImpl(), properties);
//This creates a the services from WSDL
-BusinessServices businessServices = wsdl2UDDI.createBusinessServices(wsdlDefinition);
+BusinessServices businessServices =
+ wsdl2UDDI.createBusinessServices(wsdlDefinition);
//This creates the tModels from WSDL
-Map<QName, PortType> portTypes = (Map<QName, PortType>) wsdlDefinition.getAllPortTypes();
+Map<QName, PortType> portTypes =
+ (Map<QName, PortType>) wsdlDefinition.getAllPortTypes();
//This creates more tModels from WSDL
-Set<TModel> portTypeTModels = wsdl2UDDI.createWSDLPortTypeTModels(wsdlURL, portTypes);
+Set<TModel> portTypeTModels =
+ wsdl2UDDI.createWSDLPortTypeTModels(wsdlURL, portTypes);
Map allBindings = wsdlDefinition.getAllBindings();
//This creates even more tModels from WSDL
-Set<TModel> createWSDLBindingTModels = wsdl2UDDI.createWSDLBindingTModels(wsdlURL, allBindin
+Set<TModel> createWSDLBindingTModels =
+ wsdl2UDDI.createWSDLBindingTModels(wsdlURL, allBindin
-//Now just save the tModels, then add the services to a new or existing business
+//Now just save the tModels, then add the services to a new or
+//existing business
````
@@ -60,13 +66,18 @@ properties.put("keyDomain", domain);
properties.put("businessName", domain);
properties.put("serverName", url.getHost());
properties.put("serverPort", url.getPort());
-WADL2UDDI wadl2UDDI = new WADL2UDDI(null, new URLLocalizerDefaultImpl(), properties);
+WADL2UDDI wadl2UDDI = new WADL2UDDI(null,
+ new URLLocalizerDefaultImpl(), properties);
//creates the services
-BusinessService businessServices = wadl2UDDI.createBusinessService(new QName("MyWasdl.namespace", "Servicename"), app);
+BusinessService businessServices =
+ wadl2UDDI.createBusinessService(
+ new QName("MyWasdl.namespace", "Servicename"), app);
//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
+Set<TModel> portTypeTModels =
+ wadl2UDDI.createWADLPortTypeTModels(wsdlURL, app);
+//Now just save the tModels, then add the services to a new or
+//existing business
````
diff --git a/src/site/markdown/ClientGuideSimplePublishingUsingthejUDDIAPI.md b/src/site/markdown/ClientGuideSimplePublishingUsingthejUDDIAPI.md
index 9ea11bb6a..dedcc04d5 100644
--- a/src/site/markdown/ClientGuideSimplePublishingUsingthejUDDIAPI.md
+++ b/src/site/markdown/ClientGuideSimplePublishingUsingthejUDDIAPI.md
@@ -97,10 +97,14 @@ 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!");
+ //your username
+ getAuthTokenMyPub.setUserID("bob");
+ //your password
+ getAuthTokenMyPub.setCred("bob");
+ 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.
@@ -120,7 +124,8 @@ 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
+// 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);
@@ -129,7 +134,8 @@ 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
+// 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);
@@ -137,9 +143,11 @@ 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>
+// <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
+// Adding the service to the "save" structure, using our
+//publisher's authentication info and
// saving away.
SaveService ss = new SaveService();
ss.getBusinessService().add(myService);
@@ -149,7 +157,8 @@ 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()));
+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.
@@ -171,7 +180,7 @@ public SimplePublishClerk() {
//get the clerk
clerk = uddiClient.getClerk("default");
if (clerk==null)
- throw new Exception("the clerk wasn't found, check the config file!");
+ throw new Exception("the clerk wasn't found, check the config file!");
} catch (Exception e) {
e.printStackTrace();
}
@@ -191,14 +200,17 @@ 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.
+ // 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>
+ //<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!
+ //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();
diff --git a/src/site/markdown/ClientGuideTCKRunner.md b/src/site/markdown/ClientGuideTCKRunner.md
index eb4d6115a..574835f90 100644
--- a/src/site/markdown/ClientGuideTCKRunner.md
+++ b/src/site/markdown/ClientGuideTCKRunner.md
@@ -46,7 +46,9 @@ The only parts used from uddi.xml are the following
Executing the TCK runner is simple.
````
-java (options) -Duddi.client.xml=uddi.xml -jar juddi-tck-runner-{VERSION}-SNAPSHOT-jar-with-dependencies.jar
+java (options) \
+ -Duddi.client.xml=uddi.xml -jar \
+ juddi-tck-runner-{VERSION}-jar-with-dependencies.jar
````
Optional parameters
diff --git a/src/site/markdown/ClientGuideUDDIMigrationTool.md b/src/site/markdown/ClientGuideUDDIMigrationTool.md
index 19c88837f..2325df3aa 100644
--- a/src/site/markdown/ClientGuideUDDIMigrationTool.md
+++ b/src/site/markdown/ClientGuideUDDIMigrationTool.md
@@ -29,36 +29,45 @@ There are many configuration options and settings for the migration tool. This t
#### 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.
-
-usage: java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar
- -business <arg> Im/Export option, file to store the business data,
- default is 'business-export.xml'
- -config <arg> Use an alternate config file default is 'uddi.xml'
- -credFile <arg> Import option with -preserveOwnership, this is a
- properties file mapping with user=pass
+>java -jar \
+ juddi-migration-tool-<VERSION>-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.
+
+usage: java -jar
+ juddi-migration-tool-(VERSION)-jar-with-dependencies.jar
+ -business <arg> Im/Export option, file to store the business
+ data, default is 'business-export.xml'
+ -config <arg> Use an alternate config file default is
+ 'uddi.xml'
+ -credFile <arg> Import option with -preserveOwnership, this
+ is a properties file mapping with user=pass
-export Exports data into a UDDIv3 registry
-import Imports data into a UDDIv3 registry
- -isJuddi Is this a jUDDI registry? If so we can in/export
- more stuff
- -mappings <arg> Im/Export option, file that maps keys to owners,
- default is 'entityusermappings.properties'
- -myItemsOnly Export option, Only export items owned by yourself
- -node <arg> The node 'name' in the config, default is 'default'
- -pass <arg> Password, if not defined, those is uddi.xml will be
- used
+ -isJuddi Is this a jUDDI registry? If so we can
+ in/export more stuff
+ -mappings <arg> Im/Export option, file that maps keys to
+ owners, default is
+ 'entityusermappings.properties'
+ -myItemsOnly Export option, Only export items owned by
+ yourself
+ -node <arg> The node 'name' in the config, default is
+ 'default'
+ -pass <arg> Password, if not defined, those is uddi.xml
+ will be used
-preserveOwnership Im/Export option, saves owership data to the
'mappings' file
-publishers <arg> jUDDI only - In/Export option, file to store
- publishers, default is 'publishers-export.xml'
- -stripSignatures Im/Export option, removes digital signatures from
- all signed items, default is false
- -tmodel <arg> Im/Export for tmodels, file to store tmodel data,
- default is 'tmodel-export.xml'
- -user <arg> Username, if not defined, those is uddi.xml will be
- used
+ publishers, default is
+ 'publishers-export.xml'
+ -stripSignatures Im/Export option, removes digital signatures
+ from all signed items, default is false
+ -tmodel <arg> Im/Export for tmodels, file to store tmodel
+ data, default is 'tmodel-export.xml'
+ -user <arg> Username, if not defined, those is uddi.xml
+ will be used
````
#### Use case: basic import and export
@@ -66,13 +75,17 @@ usage: java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar
To export everything without preserving ownership information:
````
-java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar -export
+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
+java -jar \
+ juddi-migration-tool-(VERSION)-jar-with-dependencies.jar \
+ -import
````
#### Use case: Import and Export while preserving ownership information
@@ -80,13 +93,17 @@ java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar -import
To export everything with preserving ownership information:
````
-java -jar juddi-migration-tool-(VERSION)-jar-with-dependencies.jar -export -preserveOwnership
+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
+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/src/site/markdown/ClientGuideUDDIv2Services.md b/src/site/markdown/ClientGuideUDDIv2Services.md
index 1b17c93f2..966ea0a1f 100644
--- a/src/site/markdown/ClientGuideUDDIv2Services.md
+++ b/src/site/markdown/ClientGuideUDDIv2Services.md
@@ -25,9 +25,13 @@ The jUDDI v3 client now contains the UDDI 2 web service clients. Although, there
````
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");
+((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");
+((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:
diff --git a/src/site/markdown/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.md b/src/site/markdown/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.md
index c9a67f93b..9d26977f8 100644
--- a/src/site/markdown/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.md
+++ b/src/site/markdown/ClientGuideUsingUDDIAnnotationstoAutomateRegistration.md
@@ -47,10 +47,12 @@ import org.apache.juddi.v3.annotations.UDDIServiceBinding;
description = "Hello World test service")
@UDDIServiceBinding(
bindingKey="uddi:myServiceBindingKey",
- description="WSDL endpoint for the helloWorld Service. This service is used for "
+ description="WSDL endpoint for the helloWorld Service. This \
+ service is used for "
+ "testing the jUDDI annotation functionality",
accessPointType="wsdlDeployment",
- accessPoint="http://localhost:8080/juddiv3-samples/services/helloworld?wsdl")
+ accessPoint=
+ "http://localhost:8080/juddiv3-samples/services/helloworld?wsdl")
@WebService(
endpointInterface = "org.apache.juddi.samples.HelloWorld",
serviceName = "HelloWorld")
@@ -64,7 +66,8 @@ public class HelloWorldImpl implements HelloWorld {
````
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">
+<clerk name="BobCratchit" node="default" publisher="sales"
+ password="sales">
<class>org.apache.juddi.samples.HelloWorldImpl</class>
</clerk>
````
@@ -83,7 +86,8 @@ client/clerks@registerOnStartup="true"
Here's a full example
````
<clerks registerOnStartup="false" >
- <clerk name="default" node="default" publisher="userjoe" password="******" cryptoProvider="" isPasswordEncrypted="false">
+ <clerk name="default" node="default" publisher="userjoe"
+ password="******" cryptoProvider="" isPasswordEncrypted="false">
<class>com.mybiz.services.Service1</class>
</clerk>
</clerks>
@@ -101,7 +105,8 @@ Clients that run elsewhere simply need to "start" the UDDIClient.
UDDIClient clerkManager = new UDDIClient("META-INF/uddi.xml");
// register the clerkManager with the client side container
UDDIClientContainer.addClient(clerkManager);
-clerkManager.start(); //will create business/services/bindings as necessary
+clerkManager.start();
+//will create business/services/bindings as necessary
//shutdown down
clerkManager.stop(); //will unregister binding templates
@@ -139,10 +144,12 @@ The CategoryBag attribute allows you to reference tModels. For example the follo
````
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",
+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
diff --git a/src/site/markdown/ClientGuideUsingjUDDIRestServices.md b/src/site/markdown/ClientGuideUsingjUDDIRestServices.md
index 23329c267..dacc089a3 100644
--- a/src/site/markdown/ClientGuideUsingjUDDIRestServices.md
+++ b/src/site/markdown/ClientGuideUsingjUDDIRestServices.md
@@ -21,9 +21,11 @@ TIP: All of the examples in this document reference JSON encoded messages. To sw
Each method is accessible using the following pattern:
````
-http://localhost:8080/juddiv3/services/inquiryRest/{encoding}/{method}/{parameters}
+http://localhost:8080/juddiv3/services/inquiryRest/{encoding}/\
+ {method}/{parameters}
//or
-http://localhost:8080/juddiv3/services/inquiryRest/{encoding}/{method}?{name=value}
+http://localhost:8080/juddiv3/services/inquiryRest/{encoding}/\
+ {method}?{name=value}
````
Notes
@@ -46,7 +48,8 @@ Returns all executable endpoints for a given service key, including all binding
Example:
````
-http://localhost:8080/juddiv3/services/inquiryRest/JSON/endpointsByService/uddi:juddi.apache.org:services-custodytransfer
+http://localhost:8080/juddiv3/services/inquiryRest/JSON/\
+ endpointsByService/uddi:juddi.apache.org:services-custodytransfer
````
##### getDetail
@@ -56,7 +59,8 @@ Return the details of a specific item using query parameters. This implements th
Example:
````
-http://localhost:8080/juddiv3/services/inquiryRest/XML/getDetail?businessKey=uddi:juddi.apache.org:businesses-asf
+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
@@ -123,80 +127,12 @@ The output of JSON encoded messages is obviously different than XML. The followi
},
"description": {
"@xml.lang": "en",
- "$": "This is a UDDI v3 registry node as implemented by Apache jUDDI."
+ "$": "This is a UDDI v3 registry node as implemented \
+ by Apache jUDDI."
},
"businessServices": {
- "businessService": [
- {
- "@serviceKey": "uddi:juddi.apache.org:services-custodytransfer",
- "@businessKey": "uddi:juddi.apache.org:businesses-asf",
- "name": {
- "@xml.lang": "en",
- "$": "UDDI Custody and Ownership Transfer Service"
- },
- "description": {
- "@xml.lang": "en",
- "$": "Web Service supporting UDDI Custody and Ownership Transfer API"
- },
- "bindingTemplates": {
- "bindingTemplate": [
- {
- "@bindingKey": "uddi:juddi.apache.org:servicebindings-custodytransfer-ws",
- "@serviceKey": "uddi:juddi.apache.org:services-custodytransfer",
- "description": "UDDI Custody and Ownership Transfer API V3",
- "accessPoint": {
- "@useType": "wsdlDeployment",
- "$": "http://localhost:8080/juddiv3/services/custody-transfer?wsdl"
- },
- "tModelInstanceDetails": {
- "tModelInstanceInfo": {
- "@tModelKey": "uddi:uddi.org:v3_ownership_transfer",
- "instanceDetails": {
- "instanceParms": "\n \n <?xml version=\"1.0\" encoding=\"utf-8\" ?>\n <UDDIinstanceParmsContainer\n xmlns=\"urn:uddi-org:policy_v3_instanceParms\">\n <authInfoUse>required</authInfoUse>\n </UDDIinstanceParmsContainer>\n \n "
- }
- }
- },
- "categoryBag": {
- "keyedReference": {
- "@tModelKey": "uddi:uddi.org:categorization:types",
- "@keyName": "uddi-org:types:wsdl",
- "@keyValue": "wsdlDeployment"
- }
- }
- },
- {
- "@bindingKey": "uddi:juddi.apache.org:servicebindings-custodytransfer-ws-ssl",
- "@serviceKey": "uddi:juddi.apache.org:services-custodytransfer",
- "description": "UDDI Custody and Ownership Transfer API V3 SSL",
- "accessPoint": {
- "@useType": "wsdlDeployment",
- "$": "https://localhost:8443/juddiv3/services/custody-transfer?wsdl"
- },
- "tModelInstanceDetails": {
- "tModelInstanceInfo": [
- {
- "@tModelKey": "uddi:uddi.org:v3_ownership_transfer",
- "instanceDetails": {
- "instanceParms": "\n \n <?xml version=\"1.0\" encoding=\"utf-8\" ?>\n <UDDIinstanceParmsContainer\n xmlns=\"urn:uddi-org:policy_v3_instanceParms\">\n <authInfoUse>required</authInfoUse>\n </UDDIinstanceParmsContainer>\n \n "
- }
- },
- {
- "@tModelKey": "uddi:uddi.org:protocol:serverauthenticatedssl3"
- }
- ]
- },
- "categoryBag": {
- "keyedReference": {
- "@tModelKey": "uddi:uddi.org:categorization:types",
- "@keyName": "uddi-org:types:wsdl",
- "@keyValue": "wsdlDeployment"
- }
- }
- }
- ]
- }
- }
- ]
+ "businessService": [ ... ]
+
},
"categoryBag": {
"keyedReference": {
diff --git a/src/site/markdown/ClientGuidejUDDIClientConfigurationGuide.md b/src/site/markdown/ClientGuidejUDDIClientConfigurationGuide.md
index 7bd2348cd..025450189 100644
--- a/src/site/markdown/ClientGuidejUDDIClientConfigurationGuide.md
+++ b/src/site/markdown/ClientGuidejUDDIClientConfigurationGuide.md
@@ -26,17 +26,22 @@ uddi/client@name="someName"
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 -->
+<!-- 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 -->
uddi/client/nodes[]/node/name
<!-- the description of the node -->
uddi/client/nodes[]/node/description
-<!-- the properties section defines HTTP style credentials and a runtime tokenizer for URLs -->
+<!-- the properties section defines HTTP style credentials and a
+runtime tokenizer for URLs -->
uddi/client/nodes[]/node/properties
-<!-- The transport represents the class name of the transport mechanism that the client will use to connect
-to the UDDI node. The most commonly used is org.apache.juddi.v3.client.transport.JAXWSTransport, however
-RMITransport, InVMTransport and JAXWSv2TranslationTransport are also defined -->
+<!-- The transport represents the class name of the transport
+ mechanism that the client will use to connect
+to the UDDI node. The most commonly used is
+org.apache.juddi.v3.client.transport.JAXWSTransport, however
+RMITransport, InVMTransport and JAXWSv2TranslationTransport are
+also defined -->
uddi/client/nodes[]/node/proxyTransport
<!-- endpoint URLs -->
@@ -46,7 +51,8 @@ uddi/client/nodes[]/node/publishUrl
uddi/client/nodes[]/node/securityUrl
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 -->
+<!-- note: this is for jUDDI v3.x servers only and is not part
+ of the UDDI standard -->
uddi/client/nodes[]/node/juddiApiUrl
````
@@ -65,7 +71,9 @@ JAXWSv2TranslationTransport is a bridge for accessing UDDIv2 web services using
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.-->
+<!-- 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
````
@@ -74,9 +82,12 @@ uddi/client/clerks/registerOnStartup=true/false
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
+<!-- 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
uddi/client/clerks[]/clerk@publisher - This is the username
uddi/client/clerks[]/clerk@password
uddi/client/clerks[]/clerk@isPasswordEncrypted=true/false
@@ -86,8 +97,10 @@ 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" />
+<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.
@@ -105,7 +118,8 @@ The Signature section contains settings that map to the Digital Signature Utilit
````
uddi/client/signature/signingKeyStorePath
uddi/client/signature/signingKeyStoreFilePassword
-uddi/client/signature/signingKeyStoreFilePassword@isPasswordEncrypted
+uddi/client/signature/signingKeyStoreFilePassword\
+ @isPasswordEncrypted
uddi/client/signature/signingKeyStoreFilePassword@cryptoProvider
uddi/client/signature/signingKeyPassword
uddi/client/signature/signingKeyPassword@isPasswordEncrypted
@@ -113,7 +127,8 @@ uddi/client/signature/signingKeyPassword@cryptoProvider
uddi/client/signature/signingKeyAlias
uddi/client/signature/canonicalizationMethod
uddi/client/signature/signatureMethod=(default RSA_SHA1)
-uddi/client/signature/XML_DIGSIG_NS=(default http://www.w3.org/2000/09/xmldsig#)
+uddi/client/signature/XML_DIGSIG_NS=\
+ (default http://www.w3.org/2000/09/xmldsig#)
uddi/client/signature/trustStorePath
uddi/client/signature/trustStoreType
uddi/client/signature/trustStorePassword
@@ -138,10 +153,16 @@ The subscriptionCallbacks section defines settings uses by the subscription call
````
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.
+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
@@ -163,17 +184,34 @@ A database server, if one is not available, the embedded Derby engine can be use
#### Changes in configuration compared to non-embedded
* META-INF/embedded-uddi.xml needs to contain the connection settings for InVmTransport.
-....
- <!-- In VM Transport Settings -->
- <proxyTransport>org.apache.juddi.v3.client.transport.InVMTransport</proxyTransport>
- <custodyTransferUrl>org.apache.juddi.api.impl.UDDICustodyTransferImpl</custodyTransferUrl>
- <inquiryUrl>org.apache.juddi.api.impl.UDDIInquiryImpl</inquiryUrl>
- <publishUrl>org.apache.juddi.api.impl.UDDIPublicationImpl</publishUrl>
- <securityUrl>org.apache.juddi.api.impl.UDDISecurityImpl</securityUrl>
- <subscriptionUrl>org.apache.juddi.api.impl.UDDISubscriptionImpl</subscriptionUrl>
- <subscriptionListenerUrl>org.apache.juddi.api.impl.UDDISubscriptionListenerImpl</subscriptionListenerUrl>
- <juddiApiUrl>org.apache.juddi.api.impl.JUDDIApiImpl</juddiApiUrl>
-....
+````
+<!-- In VM Transport Settings -->
+<proxyTransport>
+org.apache.juddi.v3.client.transport.InVMTransport
+</proxyTransport>
+<custodyTransferUrl>
+org.apache.juddi.api.impl.UDDICustodyTransferImpl
+</custodyTransferUrl>
+<inquiryUrl>
+org.apache.juddi.api.impl.UDDIInquiryImpl
+</inquiryUrl>
+<publishUrl>
+org.apache.juddi.api.impl.UDDIPublicationImpl
+</publishUrl>
+<securityUrl>
+org.apache.juddi.api.impl.UDDISecurityImpl
+</securityUrl>
+<subscriptionUrl>
+org.apache.juddi.api.impl.UDDISubscriptionImpl
+</subscriptionUrl>
+<subscriptionListenerUrl>
+org.apache.juddi.api.impl.UDDISubscriptionListenerImpl
+</subscriptionListenerUrl>
+<juddiApiUrl>
+org.apache.juddi.api.impl.JUDDIApiImpl
+</juddiApiUrl>
+````
+
* The serverside config file juddiv3.xml needs to be added to the classpath.
* A META-INF/persistence.xml needs to be added.
* Add the juddi-core (UDDI server) and derby (Embedded Database) dependencies to the pom. Use the juddi-core-openjpa jar for OpenJPA.
diff --git a/src/site/markdown/ClientGuidejUDDIClientforNET.md b/src/site/markdown/ClientGuidejUDDIClientforNET.md
index 4d1cd557b..b12b57933 100644
--- a/src/site/markdown/ClientGuidejUDDIClientforNET.md
+++ b/src/site/markdown/ClientGuidejUDDIClientforNET.md
@@ -19,22 +19,6 @@ Sample Code
````
-/*
- * Copyright 2001-2013 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.
- *
- */
using org.apache.juddi.v3.client;
using org.apache.juddi.v3.client.config;
using org.apache.juddi.v3.client.transport;
@@ -54,21 +38,25 @@ namespace juddi_client.net_sample
UDDIClientContainer.addClient(clerkManager);
Transport transport = clerkManager.getTransport("default");
- org.uddi.apiv3.UDDI_Security_SoapBinding security = transport.getUDDISecurityService();
- org.uddi.apiv3.UDDI_Inquiry_SoapBinding inquiry = transport.getUDDIInquiryService();
+ org.uddi.apiv3.UDDI_Security_SoapBinding security =
+ transport.getUDDISecurityService();
+ org.uddi.apiv3.UDDI_Inquiry_SoapBinding inquiry =
+ transport.getUDDIInquiryService();
UDDIClerk clerk = clerkManager.getClerk("default");
find_business fb = new find_business();
fb.authInfo = clerk.getAuthToken(security.Url);
- fb.findQualifiers = new string[] { UDDIConstants.APPROXIMATE_MATCH };
+ fb.findQualifiers = new string[] { U
+ DDIConstants.APPROXIMATE_MATCH };
fb.name = new name[1];
fb.name[0] = new name(UDDIConstants.WILDCARD, "en");
businessList bl = inquiry.find_business(fb);
for (int i = 0; i < bl.businessInfos.Length; i++)
{
- Console.WriteLine(bl.businessInfos[i].name[0].Value);
+ Console.WriteLine(bl.businessInfos[i].name[0].
+ Value);
}
Console.Read();
diff --git a/src/site/markdown/GuideAdministration.md b/src/site/markdown/GuideAdministration.md
index bf5e24bc9..9dc8e908b 100644
--- a/src/site/markdown/GuideAdministration.md
+++ b/src/site/markdown/GuideAdministration.md
@@ -110,7 +110,8 @@ juddi/auth/authenticator/class = org.apache.juddi.auth.JUDDIAuthentication
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/authenticator/class = \
+ org.apache.juddi.auth.XMLDocAuthentication
juddi/auth/usersfile = juddi-users.xml
````
@@ -132,7 +133,8 @@ The authenticate phase checks that the user id and password match a value in the
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/authenticator/class = \
+ org.apache.juddi.auth.CryptedXMLDocAuthentication
juddi/auth/usersfile = juddi-users-encrypted.xml
juddi/cryptor = org.apache.juddi.cryptor.DefaultCryptor
````
@@ -155,7 +157,8 @@ The authenticate phase checks that the user id and password match a value in the
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/authenticator/class = \
+ org.apache.juddi.auth.MD5XMLDocAuthenticator
juddi/auth/usersfile = juddi-users-hashed.xml
juddi/cryptor = org.apache.juddi.cryptor.DefaultCryptor
````
@@ -182,7 +185,8 @@ LdapSimpleAuthenticator provides a way of authenticating users using LDAP simple
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/class =\
+ org.apache.juddi.auth.LdapSimpleAuthenticator
juddi/auth/authenticator/url=ldap://localhost:389
juddi/auth/authenticator/style=simple
````
@@ -192,7 +196,8 @@ The juddi/authenticator/url property configures the LdapSimpleAuthenticator clas
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/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
@@ -207,7 +212,8 @@ TIP: The JBoss authentication is not distributed with jUDDI. It can be found her
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/authenticator/class = \
+ org.apache.juddi.auth.JBossAuthenticator
juddi/auth/securityDomain=java:/jaas/other
````
@@ -218,7 +224,8 @@ The juddi/auth/authenticator/class property plugs the JbossAuthenticator class i
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/class = \
+ org.apache.juddi.auth.HTTPContainerAuthenticator
juddi/auth/authenticator@useAuthToken=false
````
@@ -230,7 +237,8 @@ In addition, you'll have to make whatever changes necessary to the juddiv3.war/W
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/class = \
+ org.apache.juddi.auth.HTTPHeaderAuthenticator
juddi/auth/authenticator/header=(Some HTTP Header)
juddi/auth/authenticator@useAuthToken=false
````
@@ -251,9 +259,14 @@ For Hibernate, for testing the content of this file looks like
xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"
version="1.0">
- <persistence-unit name="juddiDatabase" transaction-type="RESOURCE_LOCAL">
- <provider>org.hibernate.ejb.HibernatePersistence</provider>
- <jta-data-source>java:comp/env/jdbc/JuddiDS</jta-data-source>
+ <persistence-unit name="juddiDatabase"
+ transaction-type="RESOURCE_LOCAL">
+ <provider>
+ org.hibernate.ejb.HibernatePersistence
+ </provider>
+ <jta-data-source>
+ java:comp/env/jdbc/JuddiDS
+ </jta-data-source>
<!-- entity classes -->
<class>org.apache.juddi.model.Address</class>
<class>org.apache.juddi.model.AddressLine</class>
@@ -262,10 +275,13 @@ For Hibernate, for testing the content of this file looks like
<class>org.apache.juddi.model.UddiEntityPublisher</class>
<properties>
- <property name="hibernate.archive.autodetection" value="class"/>
- <property name="hibernate.hbm2ddl.auto" value="update"/>
+ <property name="hibernate.archive.autodetection"
+ value="class"/>
+ <property name="hibernate.hbm2ddl.auto"
+ value="update"/>
<property name="hibernate.show_sql" value="false"/>
- <property name="hibernate.dialect" value="org.hibernate.dialect.DerbyDialect"/>
+ <property name="hibernate.dialect"
+ value="org.hibernate.dialect.DerbyDialect"/>
</properties>
</persistence-unit>
</persistence>
@@ -276,12 +292,18 @@ 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"
- xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"
- version="1.0">
- <persistence-unit name="juddiDatabase" transaction-type="RESOURCE_LOCAL">
- <provider>org.apache.openjpa.persistence.PersistenceProviderImpl</provider>
- <non-jta-data-source>java:comp/env/jdbc/JuddiDS</non-jta-data-source>
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
+ http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"
+ version="1.0">
+ <persistence-unit name="juddiDatabase"
+ transaction-type="RESOURCE_LOCAL">
+ <provider>
+ org.apache.openjpa.persistence.PersistenceProviderImpl
+ </provider>
+ <non-jta-data-source>
+ java:comp/env/jdbc/JuddiDS
+ </non-jta-data-source>
<!-- entity classes -->
<class>org.apache.juddi.model.Address</class>
<class>org.apache.juddi.model.AddressLine</class>
@@ -289,14 +311,21 @@ For OpenJPA the persistence.xml looks like
<class>org.apache.juddi.model.UddiEntity</class>
<class>org.apache.juddi.model.UddiEntityPublisher</class>
<properties>
- <property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema(SchemaAction='add')"/>
- <property name="openjpa.Log" value="DefaultLevel=WARN, Tool=INFO"/>
- <property name="openjpa.jdbc.UpdateManager" value="operation-order"/>
- <property name="openjpa.jdbc.DBDictionary" value="derby"/>
- <!-- dialects: derby, postgres, mysql, oracle, sybase, sqlserver
- for a complete list check the OpenJPA documentation -->
- <property name="openjpa.RuntimeUnenhancedClasses" value="warn"/>
- <property name="openjpa.Compatibility" value="CheckDatabaseForCascadePersistToDetachedEntity=true"/>
+ <property name="openjpa.jdbc.SynchronizeMappings"
+ value="buildSchema(SchemaAction='add')"/>
+ <property name="openjpa.Log"
+ value="DefaultLevel=WARN, Tool=INFO"/>
+ <property name="openjpa.jdbc.UpdateManager"
+ value="operation-order"/>
+ <property name="openjpa.jdbc.DBDictionary"
+ value="derby"/>
+ <!-- dialects: derby, postgres, mysql, oracle, sybase,
+ sqlserver for a complete list check the OpenJPA
+ documentation -->
+ <property name="openjpa.RuntimeUnenhancedClasses"
+ value="warn"/>
+ <property name="openjpa.Compatibility"
+ value="CheckDatabaseForCascadePersistToDetachedEntity=true"/>
</properties>
</persistence-unit>
</persistence>
@@ -380,7 +409,9 @@ Next edit the datasource. For tomcat you need to update the _juddiv3/META-INF/co
<Context>
<WatchedResource>WEB-INF/web.xml</WatchedResource>
<Resource name="jdbc/JuddiDS" auth="Container"
- type="javax.sql.DataSource" username="juddi" password="juddi"
+ type="javax.sql.DataSource"
+ username="juddi"
+ password="juddi"
driverClassName="org.postgresql.Driver"
url="jdbc:postgresql://localhost:5432/juddi"
maxActive="8"/>
@@ -412,19 +443,26 @@ Note, for this example, my database is called juddi, as is the user who has full
<datasources>
<local-tx-datasource>
<jndi-name>JuddiDS</jndi-name>
- <connection-url>jdbc:postgresql://localhost:5432/juddi</connection-url>
+ <connection-url>
+ jdbc:postgresql://localhost:5432/juddi
+ </connection-url>
<driver-class>org.postgresql.Driver</driver-class>
<user-name>juddi</user-name>
<password>password</password>
- <!-- sql to call when connection is created. Can be anything,
+ <!-- sql to call when connection is created.
+ Can be anything,
select 1 is valid for PostgreSQL
<new-connection-sql>select 1</new-connection-sql>
-->
- <!-- sql to call on an existing pooled connection when it is obtained
- from pool. Can be anything, select 1 is valid for PostgreSQL
- <check-valid-connection-sql>select 1</check-valid-connection-sql>
+ <!-- sql to call on an existing pooled connection when it
+ is obtained from pool. Can be anything, select 1 is
+ valid for PostgreSQL
+ <check-valid-connection-sql>
+ select 1
+ </check-valid-connection-sql>
-->
- <!-- corresponding type-mapping in the standardjbosscmp-jdbc.xml -->
+ <!-- corresponding type-mapping in the
+ standardjbosscmp-jdbc.xml -->
<metadata>
<type-mapping>PostgreSQL 8.0</type-mapping>
</metadata>
@@ -438,7 +476,8 @@ In _persistence.xml_, reference the correct JNDI name of the datasource and remo
<jta-data-source>java:comp/env/jdbc/JuddiDS</jta-data-source>
...
-<property name="hibernate.dialect" value="org.hibernate.dialect.PostgreSQLDialect"/>
+<property name="hibernate.dialect"
+ value="org.hibernate.dialect.PostgreSQLDialect"/>
````
Be sure to have _postgresql-8.3-604.jdbc4.jar_ in the _lib_ folder.
@@ -448,7 +487,8 @@ Be sure to have _postgresql-8.3-604.jdbc4.jar_ in the _lib_ folder.
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"/>
+<property name="hibernate.dialect"
+ value="org.hibernate.dialect.Oracle10gDialect"/>
````
To create a Oracle database name juddiv3 with the ultimate in minimalism use
@@ -470,13 +510,15 @@ The easiest way to handle this is to create an orm.xml file and place it within
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
+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
+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:
@@ -491,7 +533,8 @@ 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"/>
+<property name="hibernate.dialect"
+ value="org.hibernate.dialect.HSQLDialect"/>
````
and the datasource. For tomcat you the _context.xml_ should look something like
@@ -502,7 +545,8 @@ and the datasource. For tomcat you the _context.xml_ should look something like
<WatchedResource>WEB-INF/web.xml</WatchedResource>
<!-- HSQL data source -->
<Resource name="jdbc/JuddiDS" auth="Container"
- type="javax.sql.DataSource" username="JUDDI" password="password"
+ type="javax.sql.DataSource" username="JUDDI"
+ password="password"
driverClassName="org.hsqldb.jdbcDriver"
url="jdbc:hsqldb:hsql://localhost:1747/juddi"
maxActive="8"/>
@@ -569,7 +613,8 @@ There are a few things worth mentioning for administering the jUDDI Graphical Us
### 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
+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.
diff --git a/src/site/markdown/GuideContributingtojUDDI.md b/src/site/markdown/GuideContributingtojUDDI.md
index 29a8741e2..96c2f23dd 100644
--- a/src/site/markdown/GuideContributingtojUDDI.md
+++ b/src/site/markdown/GuideContributingtojUDDI.md
@@ -63,7 +63,8 @@ Procedure - Windows
* 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"
+MSBuild.exe juddi-client.net.sln /p:Configuration=Debug \
+ /p:Platform="Any CPU"
````
For additional debug output set the environment variable 'debug=true'
diff --git a/src/site/markdown/GuideHowToDeployjUDDITo.md b/src/site/markdown/GuideHowToDeployjUDDITo.md
index 42db2d04b..25565898f 100644
--- a/src/site/markdown/GuideHowToDeployjUDDITo.md
+++ b/src/site/markdown/GuideHowToDeployjUDDITo.md
@@ -61,31 +61,40 @@ Target platform JBoss-6.x and HSQL using Hibernate and JBossWS-cxf. The juddiv3.
mvn clean package -P hibernate-jbossws-cxf
````
-[knownissues]
-.KNOWN ISSUES
-Issue 1::
-+
+##### 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
+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.
+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
````
@@ -105,7 +114,8 @@ Insert jboss-web.xml into the juddiv3.war/WEB-INF directory , should look like t
<res-ref-name>jdbc/JuddiDS</res-ref-name>
<jndi-name>java:JuddiDS</jndi-name>
</resource-ref>
- <depends>jboss.jdbc:datasource=JuddiDS,service=metadata</depends>
+ <depends>jboss.jdbc:datasource=JuddiDS,service=metadata
+ </depends>
</jboss-web>
````
@@ -118,7 +128,8 @@ Replace the WEB-INF/web.xml with the jbossws-native-web.xml within docs/examples
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
+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 :
@@ -128,13 +139,17 @@ Next, configure a JBoss datasource file for your db. Listed below is an example
<datasources>
<local-tx-datasource>
<jndi-name>JuddiDS</jndi-name>
- <connection-url>jdbc:mysql://localhost:3306/juddiv3</connection-url>
+ <connection-url>jdbc:mysql://localhost:3306/juddiv3
+ </connection-url>
<driver-class>com.mysql.jdbc.Driver</driver-class>
<user-name>root</user-name>
<password></password>
- <exception-sorter-class-name>org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter</exception-sorter-class-name>
+ <exception-sorter-class-name>
+ org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter
+ </exception-sorter-class-name>
- <!-- corresponding type-mapping in the standardjbosscmp-jdbc.xml (optional) -->
+ <!-- corresponding type-mapping in the
+ standardjbosscmp-jdbc.xml (optional) -->
<metadata>
<type-mapping>mySQL</type-mapping>
</metadata>
@@ -193,14 +208,18 @@ 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*">
+<!DOCTYPE resources PUBLIC "-//Sun Microsystems Inc.//DTD
+Application Server 9.0 Domain//EN" "*<install directory>/lib/dtds/sun-resources_1_3.dtd*">
<resources>
-<jdbc-connection-pool name="mysql-pool" datasource-classname="com.mysql.jdbc.jdbc2.optional.MysqlDataSource" res-type="javax.sql.DataSource">
+<jdbc-connection-pool name="mysql-pool"
+datasource-classname="com.mysql.jdbc.jdbc2.optional.MysqlDataSource"
+ res-type="javax.sql.DataSource">
<property name="user" value="juddi"/>
<property name="password" value="juddi"/>
<property name="url" value="jdbc:mysql://localhost:3306/juddiv3"/>
</jdbc-connection-pool>
-<jdbc-resource enabled="true" jndi-name="jdbc/mysql-resource" object-type="user" pool-name="mysql-pool"/>
+<jdbc-resource enabled="true" jndi-name="jdbc/mysql-resource"
+object-type="user" pool-name="mysql-pool"/>
</resources>
````
diff --git a/src/site/markdown/GuideReplication.md b/src/site/markdown/GuideReplication.md
index b8ef1d46b..96c3ef32d 100644
--- a/src/site/markdown/GuideReplication.md
+++ b/src/site/markdown/GuideReplication.md
@@ -57,8 +57,10 @@ For Tomcat, all you need is a connector with "clientAuth=want". Here's an exampl
<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"/>
+ truststoreFile="truststore.jks"
+ truststorePass="password"
+ keystoreFile="conf/keystore.jks"
+ keystorePass="password"/>
````
##### Mapping certificates to roles
@@ -66,7 +68,9 @@ For Tomcat, all you need is a connector with "clientAuth=want". Here's an exampl
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"/>
+<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".
@@ -116,19 +120,27 @@ 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#">
+<?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>
+ <timeOfConfigurationUpdate>
+ 201502161428-0500
+ </timeOfConfigurationUpdate>
<registryContact>
<ns2:contact>
<ns2:personName>unknown</ns2:personName>
</ns2:contact>
</registryContact>
<operator>
- <operatorNodeID>uddi:juddi.apache.org:node1</operatorNodeID>
+ <operatorNodeID>
+ uddi:juddi.apache.org:node1
+ </operatorNodeID>
<operatorStatus>normal</operatorStatus>
<ns2:contact/>
- <soapReplicationURL>http://localhost:8080/juddiv3/services/replication</soapReplicationURL>
+ <soapReplicationURL>
+ http://localhost:8080/juddiv3/services/replication
+ </soapReplicationURL>
</operator>
<communicationGraph>
<node>uddi:juddi.apache.org:node1</node>
@@ -143,7 +155,9 @@ Here's an example non-directed replicaton graph. In this example, all changes pe
````
<?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#">
+<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>
<timeOfConfigurationUpdate></timeOfConfigurationUpdate>
<registryContact>
@@ -152,20 +166,28 @@ Here's an example non-directed replicaton graph. In this example, all changes pe
</ns2:contact>
</registryContact>
<operator>
- <operatorNodeID>uddi:juddi.apache.org:node1</operatorNodeID>
+ <operatorNodeID>
+ uddi:juddi.apache.org:node1
+ </operatorNodeID>
<operatorStatus>normal</operatorStatus>
<ns2:contact useType="admin">
<ns2:personName xml:lang="en">bob</ns2:personName>
</ns2:contact>
- <soapReplicationURL>https://localhost:8443/juddiv3replication/services/replication</soapReplicationURL>
+ <soapReplicationURL>
+ https://localhost:8443/juddiv3replication/services/replication
+ </soapReplicationURL>
</operator>
<operator>
- <operatorNodeID>uddi:another.juddi.apache.org:node2</operatorNodeID>
+ <operatorNodeID>
+ uddi:another.juddi.apache.org:node2
+ </operatorNodeID>
<operatorStatus>normal</operatorStatus>
<ns2:contact useType="admin">
<ns2:personName xml:lang="en">mary</ns2:personName>
</ns2:contact>
- <soapReplicationURL>https://localhost:9443/juddiv3replication/services/replication</soapReplicationURL>
+ <soapReplicationURL>
+ https://localhost:9443/juddiv3replication/services/replication
+ </soapReplicationURL>
</operator>
<communicationGraph>
<node>uddi:juddi.apache.org:node1</node>
@@ -181,7 +203,9 @@ In this example, we have a directed graph where Node 1 sends to Node2, Node 2 to
````
<?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#">
+<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>
<timeOfConfigurationUpdate></timeOfConfigurationUpdate>
<registryContact>
@@ -190,44 +214,66 @@ In this example, we have a directed graph where Node 1 sends to Node2, Node 2 to
</ns2:contact>
</registryContact>
<operator>
- <operatorNodeID>uddi:juddi.apache.org:node1</operatorNodeID>
+ <operatorNodeID>
+ uddi:juddi.apache.org:node1
+ </operatorNodeID>
<operatorStatus>normal</operatorStatus>
<ns2:contact useType="admin">
<ns2:personName xml:lang="en">bob</ns2:personName>
</ns2:contact>
- <soapReplicationURL>https://localhost:8443/juddiv3replication/services/replication</soapReplicationURL>
+ <soapReplicationURL>
+ https://localhost:8443/juddiv3replication/services/replication
+ </soapReplicationURL>
</operator>
<operator>
- <operatorNodeID>uddi:another.juddi.apache.org:node2</operatorNodeID>
+ <operatorNodeID>
+ uddi:another.juddi.apache.org:node2
+ </operatorNodeID>
<operatorStatus>normal</operatorStatus>
<ns2:contact useType="admin">
<ns2:personName xml:lang="en">mary</ns2:personName>
</ns2:contact>
- <soapReplicationURL>https://localhost:9443/juddiv3replication/services/replication</soapReplicationURL>
+ <soapReplicationURL>
+ https://localhost:9443/juddiv3replication/services/replication
+ </soapReplicationURL>
</operator>
<operator>
- <operatorNodeID>uddi:yet.another.juddi.apache.org:node3</operatorNodeID>
+ <operatorNodeID>
+ uddi:yet.another.juddi.apache.org:node3
+ </operatorNodeID>
<operatorStatus>normal</operatorStatus>
<ns2:contact useType="admin">
<ns2:personName xml:lang="en">mary</ns2:personName>
</ns2:contact>
- <soapReplicationURL>https://localhost:10443/juddiv3replication/services/replication</soapReplicationURL>
+ <soapReplicationURL>
+ https://localhost:10443/juddiv3replication/services/replication
+ </soapReplicationURL>
</operator>
<communicationGraph>
<node>uddi:another.juddi.apache.org:node2</node>
<node>uddi:juddi.apache.org:node1</node>
<node>uddi:yet.another.juddi.apache.org:node3</node>
<edge>
- <messageSender>uddi:juddi.apache.org:node1</messageSender>
- <messageReceiver>uddi:another.juddi.apache.org:node2</messageReceiver>
+ <messageSender>
+ uddi:juddi.apache.org:node1
+ </messageSender>
+ <messageReceiver>
+ uddi:another.juddi.apache.org:node2
+ </messageReceiver>
</edge>
<edge>
- <messageSender>uddi:another.juddi.apache.org:node2</messageSender>
- <messageReceiver>uddi:yet.another.juddi.apache.org:node3</messageReceiver>
+ <messageSender>uddi:another.juddi.apache.org:node2
+ </messageSender>
+ <messageReceiver>uddi:yet.another.juddi.apache.org:node3
+ </messageReceiver>
</edge>
<edge>
- <messageSender>uddi:yet.another.juddi.apache.org:node3</messageSender>
- <messageReceiver>uddi:juddi.apache.org:node1</messageReceiver>
+ <messageSender>
+ uddi:yet.another.juddi.apache.org:node3
+ </messageSender>
+ <messageReceiver>
+ uddi:juddi.apache.org:node1
+ </messageReceiver>
</edge>
</communicationGraph>
<maximumTimeToSyncRegistry>1</maximumTimeToSyncRegistry>
diff --git a/src/site/markdown/GuideRootSeedData.md b/src/site/markdown/GuideRootSeedData.md
index 336c9b632..3afaf1a00 100644
--- a/src/site/markdown/GuideRootSeedData.md
+++ b/src/site/markdown/GuideRootSeedData.md
@@ -17,7 +17,8 @@ For each publisher there are four seed data files that will be read the first ti
For example the content of the root_Publisher.xml looks like
````
-<publisher xmlns="urn:juddi-apache-org:api_v3" authorizedName="root">
+<publisher xmlns="urn:juddi-apache-org:api_v3"
+ authorizedName="root">
<publisherName>root publisher</publishername>
<isAdmin>true</isadmin>
</publisher>
@@ -26,7 +27,8 @@ For example the content of the root_Publisher.xml looks like
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">
+<tModel tModelKey="uddi:juddi.apache.org:keygenerator"
+ xmlns="urn:uddi-org:api_v3">
<name>uddi-org:keyGenerator</name>
<description>Root domain key generator</description>
<overviewDoc>
@@ -35,7 +37,8 @@ Each publisher should have its own key generator schema so that custom generated
</overviewurl>
</overviewdoc>
<categoryBag>
- <keyedReference tModelKey="uddi:uddi.org:categorization:types"
+ <keyedReference
+ tModelKey="uddi:uddi.org:categorization:types"
keyName="uddi-org:types:keyGenerator"
keyValue="keyGenerator" />
</categorybag>
@@ -47,37 +50,58 @@ This means that the legal format of keys used by the root publisher need to be i
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 -->
+<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>
- <!-- Change the description field to provided a brief description of your registry -->
- <description xml:lang="en">This is a UDDI v3 registry node as implemented by Apache jUDDI.</description>
+<!-- Change the description field to provided a brief description
+ of your registry -->
+ <description xml:lang="en">This is a UDDI v3 registry node as
+ implemented by Apache jUDDI.</description>
<discoveryURLs>
- <!-- This discovery URL should point to the home installation URL of jUDDI -->
- <discoveryURL useType="home">${juddi.server.baseurl}/juddiv3</discoveryURL>
+ <!-- This discovery URL should point to the home installation
+ URL of jUDDI -->
+ <discoveryURL useType="home">${juddi.server.baseurl}/juddiv3
+ </discoveryURL>
</discoveryURLs>
<categoryBag>
- <keyedReference tModelKey="uddi:uddi.org:categorization:nodes" keyValue="node" />
+ <keyedReference tModelKey="uddi:uddi.org:categorization:nodes"
+ keyValue="node" />
</categoryBag>
<businessServices>
- <!-- As mentioned above, you may want to provide user-defined keys for these (and the services/bindingTemplates below. Services that you
- don't intend to support should be removed entirely -->
- <businessService serviceKey="uddi:juddi.apache.org:services-inquiry" businessKey="uddi:juddi.apache.org:businesses-asf">
+ <!-- As mentioned above, you may want to provide user-defined
+ keys for these (and the services/bindingTemplates below.
+ Services that you don't intend to support should be removed
+ entirely -->
+ <businessService
+ serviceKey="uddi:juddi.apache.org:services-inquiry"
+ businessKey="uddi:juddi.apache.org:businesses-asf">
<name xml:lang="en">UDDI Inquiry Service</name>
- <description xml:lang="en">Web Service supporting UDDI Inquiry API</description>
+ <description xml:lang="en">Web Service supporting UDDI
+ Inquiry API</description>
<bindingTemplates>
- <bindingTemplate bindingKey="uddi:juddi.apache.org:servicebindings-inquiry-ws" serviceKey="uddi:juddi.apache.org:services-inquiry">
+ <bindingTemplate
+ bindingKey="uddi:juddi.apache.org:servicebindings-inquiry-ws"
+ serviceKey="uddi:juddi.apache.org:services-inquiry">
<description>UDDI Inquiry API V3</description>
- <!-- This should be changed to the WSDL URL of the inquiry API. An access point inside a bindingTemplate will be found for every service
- in this file. They all must point to their API's WSDL URL -->
- <accessPoint useType="wsdlDeployment">${juddi.server.baseurl}/services/inquiry?wsdl</accessPoint>
+ <!-- This should be changed to the WSDL URL of the
+ inquiry API. An access point inside a
+ bindingTemplate will be found for every service
+ in this file. They all must point to their API's
+ WSDL URL -->
+ <accessPoint useType="wsdlDeployment">
+ ${juddi.server.baseurl}/services/inquiry?wsdl
+ </accessPoint>
<tModelInstanceDetails>
- <tModelInstanceInfo tModelKey="uddi:uddi.org:v3_inquiry">
+ <tModelInstanceInfo
+ tModelKey="uddi:uddi.org:v3_inquiry">
<instanceDetails>
<instanceParms>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
- <UDDIinstanceParmsContainer xmlns="urn:uddi-org:policy_v3_instanceParms">
+ <UDDIinstanceParmsContainer
+ xmlns="urn:uddi-org:policy_v3_instanceParms">
<defaultSortOrder>
uddi:uddi.org:sortorder:binarysort
</defaultSortOrder>
@@ -88,7 +112,9 @@ Finally, in the `<publisher></publisher>_BusinessEntity.xml` file can be used to
</tModelInstanceInfo>
</tModelInstanceDetails>
<categoryBag>
- <keyedReference keyName="uddi-org:types:wsdl" keyValue="wsdlDeployment" tModelKey="uddi:uddi.org:categorization:types"/>
+ <keyedReference keyName="uddi-org:types:wsdl"
+ keyValue="wsdlDeployment"
+ tModelKey="uddi:uddi.org:categorization:types"/>
</categoryBag>
</bindingTemplate>
</bindingTemplates>
@@ -115,8 +141,10 @@ The juddiv3.war ships with two example data directory. One for the Sales Affilia
````
*nix
-mv RENAME4Sales_juddi_custom_install_data juddi_custom_install_data
+mv RENAME4Sales_juddi_custom_install_data \
+ juddi_custom_install_data
Win*
-ren RENAME4Sales_juddi_custom_install_data juddi_custom_install_data
+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/src/site/markdown/GuideTroubleshootingjUDDI.md b/src/site/markdown/GuideTroubleshootingjUDDI.md
index acc5c4ef4..67f735ef7 100644
--- a/src/site/markdown/GuideTroubleshootingjUDDI.md
+++ b/src/site/markdown/GuideTroubleshootingjUDDI.md
@@ -32,11 +32,15 @@ Components based on jUDDI's Client for the .NET Framework can configure logging
````
<!-- 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.
- Notes for EVENTLOG, you must run the juddi-installer as admin before running-->
- <add key="org.apache.juddi.v3.client.log.target" value="CONSOLE" />
+ <!-- options are CONSOLE, EVENTLOG, FILE multiple values can be
+ specified, comma delimited.
+ Notes for EVENTLOG, you must run the juddi-installer as admin
+ before running-->
+ <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" />
+ <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.
diff --git a/src/site/markdown/GuideUDDISubscriptions.md b/src/site/markdown/GuideUDDISubscriptions.md
index f9a20fa08..b34920ec5 100644
--- a/src/site/markdown/GuideUDDISubscriptions.md
+++ b/src/site/markdown/GuideUDDISubscriptions.md
@@ -43,7 +43,8 @@ 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
+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.
````
@@ -105,37 +106,41 @@ The sales department developed a service called HelloSales. The HelloSales servi
````
<?xml version="1.0" encoding="ISO-8859-1" ?>
<uddi>
- <reloadDelay>5000</reloadDelay>
- <manager name="example-manager">
- <nodes>
- <node>
- <name>default</name>
- <description>Sales jUDDI node</description>
- <properties>
- <property name="serverName" value="sales"/>
- <property name="serverPort" value="8080"/>
- <property name="keyDomain" value="sales.apache.org"/>
- <property name="department" value="sales" />
- </properties>
- <proxyTransport>
- org.apache.juddi.v3.client.transport.InVMTransport
- </proxyTransport>
- <custodyTransferUrl>
- org.apache.juddi.api.impl.UDDICustodyTransferImpl
- </custodyTransferUrl>
- <inquiryUrl>org.apache.juddi.api.impl.UDDIInquiryImpl</inquiryUrl>
- <publishUrl>org.apache.juddi.api.impl.UDDIPublicationImpl</publishUrl>
- <securityUrl>org.apache.juddi.api.impl.UDDISecurityImpl</securityUrl>
- <subscriptionUrl>
- org.apache.juddi.api.impl.UDDISubscriptionImpl
- </subscriptionUrl>
- <subscriptionListenerUrl>
- org.apache.juddi.api.impl.UDDISubscriptionListenerImpl
- </subscriptionListenerUrl>
- <juddiApiUrl>org.apache.juddi.api.impl.JUDDIApiImpl</juddiApiUrl>
- </node>
- </nodes>
- </manager>
+<reloadDelay>5000</reloadDelay>
+<manager name="example-manager">
+<nodes>
+<node>
+ <name>default</name>
+ <description>Sales jUDDI node</description>
+ <properties>
+ <property name="serverName" value="sales"/>
+ <property name="serverPort" value="8080"/>
+ <property name="keyDomain" value="sales.apache.org"/>
+ <property name="department" value="sales" />
+ </properties>
+ <proxyTransport>
+ org.apache.juddi.v3.client.transport.InVMTransport
+ </proxyTransport>
+ <custodyTransferUrl>
+ org.apache.juddi.api.impl.UDDICustodyTransferImpl
+ </custodyTransferUrl>
+ <inquiryUrl>org.apache.juddi.api.impl.UDDIInquiryImpl
+ </inquiryUrl>
+ <publishUrl>org.apache.juddi.api.impl.UDDIPublicationImpl
+ </publishUrl>
+ <securityUrl>org.apache.juddi.api.impl.UDDISecurityImpl
+ </securityUrl>
+ <subscriptionUrl>
+ org.apache.juddi.api.impl.UDDISubscriptionImpl
+ </subscriptionUrl>
+ <subscriptionListenerUrl>
+ org.apache.juddi.api.impl.UDDISubscriptionListenerImpl
+ </subscriptionListenerUrl>
+ <juddiApiUrl>org.apache.juddi.api.impl.JUDDIApiImpl
+ </juddiApiUrl>
+</node>
+</nodes>
+</manager>
</uddi>
````
@@ -154,7 +159,8 @@ For a user to create and save subscriptions the publisher needs to have a valid
````
<save_tModel xmlns="urn:uddi-org:api_v3">
- <tModel tModelKey="uddi:marketing.apache.org:keygenerator" 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>
<description>Marketing domain key generator</description>
<overviewDoc>
@@ -163,29 +169,35 @@ For a user to create and save subscriptions the publisher needs to have a valid
</overviewURL>
</overviewDoc>
<categoryBag>
- <keyedReference tModelKey="uddi:uddi.org:categorization:types"
+ <keyedReference
+ tModelKey="uddi:uddi.org:categorization:types"
keyName="uddi-org:types:keyGenerator"
keyValue="keyGenerator" />
</categoryBag>
</tModel>
- <tModel tModelKey="uddi:marketing.apache.org:subscription:keygenerator"
+ <tModel
+ tModelKey="uddi:marketing.apache.org:subscription:keygenerator"
xmlns="urn:uddi-org:api_v3">
- <name>marketing-apache-org:subscription:keyGenerator</name>
- <description>Marketing Subscriptions domain key generator</description>
+ <name>
+ marketing-apache-org:subscription:keyGenerator</name>
+ <description>Marketing Subscriptions domain key
+ generator</description>
<overviewDoc>
<overviewURL useType="text">
http://uddi.org/pubs/uddi_v3.htm#keyGen
</overviewURL>
</overviewDoc>
<categoryBag>
- <keyedReference tModelKey="uddi:uddi.org:categorization:types"
+ <keyedReference
+ tModelKey="uddi:uddi.org:categorization:types"
keyName="uddi-org:types:keyGenerator"
keyValue="keyGenerator" />
</categoryBag>
</tModel>
- <tModel tModelKey="uddi:sales.apache.org:keygenerator" xmlns="urn:uddi-org:api_v3">
+ <tModel tModelKey="uddi:sales.apache.org:keygenerator"
+ xmlns="urn:uddi-org:api_v3">
<name>sales-apache-org:keyGenerator</name>
<description>Sales Root domain key generator</description>
<overviewDoc>
@@ -194,7 +206,8 @@ For a user to create and save subscriptions the publisher needs to have a valid
</overviewURL>
</overviewDoc>
<categoryBag>
- <keyedReference tModelKey="uddi:uddi.org:categorization:types"
+ <keyedReference
+ tModelKey="uddi:uddi.org:categorization:types"
keyName="uddi-org:types:keyGenerator"
keyValue="keyGenerator" />
</categoryBag>
@@ -214,7 +227,8 @@ If we are going to user the marketing publisher to subscribe to updates in the s
<!-- optional
<xregister>
<servicebinding
- entityKey="uddi:marketing.apache.org:servicebindings-subscriptionlistener-ws"
+ entityKey="uddi:marketing.apache.org:servicebindings-\
+ subscriptionlistener-ws"
fromClerk="MarketingCratchit" toClerk="SalesCratchit"/>
</xregister>
-->
diff --git a/uddi-client-dist/pom.xml b/uddi-client-dist/pom.xml
index 4ef51f0c7..16135d3fe 100644
--- a/uddi-client-dist/pom.xml
+++ b/uddi-client-dist/pom.xml
@@ -195,6 +195,13 @@ language governing permissions and * limitations under the License. * */ -->
<version>${project.parent.version}</version>
<type>jar</type>
<classifier>javadoc</classifier>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.juddi</groupId>
+ <artifactId>juddi-parent</artifactId>
+ <version>${project.parent.version}</version>
+ <classifier>client</classifier>
+ <type>pdf</type>
</dependency>
</dependencies>
diff --git a/uddi-client-dist/src/main/assembly/assembly.xml b/uddi-client-dist/src/main/assembly/assembly.xml
index e9ba45ae2..6ceffffa5 100644
--- a/uddi-client-dist/src/main/assembly/assembly.xml
+++ b/uddi-client-dist/src/main/assembly/assembly.xml
@@ -31,7 +31,7 @@
</includes>
<excludes>
<exclude>org.apache.juddi:juddi-client:jar:sources</exclude>
- <exclude>org.apache.juddi:juddi-client:-clijar:sources</exclude>
+ <exclude>org.apache.juddi:juddi-client-cli:jar:sources</exclude>
<exclude>org.apache.juddi:uddi-ws:jar:sources</exclude>
<exclude>org.apache.juddi:uddi-migration-tool:jar:sources</exclude>
<exclude>org.apache.juddi:juddi-client:jar:javadoc</exclude>
@@ -117,27 +117,6 @@
<fileMode>0755</fileMode>
</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>
-
<dependencySet>
<outputDirectory>docs/javadoc</outputDirectory>
<scope>test</scope>
@@ -171,6 +150,19 @@
<include>LICENSE</include>
</includes>
</fileSet>
+
+ <!-- The jUDDI client documentation -->
+
+ <fileSet>
+ <directory>../target/site</directory>
+ <outputDirectory>docs</outputDirectory>
+ <filtered>false</filtered>
+ <directoryMode>0755</directoryMode>
+ <fileMode>0755</fileMode>
+ <includes>
+ <include>juddi-client-guide.pdf</include>
+ </includes>
+ </fileSet>
<fileSet>
<directory>${basedir}/src/main</directory>
<outputDirectory></outputDirectory>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org