The eXo IDE application provides the original approach to operate with REST Service to validate, deploy/undeploy and launch applications, which are compatible with the JSR-311 specification without restarting the server, or installing additional programs:

With eXo IDE, you can validate REST Service before saving, deploying, launching or undeploying the service. The feedback from server is displayed in the Output tab:

All REST Service commands are placed at the right part of the toolbar and in the Run from the top menu.

To clear the Output pane, click at the right top corner of this pane.

See also

[INFO]
rennes.groovy validated successfully".

[ERROR] rennes.groovy validation failed. Error (400: Bad Request)
Unexpected error. Error occurs when parse stream, compiler error:
startup failed, rennes.groovy: 4: unable to resolve class javax.ws.rs.Path1
@ line 4, column 1.rennes.groovy: 8: unable to resolve classpath , unable to find class for annotation
@ line 8, column 1.rennes.groovy: 11: unable to resolve classpath , unable to find class for annotation
@ line 11, column 3.
3 errors

[INFO]rennes.groovy deployed successfully

[ERROR] rennes.groovy deploy failed. Error (400: Bad Request)
Unexpected error. Error occurs when parse stream, compiler error:
startup failed, rennes.groovy: 4: unable to resolve class javax.ws.rs.Path1
@ line 4, column 1.rennes.groovy: 8: unable to resolve class Path , unable to
find class for annotation
@ line 8, column 1.rennes.groovy: 11: unable to resolve class Path , unable to
find class for annotation
@ line 11, column 3.
3 errors

[INFO] /repository/collaboration/rennes.groovy undeployed successfully.

[ERROR] /repository/collaboration/rennes.groovy
undeploy failed. Error (400: Bad Request)
Can not unbind script rennes.groovy, not bound or has wrong mapping to the
resource class

2.1.3. Use Autoload property

Note

This function is for users with the administrator role only.

REST Service is deployed automatically on the server after being saved, if the Autoload property is set to "True". You can view this property in the Property tab by clicking . To manage the Autoload property, use Set/Unset Autoload commands respectively. These commands are displayed to the current status of the Autoload property, so you can invert this property. The default value of the Autoload property is set to "False". For more details, see the illustration below:

[OUTPUT] - -Status - - - - - - - -
200 OK
- -Headers- - - - - - - -
Content-Type : */*
Transfer-Encoding : chunked
Server : Jetty(6.1.x)
- -Text - - - - - - - - -
Hello steve

2.1.7. Deploy to Sandbox, Undeploy from Sandbox, Run in Sandbox

Note

This function is for users with both developer and administrator role.

Deploy to Sandbox

In eXo IDE, developers can secure deploy untested REST Service for testing in an isolated environment named Sandbox. Do this by following either of two ways below:

• Click on the toolbar;

• Or, go to Run → Deploy to Sandbox from the top menu.

Undeploy from Sandbox

• Click on the toolbar;

• Or, go to Run → Undeploy from Sandbox from the top menu.

Note

You cannot deploy REST Services that were previously deployed by other users.

Run in Sandbox

To run the REST Service faster, you can use the special command Run → Run in Sandbox which is a sequence of next operations: Save, Deploy to Sandbox, Undeploy from Sandbox, Launch REST Service. Do this by following either of two ways below:

• Click at the right corner of the toolbar;

• Or, go to Run → Run in Sandbox from the top menu.

2.1.8. REST Service Discovery

In the eXo IDE, you can explore all REST Services which are available from the server. To open the REST Service Discovery form, go to Help → REST Service Discovery... from the top menu.

2.1.9. Configure classpath

The classpath configuration means the setting of paths to the source files or folders. This class path will be used for project sources compilation. Classpath file is located in the root of the project's directory, but it is not visible in the browser tree because it cannot be directly edited by user.

View the sources paths of the project

1. Select the created project item in the Workspace pane.

2. Go to File → Configure Classpath... from the top menu to open the Configure Classpath form as below:

3. Add or remove source in the tree.

4. Click Save save changes in the classpath configuration, or Cancel to discard changes.

Note

If the selected item in the Workspace pane is not a project or a part of it, you will get an error message.

Add sources to classpath

1. Click Add... in the Configure Classpath form to open the Choose source path form.

2. Select one or more sources in the tree.

3. Click OK.

Tip

Use the CTRL key to select more than one item in the tree.

Note

The OK button is disabled if the workspace root folder is selected in the Choose source path form.

Remove sources from classpath

To remove source(s) from project's classpath, select source(s) in the tree of the Configure Classpath form and click Remove.

Note

The Remove button is disabled if there is no source selected in the tree.

// simple groovy script
import javax.ws.rs.Path
import javax.ws.rs.POST
import javax.ws.rs.Produces
import javax.ws.rs.Consumes
import javax.ws.rs.PathParam
import javax.ws.rs.HeaderParam
import javax.ws.rs.QueryParam

@Path("/testMediaTypes")
public class TestService {
  @POST
  @Consumes("application/xml")

  @Produces("text/html")
  @Path("InnerPath/{pathParam}")
  public String post1(@PathParam("pathParam") String pathParam,
    @HeaderParam("Test-Header1") String testHeader,
    @QueryParam("Test Query Parameter 1") String testQueryParam,
    String body) {
      return "PathParam 1:" + pathParam + "; Test Query Parameter 1: " + testQueryParam
      + "; Test-Header1: " + testHeader + "; Body: " + body;
  }

  @POST
  @Consumes("application/xml")

  @Produces("application/json")
  @Path("InnerPath/{pathParam}")
  public String post2(@PathParam("pathParam") String pathParam,
    @HeaderParam("Test-Header2") String testHeader,
    @QueryParam("Test Query Parameter 2") String testQueryParam,
    String body) {
      return "PathParam 2:" + pathParam + "; Test Query Parameter 2: " + testQueryParam
      + "; Test-Header2: " + testHeader + "; Body: " + body;
  }

}

<application xmlns="http://research.sun.com/wadl/2006/10">

   <resources base="http://192.168.0.8:8080/rest">

      <resource path="/testMediaTypes">

         <method name="OPTIONS">

            <response>

               <representation mediaType="application/vnd.sun.wadl+xml"/>

            </response>

         </method>

         <resource path="InnerPath/{pathParam}">

            <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="pathParam" style="template" type="xs:string"/>

            <method id="post1" name="POST">

               <request>

                  <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Test-Header1" style="header" type="xs:string"/>

                  <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Test Query Parameter 1" style="query" type="xs:string"/>

                  <representation mediaType="application/xml"/>

               </request>

               <response>

                  <representation mediaType="text/html"/>

               </response>

            </method>

            <method id="post2" name="POST">

               <request>

                  <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Test-Header2" style="header" type="xs:string"/>

                  <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Test Query Parameter 2" style="query" type="xs:string"/>

                  <representation mediaType="application/xml"/>

               </request>

               <response>

                  <representation mediaType="application/json"/>

               </response>

            </method>

         </resource>

      </resource>

   </resources>

</application>

"/testMediaTypes/InnerPath/{pathParam}"

[OUTPUT] - -Status - - - - - - - -
200 OK
- -Headers- - - - - - - -
Server : Apache-Coyote/1.1
Content-Type : text/html
Transfer-Encoding : chunked
Date : Mon, 05 Jul 2010 09:06:55 GMT
- -Text - - - - - - - - -
PathParam 1:value1; Test Query Parameter 1: value2; Test-Header1: value3; Body: example

Create a Google Gadget

To create the Google Gadget within eXo IDE, do one of the following ways:

The first way: Click on the toolbar and then select Google Gadget from the drop-down menu.

The second way: Go to File → New → Google Gadget from the top menu.

The third way: Open the existing gadget from the local system by going to File → Open Local File from the top menu.

The forth way: Upload the existing gadget directly to JCR by going to File → Upload File... from the top menu.

For the third and forth way, you must select the MIME type: "application/x-google-gadget".

Preview a Google Gadget

1. Open your desired Google Gadget file which was previously saved.

2. Click on the toolbar;

Or, go to Run → Show Preview from the top menu.

The gadget is opened in the Gadget Container of the Preview tab as described in the Google Gadget Operations illustration above.

See also

Create and Edit a template

1. Click on the toolbar and then select Template from the drop-down menu; or select File → New → Template from the top menu. A new file is opened in the editor.

2. Add content.

3. Save the file by selecting File → Save As from the top menu, or by clicking on the toolbar.

Both Outline pane and Auto-complete form can be used to edit the Groovy Template.

View template's properties

To view properties of the template, click on the right corner of the toolbar.

Preview a template

1. Open your desired Groovy template in the Content pane.

2. Click on the toolbar;

Or, go to Run → Show Preview from the top menu.

The selected template is opened in the Gadget Container of the Preview tab as below:

See also

The Netvibes widget uses Universal Widget API (UWA) - a powerful framework for Web widgets development - for both Netvibes widgets and many various environments.

The UWA widget consists of combinations from XHTML/XML, JavaScript/Ajax, CSS code with the MIME type application/x-uwa-widget. In eXo IDE, you can create the Netvibes widget, preview it and deploy to the Netvibes Ecosystem.

Create Netvibes widget

Click on the toolbar and then select Netvibes Widget from the drop-down menu;

Or, go to File → Netvibes Widget from the top menu.

The new Netvibes widget file is opened in the editor, enabling you to edit and save it.

Preview Netvibes widget

1. Open your desired widget file in the Content pane.

2. Click on the toolbar;

Or, go to Run → Show Preview from the top menu.

The selected widget is opened in the Preview tab.

Deploy Netvibes widget to Netvibes Ecosystem

Netvibes widgets are placed in the remote system called Netvibes Ecosystem. This is the location where such widgets can be found and compiled for other platforms.

There are a couple of ways to deploy a Netvibes widget. You can do it manually, or use the deployment mechanism. Manual deployment is easier because you do not need to get an API key from Netvibes.

Manual deployment

1. Get the URL of your Netvibes widget by selecting your widget, then clicking View → Get URL. Copy the URL.

2. Go to the Netvibes Ecosystem, click Create or submit and Submit Widget.

3. Paste the URL of your gadget, and don not forget to remove the /private part from it. If you do not do this, Netvibes will not be able to access it.

4. Fill in the form and finish the process. The widget is now available in the ecosystem.

Deploy UWA widget:

1. Get the URL of your netvibes widget. To do this, select your widget and click View → Get URL from the menu. Copy the URL.

2. Click on the toolbar;

Or, go to Run → Deploy UWA widget on the top menu to open the Deploy UWA widget to Ecosystem form:

3. Paste the URL of your gadget, and do not forget to remove the "/private" part from it, or netvibes will not be able to access it.

4. Enter the information about the widget in the fields in the Step 2 form. All fields marked with asterisk (*) are required..

Click Next after completing your details.

5. Enter your netvibes credentials and the API key/secret that netvibes gave you by email. All these fields are mandatory.

Details:

6. Click to start deploying the widget to the Netvibes Ecosyste.

The result is displayed in the Output pane. If the deployment is successful, you will receive the message below:

[INFO]*[http://78.137.4.16:53081/rest/ide-vfs-webdav/repository/dev-monit/TestWidget.html] deployed successfully.

If unsuccessful, you will receive the error message which varies, depending on each case.

[ERROR] Error: The link already exists.

View Netvibes documentation

There is a convenient way to view the developer's documentation, while creating your widget in eXo IDE. When opening Netvibes widget in editor, click Show Documentation on the toolbar or go to View → Documentation.

Top menu item and a pane with loaded documentation will be opened at the right part of the application.

See also

Create a Data Object

Click → Data Object;

Or, go to File → New → Data Object from the top menu.

Your newly created file will be opened in editor, so you will be able to edit and save it.

Preview a Node Type

1. Click on the Toolbar;

Or, go to Run → Preview node type from the top menu.

2. Select a node type format in the appeared form:

3. Click Generate. The generated node type definition will be displayed in the separate tab of Operation pane with title Preview node type:

Create a Node Type

1. Click on the toolbar;

Or, go to Run → Deploy node type from the top menu.

2. Select a required node type format in the Deploy Node Type form.

3. Select the action in case such node type already exists:

4. Click Deploy.

If the node type has been deployed successfully, you will see the message Node type is successfully deployed. Otherwise, the error message will be shown.

See also