This tutorial teaches you how to install the IDE extension from the Platform Enterprise Edition bundle, begin with a basic REST services, then an advance REST services from Forum\u2019s services methods.<\/p>\n
<\/p>\n
Requirement:<\/b>
\n– Platform 4 Enterprise Edition<\/p>\nInstalling the eXo Platform IDE<\/h2>\n
First, let\u2019s install IDE extension with comand .\/extension.sh -i ide<\/span> (in Linux, Mac) or extension.bat -i ide<\/span> (in Windows).<\/p>\n Then start Platform with .\/start_eXo.sh<\/span>, in top menu Administration > IDE is installed<\/p>\n Inside the IDE interface, when you first make a new REST service, a new untitled file groovy script \u201cgrs\u201d will create a hello world sample code<\/p>\n Then you go to Run > Validate<\/span><\/p>\n Output displays a successful validation<\/p>\n Run > Deploy<\/span> to deploy directly in Platform\u2019s server with my localhost:8080<\/span> and call parameter \u201ceXo<\/strong>\u201d, I can execute REST service \/rest\/my-service\/helloworld\/eXo<\/i><\/p>\n We can go deeper with REST service. Here in advance sample, I use mainly Forum source codes to display which user is online.<\/p>\n You copy this code into your current groovy script.<\/p>\n – Who is online sample:<\/p>\n For the full source, you can use the links below in reference: https:\/\/github.com\/exo-addons\/resource-center\/blob\/master\/ide-rest-gadget\/basic\/sample.grs<\/a><\/p>\n For more detail about the method to get online users, internal services, you can search in github sources: https:\/\/github.com\/exoplatform\/forum\/<\/a><\/p>\n Save > Run > Validate<\/span><\/p>\n Run > Deploy<\/span><\/p>\n Login with 2 users: root and john in two different browsers<\/p>\n Then call REST: \/rest\/my-service\/useronline<\/p>\n In this example, you will learn how to use a REST service (deployed with eXo IDE) from a gadget: create, deploy, run, import, and finally display it on a home page.<\/p>\n Source files: https:\/\/github.com\/exo-addons\/resource-center\/tree\/master\/ide-rest-gadget\/gadget<\/a><\/p>\n 1) Create a hierarchy folder and copy these files:<\/span><\/b><\/p>\n Right click on dev-monit<\/span> to create a subfolder name advance_tutorial<\/span><\/p>\n In folder advance_tutorial<\/span>, create sub folders js<\/span> (contains javascript), style<\/span> (contains CSS) then create Google Gadget, REST Service, CSS and Javascript files.<\/p>\n Hierarchy presentation:<\/b><\/p>\n – advance_tutorial<\/span> 2) Run, validate and deploy your WhosOnlineRestServices<\/span> and OnlineGadget<\/span><\/p>\n Console output<\/b><\/p>\n WhosOnlineRestServices<\/span><\/p>\n OnlineGadget<\/span><\/p>\n 3) Import your gadget: Administration > Application > Import Applications<\/p>\n 4) Add your gadget on the homepage: Go to home page > Edit > Page > Edit layout<\/p>\n Add your \u201cWho\u2019s Online Gadget at the top,\u201d then save it<\/p>\n 5) After that, your gadget is displayed in the home page<\/p>\n 6) Invite some users and accept connection!<\/p>\n 7) Your gadget will display your friends\u2019 connections when they are online<\/p>\n References:<\/span><\/b><\/p>\n – Download Platform 4: https:\/\/community.exoplatform.com<\/a> > eXo Platform 4.0 > Downloads<\/p>\n – IDE documentation: https:\/\/docs.exoplatform.org\/<\/a><\/p>\n – Forum sources: https:\/\/github.com\/exoplatform\/forum<\/a><\/p>\n – For more resources on IDE, you can follow these guides: – Full source of basic action: https:\/\/github.com\/exo-addons\/resource-center\/blob\/master\/ide-rest-gadget\/basic\/sample.grs<\/a><\/p>\n – Full source of gadget \u201cWho is online\u201d: https:\/\/github.com\/exo-addons\/resource-center\/tree\/master\/ide-rest-gadget\/gadget<\/a><\/p>\n <\/p>\nannb:platform-4> .\/extension.sh -i ide\n # ===============================\n # eXo Platform Extensions Manager\n # ===============================\n\nInstalling ide extension ...\n [copy] Copying 6 files to \/home\/annb\/platform-4\/lib\n [copy] Copying \/home\/annb\/platform-4\/extensions\/ide\/lib\/exo-ide-extension-chromattic-server-1.3.x-SNAPSHOT.jar to \/home\/annb\/platform-4\/lib\/exo-ide-extension-chromattic-server-1.3.x-SNAPSHOT.jar\n...\n...\n [copy] Copying \/home\/annb\/platform-4\/extensions\/ide\/webapps\/ide-extension.war to \/home\/annb\/platform-4\/webapps\/ide-extension.war\nDone.\n\n # ===============================\n # Extension ide installed.\n # ===============================\nannb:platform-4><\/pre>\n
annb:platform-4> .\/start_eXo.sh<\/pre>\n
![\"01-IDE-Platform\"](\"\/blog\/wp-content\/uploads\/2014\/06\/01-IDE-Platform.png\")
<\/a><\/p>\nBasic Actions with REST services<\/h2>\n
<\/a><\/p>\n@GET\n@Path(\"helloworld\/{name}\")\npublic String hello(@PathParam(\"name\") String name) {\n return \"Hello my \" + name\n}<\/pre>\n<\/a><\/p>\n<\/a><\/p>\nimport org.exoplatform.forum.service.ForumService;\nimport org.exoplatform.commons.utils.CommonsUtils;\n\n\u2026\n\u2026\n\n @GET\n @Path(\"useronline\")\n public String whoisonline() {\n ForumService forumService = CommonsUtils.getService(ForumService.class);\n String resultUserOnline = \"\"; \n List<String> allOnlineUsers = forumService.getOnlineUsers();\n for (String user : allOnlineUsers){\n resultUserOnline = user + \", \" +resultUserOnline;\n } \n return resultUserOnline;\n }<\/pre>\n<\/a><\/p>\n<\/a><\/p>\nGadgets and REST services with the eXo Platform IDE<\/h2>\n
<\/a><\/p>\n<\/a><\/p>\n
\n— js<\/a>
\n— jquery.simpletip-1.3.1.min.js<\/a>
\n— style<\/a>
\n— online.css<\/a>
\n— OnlineGadget.xml<\/a>
\n— WhosOnlineRestServices.grs<\/a> (groovy script)<\/p>\n<\/a><\/p>\n[INFO] WhosOnlineRestServices.grs validated successfully.\n\n[INFO] \/rest\/private\/jcr\/repository\/dev-monit\/advance_tutorial\/WhosOnlineRestServices.grs deployed successfully.<\/pre>\n
[INFO] \/rest\/private\/ide\/gadget\/deploy?gadgetURL=http%3A%2F%2Flocalhost%3A8080%2Frest%2Fprivate%2Fjcr%2Frepository%2Fdev-monit%2Fadvance_tutorial%2FOnlineGadget.xml&privateContext=%2Frest%2Fprivate&publicContext=%2Frest deployed successfully.<\/pre>\n
<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n
\n– How to Build, Debug and Deploy Apps for Google App Engine with Cloud IDE
\n– How to Build a Mashup of Twitter and Flickr Feeds Using eXo Cloud IDE<\/a><\/p>\n