Skip to Content

Changes for page maven-wobootstrap-plugin

Last modified by Lachlan Deck on 2011/08/16 18:43
From version 18.1
edited by Lachlan Deck
on 2011/08/16 18:43
Change comment: Adding a tip for how to use a specific version of the wobootstrap plugin.
To version 12.1
edited by Ulrich Köster
on 2006/11/07 03:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ldeck
1 +XWiki.uli
Content
... ... @@ -1,88 +1,23 @@
1 -== Introduction ==
1 +== Description ==
2 2  
3 -The wobootstrap plug-in is used to import the WebObjects libraries to the Maven's local repository or a remote repository for sharing with other developers and projects {{color value="red"}}*(for WebObjects version 5.3 and later, the license is now included as part of the Xcode software license. Please review the license in the Xcode installer to verify if you are not breaking the current terms)*{{/color}}.
3 +"maven-wobootstrap-plugin" is a plug-in for importing woframeworks into the local maven repository.
4 4  
5 -This plug-in searches for the WebObjects jars and generates all the required information (groupId, artifactId and version) to import the libraries to the particular repository.
5 +== Goals ==
6 6  
7 -The wobootstrap goals usually need to be executed once per WebObjects version.
7 +=== ##org.objectstyle.woproject.maven2:wobootstrap:bootstrap## ===
8 8  
9 -WebObjects 5.2 or later must be installed in order to use the wobootstrap plug-in. The supported platforms include MacOS X, Windows and Linux.
9 +Bootstrap goal for WebObjects projects. Copy all necessary WebObjects jars into local maven repository.
10 10  
11 -== Goals Overview ==
11 +For the moment, this goal only works for MacOS X and Windows.
12 12  
13 -The wobootstrap plug-in has 2 goals:
13 +This plug-in only requires to be executed once.
14 14  
15 -* **wobootstrap:install* goal is used to import the WebObjects libraries to the local repository. It works in a similar way to the [[install:install-file>>http://maven.apache.org/plugins/maven-install-plugin/]] goal, but the wobootstrap provides all the required information to install the jars.**
15 +=== Example ===
16 16  
17 -* **woboostrap:deploy* goal is used to import the WebObjects libraries to the specified remote repository. It works in a similar way to the [[deploy:deploy-file>>http://maven.apache.org/plugins/maven-deploy-plugin/]] goal.**
17 +This goal doesn't need any previous configuration. Just execute the following command:
18 18  
19 -== Usage ==
20 -
21 -=== The wobootstrap:install Mojo ===
22 -
23 -In most cases, wobootstrap:install doesn't need any configuration. It also doesn't need a Maven project to run.
24 -
25 25  {{noformat}}
26 26  
27 -mvn wobootstrap:install
21 +mvn wobootstrap:bootstrap
28 28  
29 29  {{/noformat}}
30 -
31 -=== The wobootstrap:deploy Mojo ===
32 -
33 -The wobootstrap:deploy Mojo is used to install the WebObjects libraries to a remote repository (i.e. managed by an Enterprise Repository Manager). The full usage statement of the wobootstrap:deploy mojo can be described as:
34 -
35 -{{noformat}}
36 -
37 -mvn wobootstrap:deploy -Durl=file://C:\m2-repo \
38 - -DrepositoryId=some.id
39 -
40 -{{/noformat}}
41 -
42 -If the url to deploy is not specified, the goal will fail. The repositoryId points to a server section in the settings.xml file. If you don't specify a repositoryId, Maven will try to extract authentication information using the default id 'remote-repository'.
43 -
44 -
45 -
46 -{{tip title="Using the full identifier"}}
47 -There are two reasons for needing to specify the complete identifier of the wobootstrap plugin:
48 -* You want to use a specific version
49 -* You have an environment out of your control and you cannot adjust the pluginGroups in the settings.xml file.
50 -
51 -{code:bash}
52 -##
53 -## Usage: <groupId>:<artifactId>[:<version>]:<goal>
54 -## where goal is either install or deploy, for example.
55 -##
56 -mvn org.objectstyle.woproject.maven2:maven-wobootstrap-plugin[:<version>]:<goal>
57 -{code}
58 -{{/tip}}
59 -
60 -=== Custom WebObjects Location ===
61 -
62 -You can set 2 parameters to customize the mechanism used by this plug-in to locate WebObjects libraries:
63 -
64 -* **webObjectsLibFolder** (optional): The folder containing the WebObjects jars. If you provide a folder without the correct WebObjects libraries, the goal will succeed, but no libraries will be installed or deployed.
65 -* **webObjectsVersion** (optional): The version of the WebObjects jars.
66 -
67 -These configurations are optional, but you have to provide both if you want to customize the search for WebObjects libraries.
68 -
69 -{{noformat}}
70 -
71 -mvn wobootstrap:install -DwebObjectsLibFolder=/a_path_to_webobjects/lib \
72 - -DwebObjectsVersion=5.3.3
73 -
74 -{{/noformat}}
75 -
76 -You can use these parameters with both goals: install and deploy.
77 -
78 -{{warning title="Installing the right jars!"}}
79 -
80 -Do *not* link to or install the WebObjects jars located inside {{/System/Library/Frameworks}} or {{/Library/Frameworks}}. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into {{/Library/WebObjects/lib}}. For example, the jar {{/Library/WebObjects/lib/JavaWebObjects.jar}} has the complete set of resources and files included for the dependency JavaWebObjects whereas {{/System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar}} does not.
81 -
82 -{{/warning}}
83 -
84 -== Tips ==
85 -
86 -If the following error happens while using the wobootstrap:deploy goal: "Error deploying artifact: Unsupported Protocol: 'ftp': Cannot find wagon which supports the requested protocol: ftp"
87 -
88 -See the solution [[here>>http://maven.apache.org/plugins/maven-deploy-plugin/faq.html]].