This scheduled job will log some dummy stats – basically what we’ll do is just a placeholder to demonstrate how to glue the REST API bricks together. Doing something more meaningful will be left as an exercise to the reader \ud83d\ude42<\/p>\n
Your scheduled job will list all mobile devices for all users for all domains of your BlueMind server. Just because you can. We’ll call it MobileDevicesListingJob<\/em>.<\/p>\n Don’t forget that when you’re using the REST API with a BlueMind server, you’re dealing with real users data and it’s pretty easy to make mistakes, since everything you can do in BlueMind can be done using the REST API. There won’t be a confirmation screen like we do in the Administration Console: when in doubt, just don’t. Or better: do your API tests on a sandbox server. We won’t be modifying data in this tutorial, so you should be safe, but you’ve been warned.<\/p>\n If you take a peep into BlueMind internals, it’s OSGi<\/a> bundles all over the place. Since we want to build a BlueMind add-on, we depend on BlueMind target platform.<\/p>\n This target platform is published as a p2 repository, and you can find it at http:\/\/pkg.blue-mind.net\/p2\/latest\/<\/a><\/p>\n As the URL implies, this is the latest and greatest BlueMind target platform. It will get updated every time we publish a new BlueMind release – and hopefully upgrading won’t break your work.<\/p>\n We’ll be using Tycho<\/a>, which makes it easy to build your bundles with maven. Here is the simplest project_structure<\/a>. Download it and extract it somewhere.<\/p>\n This project is restricted to the bare minimum. I won’t delve into the details of the configuration files since they are not BlueMind specific, but I want to emphasize two points:<\/p>\n The rest is just boilerplate configuration.<\/p>\n Alternatively, you could also use our maven archetype<\/a> to bootstrap your project. Or clone bluemind-samples<\/a> to find an existing add-on to adapt. There are more than one way to skin a cat. Or a duck. Well…<\/p>\n In the project directory, you can run:<\/p>\n Et voil\u00e0! You’ve built your project, but it won’t work yet: there’s no code.<\/p>\n You may just go ahead and write the java code using your favorite editor, but here is how you’ll do with Eclipse<\/a>:<\/p>\n Select all (the “Uncategorized” checkbox in the previous screenshot), click on Finish and you’re done. Careful, you need to select the target platform we’ve just defined before you close the Preferences window.<\/p>\n We need to declare what parts of the BlueMind target platform we’ll actually use in the MANIFEST.MF. Our REST API online documentation<\/a> for will help you to cherry-pick the parts you’ll need. If you’ve installed the optional bm-docs<\/em> package and given the Api docs<\/em> permission to your user, this documentation should be available right in the BlueMind UI:<\/p>\n Icing on the cake: this inline documentation is interactive, so you can execute calls using the javascript client. Beware, the previous caution notes also apply! (the harm you’ll be able to do depends on your logged-in user’s rights)<\/p>\n The BlueMind source code<\/a> is also be a good place to find inspiration.<\/p>\n Here are the dependencies we’ll need, just add these lines at the end of the MANIFEST.MF:<\/p>\n So go ahead and create the class we’ve declared in plugin.xml: org.example.mobiledeviceslistingjob.MobileDevicesListingJob<\/em>. It has to implement IScheduledJob<\/em> for scheduledjob_provider<\/em> to be able to plug it in. Here is the complete code<\/a>. I will only include here the actual business logic:<\/p>\n <\/p>\n You can compile this code with<\/p>\n Then drop the resulting jar (target\/org.example.mobiledeviceslistingjob-1.0.0-SNAPSHOT.jar) in the folder \/usr\/share\/bm-core\/extensions of your BlueMind server. Then you can restart bm-core<\/p>\n And your job should appear among the Scheduled Jobs in the Administration console. You can then execute it, schedule it, send the report to your best friend, it’s all yours.<\/p>\n Caveat<\/strong>: if you need to recompile\/redeploy your extension, you may need to delete bm-core’s cache to be sure the fresh jar is picked up:<\/p>\n You’ve noticed we’ve used a ServerSideServiceProvider to initialize the REST API services, but you can of course talk REST<\/a> from the outside world, for instance by using our python client. You need a BlueMind API key<\/a> to do so.<\/p>\nA word of caution<\/h3>\n
Bootstrapping a maven project<\/h3>\n
\n
mvn install<\/pre>\n
Eclipse to the rescue<\/h3>\n
\n
![\"screenshot-from-2017-03-29-17-43-39\"](\"https:\/\/bluemind.purpl-web.com\/wp-content\/uploads\/2017\/03\/screenshot-from-2017-03-29-17-43-39.png\")
<\/p>\nSetting up the dependencies<\/h3>\n
![\"screenshot-from-2017-03-30-09-36-52\"](\"https:\/\/bluemind.purpl-web.com\/wp-content\/uploads\/2017\/03\/screenshot-from-2017-03-30-09-36-52.png\")
<\/p>\nRequire-Bundle: net.bluemind.domain.api,\n net.bluemind.user.api,\n net.bluemind.device.api,\n net.bluemind.scheduledjob.scheduler,\n net.bluemind.core.rest,\n net.bluemind.slf4j<\/pre>\n
\n
Have fun with the REST API<\/h3>\n
\/\/ logger will write in bm core logs (\/var\/log\/bm\/core.log)\nlogger.info(\"Executing MobileDevicesListingJob\");\n\/\/ sched will write in the execution report, that you can send by mail in the Job setup UI\nsched.info(slot, \"en\", \"Collecting mobile devices data for all users...\\n\");\n\/\/ write header row for the data to come\nsched.info(slot, \"en\", \"device; isWipe; lastSync; user; domain\");\n\/\/ initialize client for domain service\nIDomains domainService = ServerSideServiceProvider.getProvider(SecurityContext.SYSTEM)\n .instance(IDomains.class);\n\/\/ loop on all domains\ndomainService.all().stream().forEach(domain -> {\n \/\/ initialize client for user service\n IUser userService = ServerSideServiceProvider.getProvider(SecurityContext.SYSTEM)\n .instance(IUser.class, domain.uid);\n \/\/ loop on all users\n userService.allUids().stream().forEach(userUID -> {\n \/\/ grab full details for user\n ItemValue<User> user = userService.getComplete(userUID);\t\t\t\t\n \/\/ initialize device service for each user\n try {\n IDevice deviceService = ServerSideServiceProvider.getProvider(SecurityContext.SYSTEM)\n .instance(IDevice.class, userUID);\n \/\/ loop on all devices\n deviceService.list().values.stream().forEach(device -> {\n \/\/ collect info for this device\n List<String> deviceInfo = new ArrayList<>();\n deviceInfo.add(device.displayName);\n deviceInfo.add(Boolean.toString(device.value.isWipe));\n deviceInfo.add(device.value.lastSync.toString());\n deviceInfo.add(user.displayName);\n deviceInfo.add(domain.displayName);\n \/\/ write a line in the report\t\t\t\t\t\n sched.info(slot, \"en\", String.join(\"; \", deviceInfo));\n });;\n } catch (ServerFault exception){\n \/\/ Skipping this user since she doesn't have a \"device\" container\n }\n });\n});<\/pre>\nDeploy to your BlueMind server<\/h3>\n
mvn clean install<\/pre>\n
\/etc\/init.d\/bm-core restart<\/pre>\n
rm -Rf \/var\/lib\/bm-core<\/pre>\n
Talking REST from the outside world<\/h3>\n
Share your work!<\/h3>\n