Module development: org.openmrs.api.APIException: Service not found

owais.hussain · April 25, 2015, 8:08am

Hi,

I’m creating a new module for CSV imports and trying to test it on a static main() method. I’m stuck with an exception. I get org.openmrs.api.APIException: Service not found exception whenever I try Context.getService(CsvImporterService.class);

My moduleApplication-context.xml has this bean, but I still get the following:

log4j:WARN No appenders could be found for logger (org.openmrs.util.OpenmrsUtil).
log4j:WARN Please initialize the log4j system properly.
INFO 4/25/15 1:05 PM:liquibase: Reading from `liquibasechangelog`
WARNING 4/25/15 1:05 PM:liquibase: modifyDataType will lose primary key/autoincrement/not null settings for mysql.  Use <sql> and re-specify all configuration if this is the case
INFO 4/25/15 1:05 PM:liquibase: liquibase.xml is using schema version 1.9 rather than version 2.0
INFO 4/25/15 1:05 PM:liquibase: Reading from `liquibasechangelog`
INFO 4/25/15 1:06 PM:liquibase: Successfully acquired change log lock
INFO 4/25/15 1:06 PM:liquibase: liquibase.xml is using schema version 1.9 rather than version 2.0
INFO 4/25/15 1:06 PM:liquibase: Successfully released change log lock
Exception in thread "main" org.openmrs.api.APIException: Service not found: interface org.openmrs.module.csvimporter.CsvImporterService
	at org.openmrs.api.context.ServiceContext.getService(ServiceContext.java:727)
	at org.openmrs.api.context.Context.getService(Context.java:914)
	at org.openmrs.module.csvimporter.CsvImporterMain.main(CsvImporterMain.java:70)

Can somebody suggest me where I’m wrong? Btw, I’m launching this as Java Application from class CsvImporterMain.java

ibewes · April 25, 2015, 8:21am

Greetings! Is the CsvImporterService a service that you have defined in your module? If so, did you create the bean definition to your service in the moduleApplicationContext.xml file?

owais.hussain · April 25, 2015, 9:20am

Thanks for responding Wesley, yes it’s a service and I’ve defined following bean in moduleApplicationContext.xml

<bean parent="serviceContext">
		<property name="moduleService">
			<list>
				<!-- service interface name. this is the "key" to look up our service 
					in Context.getService() -->
				<value>org.openmrs.module.csvimporter.CsvImporterService</value>
				<bean
					class="org.springframework.transaction.interceptor.TransactionProxyFactoryBean">
					<property name="transactionManager">
						<ref bean="transactionManager" />
					</property>
					<property name="target">
						<!-- This is our service class implementation that actually does the 
							business logic -->
						<bean class="org.openmrs.module.csvimporter.impl.CsvImporterServiceImpl">

							<!-- this calls csvImporterServiceImpl.setDao(new CsvImporterDAOImpl) -->
							<property name="dao">
								<bean
									class="org.openmrs.module.csvimporter.db.hibernate.CsvImporterDAOImpl">

									<!-- the "sessionFactory" object is provided by the applicationContext-service.xml 
										file in core openmrs -->
									<property name="sessionFactory">
										<ref bean="sessionFactory" />
									</property>
								</bean>
							</property>
						</bean>
					</property>

					<property name="preInterceptors">
						<!-- This is a list of AOP advice that wraps around each of the methods 
							in our CsvImporterServiceImpl -->
						<ref bean="serviceInterceptors" />
					</property>
					<property name="transactionAttributeSource">
						<bean
							class="org.springframework.transaction.annotation.AnnotationTransactionAttributeSource" />
					</property>
				</bean>
			</list>
		</property>
	</bean>

ibewes · April 25, 2015, 10:05am

Sorry… after reading your message more closely I see that you already mentioned about the moduleApplicationContext file.

Is the exception stack trace that you copied all that was logged? Also, It looks like you are attempting to get an instance of the service from a ‘main’ method. I assume that you’re trying to get this service instance when your module is starting up, is that correct? If so, you might want to try moving whatever logic you’ve got in main into your ModuleActivator class, in the appropriate method (ie, started). I wonder if your call is happening before everything is properly set up in OpenMRS and before your module services have been added to the OpenMRS services.

Hope that helps!

owais.hussain · April 25, 2015, 10:21am

Yes, you’re right. I’m trying this out in a main function. But my understanding is that when you call Context.startup(), that is where everything is set up properly. Here is what I’m trying:

try { Properties props = OpenmrsUtil.getRuntimeProperties(“openmrs”); String url = (String) props.get(“connection.url”); String username = (String) props.get(“connection.username”); String password = (String) props.get(“connection.password”); Context.startup(url, username, password, props); Context.openSession(); Context.authenticate(“owais”, “Jingle94$”); importerService = Context.getService(CsvImporterService.class); } catch (Exception e) { e.printStackTrace(); }

dkayiwa · April 25, 2015, 9:31pm

Did you put your module in the modules folder? Or did you supply your module’s path and file name in the runtime properties file via the key named “module.list_to_load”?

owais.hussain · April 27, 2015, 8:34am

Thanks for the response Daniel. I’m not exporting the module yet. I’m just trying to run it as a Java Application.

wyclif · April 27, 2015, 1:54pm

I was about to ask if you have checked that your module is started, but your last message implies your have not actually installed the module, you need to build the module and add it to the module repo in order to use its services.

k.joseph · January 5, 2016, 10:40am

This could be caused by the applicationContext file looking into a wrong project/(maven)module say for-example when your test is placed in api yet your moduleApplicationContext.xml may be in omod.

You can choose to take one of these three approaches to resolve this:

Move the moduleApplicationContext.xml file to the project/(maven)module where you have the test such as: api/src/main/resources/ if your test in under api
Move your test to the project/(maven)module where your moduleApplicationContext.xml
Separate your moduleApplicationContext.xml into two application context files one in api and the other in omod such that the paths to each of them as; api/src/main/resources/moduleApplicationContext.xml omod/src/main/resources/webModuleApplicationContext.xml one in api project/(maven)module contains service/api specific bean definitions only where as the other contains the rest. Examples can be found at:

I prefer the last or third one this way paths are righted

hariniparth · September 3, 2016, 3:38pm

Hello,

I am getting the same error - org.openmrs.api.APIException: Service not found Scenario - I am developing 2 interconnected modules - Drug Order and Pharmacy The Pharmacy module calls the service defined in Drug Order module

Context.getService(drugordersService.class).getDrugOrderByOrderID(order.getOrderId());

Initially, when I install the Pharmacy module - I get it right. i.e I am able to fetch the Drug Order I need. However, when I go back to the Drug Order page, I see the error. Subsequently, I find that just one of the modules work at a time while the other fails to load.

Here are the logs - http://pastebin.com/T6b2U0MW

Could you please suggest a way I can fetch the records from my “drugorder_extension” table that I define in my drugorders module - in my pharmacy module… Thank you!

dkayiwa · September 3, 2016, 5:51pm

How does your DrugordersFragmentController class look like. How about your moduleApplicationContext.xml file?

hariniparth · September 3, 2016, 8:32pm

This is the moduleApplicationContext file of my Pharmacy module

github.com

HariniParth/OpenMRS-Pharmacy/blob/master/api/src/main/resources/moduleApplicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
	xmlns:aop="http://www.springframework.org/schema/aop" xmlns:util="http://www.springframework.org/schema/util"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
  		    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  		    http://www.springframework.org/schema/context
  		    http://www.springframework.org/schema/context/spring-context-3.0.xsd
  		    http://www.springframework.org/schema/jee
  		    http://www.springframework.org/schema/jee/spring-jee-3.0.xsd
  		    http://www.springframework.org/schema/tx
  		    http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
  		    http://www.springframework.org/schema/aop
  		    http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
  		    http://www.springframework.org/schema/util
  		    http://www.springframework.org/schema/util/spring-util-3.0.xsd">

	<!-- Add here beans related to the API context -->

This file has been truncated. show original

My DrugordersFragmentController refers to the fragment on the Patient dashboard which displays the list of DrugOrders

github.com

HariniParth/OpenMRS-DrugOrders/blob/master/omod/src/main/java/org/openmrs/module/drugorders/fragment/controller/DrugordersFragmentController.java

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package org.openmrs.module.drugorders.fragment.controller;

import java.util.ArrayList;
import java.util.List;
import org.openmrs.Patient;
import org.openmrs.api.context.Context;
import org.openmrs.module.drugorders.api.drugordersService;
import org.openmrs.module.drugorders.drugorders;
import org.openmrs.ui.framework.annotation.FragmentParam;
import org.openmrs.ui.framework.fragment.FragmentModel;

/**
 *
 * @author harini-geek
 */

This file has been truncated. show original

dkayiwa · September 3, 2016, 8:40pm

I mean for the drug orders module.

hariniparth · September 3, 2016, 8:43pm

Thanks for the reply, here is the link to the moduleApplication file of the Drug Order Module

github.com

HariniParth/OpenMRS-DrugOrders/blob/master/api/src/main/resources/moduleApplicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
	xmlns:aop="http://www.springframework.org/schema/aop" xmlns:util="http://www.springframework.org/schema/util"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
  		    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  		    http://www.springframework.org/schema/context
  		    http://www.springframework.org/schema/context/spring-context-3.0.xsd
  		    http://www.springframework.org/schema/jee
  		    http://www.springframework.org/schema/jee/spring-jee-3.0.xsd
  		    http://www.springframework.org/schema/tx
  		    http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
  		    http://www.springframework.org/schema/aop
  		    http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
  		    http://www.springframework.org/schema/util
  		    http://www.springframework.org/schema/util/spring-util-3.0.xsd">

	<!-- Add here beans related to the API context -->

This file has been truncated. show original

dkayiwa · September 3, 2016, 8:55pm

Can we also look at your drug order service java file?

hariniparth · September 3, 2016, 8:56pm

github.com

HariniParth/OpenMRS-DrugOrders/blob/master/api/src/main/java/org/openmrs/module/drugorders/api/drugordersService.java

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.module.drugorders.api;

import java.util.List;
import org.openmrs.Concept;
import org.openmrs.Patient;
import org.openmrs.api.OpenmrsService;
import org.openmrs.module.drugorders.drugorders;
import org.springframework.transaction.annotation.Transactional;

/**
 * This service exposes module's core functionality. It is a Spring managed bean which is configured in moduleApplicationContext.xml.

This file has been truncated. show original

dkayiwa · September 3, 2016, 9:11pm

In the pharmacy module, add scope provided to the drug orders dependency.

hariniparth · September 3, 2016, 9:44pm

Thank you!! That fixed it!