I was able to get the Blade Rest Example running.
I used the following basic liferay setup for the REST Example:
Steps to reproduce:
Hint:
I personally use a DHC REST Client Browser Extention for debugging my REST API.
@Kevin Matthews:
I also analysed your bladeRest.zip file and probably found the reason why our REST example is not working:
You're using @Path("/blade.users") instead of @ApplicationPath("/blade.users") as the class annotation. That's fixed in the newer Version of the blade example project
Have a look an the latest version of UserRestService and edit the class header with:
Give in another try then
I used the following basic liferay setup for the REST Example:
- Liferay Community Edition Portal 7.0.2 GA3 (Wilberforce / Build 7002 / August 5, 2016) bundled with Tomcat
- Eclipse Liferay IDE Latest release 3.0.1 (June 2016) with an new empty eclipse workspace
Steps to reproduce:
- Inside Eclipse, generate a fresh clean liferay-workspace and setup the download liferay bundle as the server runtime environment.
- startup the liferay-ce-portal-7.0-ga3 server in debug mode (to see possible problems in the console)
- Download or git clone the Blade Rest Example project
- Copy the Blade Rest Example project into the modules directory in you liferay-workspace, for example:
C:\DEV\WORKSPACE_LIFERAY7_GA2\my-liferay-workspace\modules\blade.rest - Inside the Eclipse IDE, click on the liferay-workspace project --> Gradle --> Refresh Gradle Project
- You should see the blade.rest project now as an eclipse project and can can build and deploy it to your liferay portal server --> Gradle Task --> "deploy"
You should see an INFO Message from the servers console simliar to this:16:49:17,231 INFO [fileinstall-C:/opt/Liferay/liferay-ce-portal-7.0-ga3/osgi/modules][BundleStartStopLogger:35] STARTED blade.rest_1.0.0 [548] - Make sure that the gradle deployment to the liferay portal server worked properly, there are no errors in the console and you'll see the generated blade.rest.jar in the osgi modules folder from your portal server. For example, the *.jar should be deployed at
C:\opt\Liferay\liferay-ce-portal-7.0-ga3\osgi\modules\blade.rest.jar - Check twice via Apache Felix Gogo Shell Console if the blade.rest.jar is running as an active OSGi Bundle. Therefore, in Eclipse rightclick on your liferay-ce-portal-7.0-ga3 server and chosse in the context menu --> Open GoGo Shell
Use the lb command to check the statusg! lb rest START LEVEL 20 ID|State |Level|Name 129|Active | 10|Liferay Dynamic Data Mapping Data Provider REST (2.0.3) 279|Active | 10|Liferay Portal Remote REST Extender (2.0.3) 547|Active | 10|blade.rest (1.0.0)
In case you have the same problem I had, it can somtimes happen that there are more then one blade.rest modules from older deployments...In that case you can uninstall them via the command uninstall <processID>. So for the given example above you can deinstall the old osgi module withg! uninstall 547 - Now we open our portal in a webbrowser and sign in as admin user (default is test@liferay.com) and configure the CFX Endpoint:
(btw, this is the part I missunderstood in the offical tutorial section, cause I accidently thought CFX is only for webservices with SOAP)
Control Panel --> Stytem Settings --> Foundation --> CXF Endpoints --> Add Entry
As Context path we set an example url /rest-test
See screenshot: CXF_Endpoint_Setting.png - We also have to configure the REST Extender
Control Panel --> Stytem Settings --> Foundation --> REST Extender --> Add Entry
Context paths: /rest-test
jaxrs.applications.filters: (jaxrs.application=true)
My misstake was here, that I did not know that the param need to be with configured with parentesis (...)
See screenshot: Liferay_REST_Extender_Settings.png - Final Step:
If you don't see any errors in the console, you should be now able to call the configured REST API by the following url
http://localhost:8080/o/rest-test/blade.users/list/
Hint:
I personally use a DHC REST Client Browser Extention for debugging my REST API.
@Kevin Matthews:
I also analysed your bladeRest.zip file and probably found the reason why our REST example is not working:
You're using @Path("/blade.users") instead of @ApplicationPath("/blade.users") as the class annotation. That's fixed in the newer Version of the blade example project
Have a look an the latest version of UserRestService and edit the class header with:
@ApplicationPath("/blade.users")
@Component(
immediate = true, property = {"jaxrs.application=true"},
service = Application.class
)
public class UsersRestService extends Application {...}
Give in another try then
I followed all your steps, double check twice but it doesn't works. I have downloaded the code from liferay blade sample (no change). Just deployed, it appear active but... when I tried to hit the url it takes me to the REST Extender page (which is weird)
A. Rock:
I was able to get the Blade Rest Example running.
I used the following basic liferay setup for the REST Example:
- Liferay Community Edition Portal 7.0.2 GA3 (Wilberforce / Build 7002 / August 5, 2016) bundled with Tomcat
- Eclipse Liferay IDE Latest release 3.0.1 (June 2016) with an new empty eclipse workspace
Steps to reproduce:
- Inside Eclipse, generate a fresh clean liferay-workspace and setup the download liferay bundle as the server runtime environment.
- startup the liferay-ce-portal-7.0-ga3 server in debug mode (to see possible problems in the console)
- Download or git clone the Blade Rest Example project
- Copy the Blade Rest Example project into the modules directory in you liferay-workspace, for example:
C:\DEV\WORKSPACE_LIFERAY7_GA2\my-liferay-workspace\modules\blade.rest- Inside the Eclipse IDE, click on the liferay-workspace project --> Gradle --> Refresh Gradle Project
- You should see the blade.rest project now as an eclipse project and can can build and deploy it to your liferay portal server --> Gradle Task --> "deploy"
You should see an INFO Message from the servers console simliar to this:16:49:17,231 INFO [fileinstall-C:/opt/Liferay/liferay-ce-portal-7.0-ga3/osgi/modules][BundleStartStopLogger:35] STARTED blade.rest_1.0.0 [548]- Make sure that the gradle deployment to the liferay portal server worked properly, there are no errors in the console and you'll see the generated blade.rest.jar in the osgi modules folder from your portal server. For example, the *.jar should be deployed at
C:\opt\Liferay\liferay-ce-portal-7.0-ga3\osgi\modules\blade.rest.jar- Check twice via Apache Felix Gogo Shell Console if the blade.rest.jar is running as an active OSGi Bundle. Therefore, in Eclipse rightclick on your liferay-ce-portal-7.0-ga3 server and chosse in the context menu --> Open GoGo Shell
Use the lb command to check the statusg! lb rest START LEVEL 20 ID|State |Level|Name 129|Active | 10|Liferay Dynamic Data Mapping Data Provider REST (2.0.3) 279|Active | 10|Liferay Portal Remote REST Extender (2.0.3) 547|Active | 10|blade.rest (1.0.0)
In case you have the same problem I had, it can somtimes happen that there are more then one blade.rest modules from older deployments...In that case you can uninstall them via the command uninstall <processID>. So for the given example above you can deinstall the old osgi module withg! uninstall 547- Now we open our portal in a webbrowser and sign in as admin user (default is test@liferay.com) and configure the CFX Endpoint:
(btw, this is the part I missunderstood in the offical tutorial section, cause I accidently thought CFX is only for webservices with SOAP)
Control Panel --> Stytem Settings --> Foundation --> CXF Endpoints --> Add Entry
As Context path we set an example url /rest-test
See screenshot: CXF_Endpoint_Setting.png- We also have to configure the REST Extender
Control Panel --> Stytem Settings --> Foundation --> REST Extender --> Add Entry
Context paths: /rest-test
jaxrs.applications.filters: (jaxrs.application=true)
My misstake was here, that I did not know that the param need to be with configured with parentesis (...)
See screenshot: Liferay_REST_Extender_Settings.png- Final Step:
If you don't see any errors in the console, you should be now able to call the configured REST API by the following url
http://localhost:8080/o/rest-test/blade.users/list/
Hint:
I personally use a DHC REST Client Browser Extention for debugging my REST API.
@Kevin Matthews:
I also analysed your bladeRest.zip file and probably found the reason why our REST example is not working:
You're using @Path("/blade.users") instead of @ApplicationPath("/blade.users") as the class annotation. That's fixed in the newer Version of the blade example project
Have a look an the latest version of UserRestService and edit the class header with:@ApplicationPath("/blade.users") @Component( immediate = true, property = {"jaxrs.application=true"}, service = Application.class ) public class UsersRestService extends Application {...}
Give in another try then
I am trying to test the same on LR 7.1 GA2 CE, configured exactly as mentioned by A.Rock. I am getting below error message in console
2018-12-27 17:32:23.566 WARN [http-nio-8080-exec-6][ServletController:88] Can't find the request for http://localhost:8080/o/rest-test/users/list's Observer
Please let me know If anybody able to test it recently, any pointers much helpful