Search: jar

JAR extensions are extensions packaged as JAVA JAR packages. What does installing a JAR extension exactly means When a JAR extension is installed, the following happens in practice: the JAR is loaded in the ClassLoader corresponding to the namespace where it was installed (root namespace, wiki namespace, user namespace, etc.) the components in the JAR extension are loaded into the ComponentManager corresponding to the namespace where it was installed (root namespace, wiki namespace, user namespace, etc.) various listeners react to those new components/extensions events (for example the ObservationManager receive new listeners) Subtleties related to classes and the upgrade/uninstallation of extensions In Java, you cannot really remove a class from a ClassLoader.

JAR Extensions

JAR

JAR extensions are extensions packaged as JAVA JAR packages

= What does installing a JAR extension exactly means When a JAR extension is installed, the following happens in practice: * the JAR is loaded in the ClassLoader corresponding to the namespace where it was installed (root namespace, wiki namespace, user namespace, etc.) * the components in the JAR extension are loaded into the ComponentManager corresponding to the namespace where it was installed (root namespace, wiki namespace, user namespace, etc.) * various listeners react to those new components/extensions events (for example the ObservationManager receive new listeners) = Subtleties related to classes and the upgrade/uninstallation of extensions In Java, you cannot really remove a class from a ClassLoader.

Templates from JARs

summary : TemplateManager component now also search for templates in current Thread classloader which mean you can put your templates inside your JAR in the ##/templates## folder. This is the last step to any JAR extension can provide default template which can be overwritten in a skin on in /template/ WAR resources.

title : Templates from JARs

We will now see how to link XWiki jar projects (xwiki-platform-oldcore, extensions...) to this XWiki instance to be able to edit java using all of the Eclipse tools. Import Jar project Start the Import wizard Select Maven Projects Click Select root folder of project you want to import Click Link Jar project to the web project Project which are already part of the standard XWiki WAR are automatically linked. For extensions or any other jar you want to deploy on XWiki go to project Properties -> Deployment Assembly and add the project.

Import and link maven jar projects to debug

We will now see how to link XWiki jar projects (xwiki-platform-oldcore, extensions...) to this XWiki instance to be able to edit java using all of the Eclipse tools. = Import Jar project = * Start the Import wizard ((( image:import-1.jpg ))) * Select //Maven Projects// * Click image:[email protected] ((( image:import-2.jpg ))) * Select root folder of project you want to import * Click image:[email protected] ((( image:import-3.jpg ))) == Link Jar project to the web project == Project which are already part of the standard XWiki WAR are automatically linked. For extensions or any other jar you want to deploy on XWiki go to project ##Properties -> Deployment Assembly## and add the project.

Default UI JAR dependencies installed on root namespace

summary : JAR extensions of the default UI are now automatically installed on root namespace.

title : Default UI JAR dependencies installed on root namespace

There are various ways to do, as explained in the sections below but here's an explanation of the various JARs available and what they mean. You'll need: The xwiki-rendering-api JAR.

In addition if you plan to use macros you'll need to add the following JARs: the xwiki-rendering-transformation-macro JAR the JARs for the macros you want to use (macros correspond to directories named xwiki-rendering-macro-*).

Note that not only you need the JARs mentioned above but you also need all the transitive dependencies required by those JARs...

I'm having trouble accessing the links to the JAR files. * The [[xwiki-rendering-api JAR>>http://repo2.maven.org/maven2/org/xwiki/rendering/xwiki-rendering-api/]]. for example.

In addition if you plan to use macros you'll need to add the following JARs: * the [[##xwiki-rendering-transformation-macro## JAR>>https://search.maven.org/artifact/org.xwiki.rendering/xwiki-rendering-transformation-macro]] * the [[JARs for the macros you want to use>>https://search.maven.org/search?

For example to direct all logs to Logback you'll need: * The ##jcl-over-slf4j## JAR which tells all JCL calls to be sent to SLF4J.

Note that not only you need the JARs mentioned above but you also need all the transitive dependencies required by those JARs...

The WebJar extensions client-side web libraries (e.g. jQuery & Bootstrap) packaged into JAR (Java Archive) files. Standard WebJars, as defined by http://www.webjars.org, are JAR extension but to make easier to differentiate actual JARs and WebJars a new type was introduced.

In practice it works exactly like JAR extensions except for two differences: no scan to find components is applied wiki administrators are allowed to install WebJars (programming right is required for JARs)

The WebJar extensions client-side web libraries (e.g. jQuery & Bootstrap) packaged into JAR (Java Archive) files. Standard WebJars, as defined by http://www.webjars.org, are JAR extension but to make easier to differentiate actual JARs and WebJars a new type was introduced.

In practice it works exactly like JAR extensions except for two differences: * no scan to find components is applied * wiki administrators are allowed to install WebJars (programming right is required for JARs)

Using the platform independent installer (the .jar installer) for standalone package Download the XWiki Watch .jar file. Run the .jar file (You need to have Java to be able to run the installer) and follow the instructions: depending on your system settings you can do this either by double-clicking it or by explicitly invoking java -jar xwiki-watch-installer-generic-1.0.jar in a command line.

To enjoy the experience of XWiki Watch 1.0 in XWiki 1.3, follow the next steps: get xwiki-web-gwt-1.4.1.jar from our maven repository get gwt-servlet-1.4.61.jar from gwt maven repository go to webapps/xwiki/WEB-INF/lib folder in your XWiki installation remove the gwt-servlet-1.3.3.jar and xwiki-web-gwt-1.3.x.jar libraries (1.3.x corresponding to the version of XWiki you are running).

{{/info}} == Using the platform independent installer (the .jar installer) for standalone package == * Download the [[XWiki Watch .jar file>>XWiki Watch||anchor="HDownloads"]]. * Run the .jar file (You need to have Java to be able to run the installer) and follow the instructions: depending on your system settings you can do this either by double-clicking it or by explicitly invoking ##java -jar xwiki-watch-installer-generic-1.0.jar## in a command line.

To enjoy the experience of XWiki Watch 1.0 in XWiki 1.4, follow the next steps: * get ##xwiki-web-gwt-1.4.1.jar## from [[our maven repository>>http://maven.xwiki.org/releases/com/xpn/xwiki/platform/xwiki-web-gwt/1.4.1/xwiki-web-gwt-1.4.1.jar]] * go to ##webapps/xwiki/WEB-INF/lib## folder in your XWiki installation * replace the ##xwiki-web-gwt-1.4-*.jar## library (1.4-* corresponding to the version of XWiki you are running) with the jar you just downloaded * restart your wiki * install the ##xwiki-watch-1.0.xar## into your wiki following the [[instructions above>>||anchor="HXWikiWatchoveranexistingwiki28installingthexar29"]], if you haven't already.

To enjoy the experience of XWiki Watch 1.0 in XWiki 1.3, follow the next steps: * get ##xwiki-web-gwt-1.4.1.jar## from [[our maven repository>>http://maven.xwiki.org/releases/com/xpn/xwiki/platform/xwiki-web-gwt/1.4.1/xwiki-web-gwt-1.4.1.jar]] * get ##gwt-servlet-1.4.61.jar## from [[gwt maven repository>>http://gwt-maven.googlecode.com/svn/trunk/mavenrepo/com/google/gwt/gwt-servlet/1.4.61/gwt-servlet-1.4.61.jar]] * go to ##webapps/xwiki/WEB-INF/lib## folder in your XWiki installation * remove the ##gwt-servlet-1.3.3.jar## and ##xwiki-web-gwt-1.3.x.jar## libraries (1.3.x corresponding to the version of XWiki you are running)

This is achieved by using a SLF4J Bridge for both logging frameworks (it's the log4j-over-slf4j-*.jar and jcl-over-slf4j-*.jar files that provide this feature).

For example: Using a different SLF4J implementation If you wish, for example, to use Log4J to log all logs produced by XWiki you can do so by doing the following (described in the SLF4J manual): Remove the Logback SLF4J implementation from the classpath by removing WEB-INF/lib/logback-classic-*.jar and WEB-INF/lib/logback-core-*.jar Remove the Log4J over SLF4J JAR from the classpath by removing WEB-INF/lib/log4j-over-slf4j-*.jar Add the Log4J SLF4J implementation to the classpath: slf4j-log4j*-*.jar Add Log4J itself to the classpath Older XWiki versions XWiki versions 3.0 and older use Commons Logging for logging.

XWiki' JAR is itself located in your WEB-INF/lib/ directory.

This is achieved by using [[a SLF4J Bridge>>http://www.slf4j.org/legacy.html]] for both logging frameworks (it's the ##log4j-over-slf4j-*.jar## and ##jcl-over-slf4j-*.jar## files that provide this feature)

For example: [[image:lilith.png||width="950"]] == Using a different SLF4J implementation == If you wish, for example, to use Log4J to log all logs produced by XWiki you can do so by doing the following ([[described in the SLF4J manual>>http://www.slf4j.org/manual.html]]): * Remove the Logback SLF4J implementation from the classpath by removing ##WEB-INF/lib/logback-classic-*.jar## and ##WEB-INF/lib/logback-core-*.jar## * Remove the Log4J over SLF4J JAR from the classpath by removing ##WEB-INF/lib/log4j-over-slf4j-*.jar## * Add the Log4J SLF4J implementation to the classpath: ##slf4j-log4j*-*.jar## * Add Log4J itself to the classpath = Older XWiki versions = XWiki versions 3.0 and older use Commons Logging for logging.

XWiki' JAR is itself located in your ##WEB-INF/lib/## directory.

Domains The domains must be specified as one policy per jar file. Policy per jar file To simplify maintenance of the policy file, we employ symbolic names for domains.

The default should be to not associate a jar-file with any particular policy (i.e., it will have minimum privileges).

Must only read domain specifications from jar-files corresponding directly to modules specified in the xwiki-platform-core top level project.

. === Domains === The domains must be specified as one policy per jar file. ==== Policy per jar file ==== To simplify maintenance of the policy file, we employ symbolic names for domains. Then, each xwiki platform component may include a file that names the domain its jar-file should be placed in. It must also be possible to specify domain for the dependencies. The default should be to not associate a jar-file with any particular policy (i.e., it will have minimum privileges).

Just copy the following 3 jars org.xwiki.eclipse.core-2.0.0.milestone1.jar, org.xwiki.eclipse.storage-2.0.0.milestone1.jar and org.xwiki.eclipse.ui-2.0.0.milestone1.jar to the eclipse/dropins directory and restart your Eclipse.

Just copy the following 3 jars [[org.xwiki.eclipse.core-2.0.0.milestone1.jar>>http://maven.xwiki.org/releases/org/xwiki/eclipse/org.xwiki.eclipse.core/2.0.0.milestone1/org.xwiki.eclipse.core-2.0.0.milestone1.jar]], [[org.xwiki.eclipse.storage-2.0.0.milestone1.jar>>http://maven.xwiki.org/releases/org/xwiki/eclipse/org.xwiki.eclipse.storage/2.0.0.milestone1/org.xwiki.eclipse.storage-2.0.0.milestone1.jar]] and [[org.xwiki.eclipse.ui-2.0.0.milestone1.jar>>http://maven.xwiki.org/releases/org/xwiki/eclipse/org.xwiki.eclipse.ui/2.0.0.milestone1/org.xwiki.eclipse.ui-2.0.0.milestone1.jar]] to the eclipse/dropins directory and restart your Eclipse. == Usage == Once you have started Eclipse, you need to use the File/New/Other menu and then select XWiki Eclipse/New Connection to setup a new connection.