de.sekmi.li2b2.services.AbstractPMService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of li2b2-server Show documentation
This project emulates the core components of an i2b2 server backend. Basic functionality of PM, CRC, ONT and WORK cells allows the official i2b2 webclient to connect ot this emulated server.
The newest version!
package de.sekmi.li2b2.services;

import java.io.InputStream;
import java.util.logging.Logger;

import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
import javax.xml.bind.JAXBException;
import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.DOMException;
import org.w3c.dom.Element;

import de.sekmi.li2b2.api.pm.User;
import de.sekmi.li2b2.hive.Credentials;
import de.sekmi.li2b2.hive.HiveException;
import de.sekmi.li2b2.hive.HiveMessage;
import de.sekmi.li2b2.hive.HiveRequest;
import de.sekmi.li2b2.hive.HiveResponse;
import de.sekmi.li2b2.hive.I2b2Constants;
import de.sekmi.li2b2.services.impl.pm.ParamHandler;

public abstract class AbstractPMService extends AbstractService{

	private static final Logger log = Logger.getLogger(AbstractPMService.class.getName());
	public static final String SERVICE_PATH="/i2b2/services/PMService/";
	
	public AbstractPMService() throws HiveException {
		super();
	}

	protected Response handleRequest(InputStream requestBody, UriInfo uri) throws HiveException, ParserConfigurationException{
		HiveRequest req = parseRequest(requestBody);
		Element body = (Element)req.getMessageBody().getFirstChild();
		
		HiveResponse resp = createResponse(req);
		if( !body.getNamespaceURI().equals(I2b2Constants.PM_NS) ){
			String message = "Request body content without PM namespace";
			log.warning(message);
			resp.setResultStatus("ERROR", message);
		}else try {
			User user;
			String type = body.getLocalName();
			// separate handling of get_user_configuration, which does direct (password) authentication
			// only generate session for calls to get_user_configuration
			user = accessUserByCredentials(req.getSecurity());
			if( user == null ) {
				// invalid credentials/token
				resp.setResultStatus("ERROR", "Invalid credentials");
			}else {
				request(uri, user, req, type, body, resp);
			}
		} catch (DOMException | JAXBException e) {
			resp.setResultStatus("ERROR", e.toString());
		}
		return Response.ok(compileResponseDOM(resp)).build();
	}
	private HiveResponse createResponse(HiveRequest request) throws ParserConfigurationException{
		return createResponse(newDocumentBuilder(), request);
	}

	/**
	 * Handle authenticated project management request.
	 * @param uri info about the HTTP call
	 * @param user authenticated user object
	 * @param request request object
	 * @param type type of request. This is the local element name of the first child of the message_body element.
	 * @param body request body. This is the first child element of the message_body element.
	 * @param response response to be sent to the client
	 * @throws DOMException DOM error
	 * @throws JAXBException JAXB serialization error
	 */
	private void request(UriInfo uri, User user, HiveRequest request, String type, Element body, HiveResponse response) throws DOMException, JAXBException{
		log.info("PM request: "+type);
		// user info from authentication is in request.getUserId()
		
		if( type.equals("get_user_configuration") ) {
			String projectId = body.getElementsByTagName("project").item(0).getTextContent();
			getUserConfiguration(user, request, response, projectId, uri);
			return;
		}else if( type.equals("set_password") ){
			// called if the user wants to change his password
			// this method can be called by any user
			String password = body.getTextContent();
			// webclient will add spaces around the password, trim the password
			password = password.trim();
			setPassword(response, request.getSecurity(), password);
			return;
		}
		
		// all other methods require ADMIN privileges
		if( user.isAdmin() == false ) {
			response.setResultStatus("ERROR", "Access denied for users without ADMIN privileges");
			return;
		}

		if( type.equals("get_all_project") ){
			// called to list all projects
			getAllProject(response);

		}else if( type.equals("get_project") ){
			// called when a project is selected
			String projectId = body.getAttribute("id");
			String path = body.getElementsByTagName("path").item(0).getTextContent();
			getProject(response, projectId, path);

		}else if( type.equals("get_all_role") ){
			// called for the node 'users' within a project
			// get all user roles for the given project id
			String userId = HiveMessage.optionalElementContent(body, "user_name");
			String projectId = HiveMessage.optionalElementContent(body, "project_id");
			getAllRoles(response, projectId, userId);

		}else if( type.equals("delete_role") ){
			String userId = HiveMessage.optionalElementContent(body, "user_name");
			String role = HiveMessage.optionalElementContent(body, "role");
			String projectId = HiveMessage.optionalElementContent(body, "project_id");
			deleteRole(response, userId, role, projectId);

		}else if( type.equals("set_role") ){
			String userId = HiveMessage.optionalElementContent(body, "user_name");
			String role = HiveMessage.optionalElementContent(body, "role");
			String projectId = HiveMessage.optionalElementContent(body, "project_id");
			setRole(response, userId, role, projectId);

		}else if( type.equals("get_all_project_param") ){
			// called for the node 'params' within a project
			String projectId = body.getTextContent().trim();
			getProjectParamHandler().allParamsResponse(response, projectId);

		}else if( type.equals("get_project_param") ) {
			// called when adding a user param
			String paramId = body.getTextContent().trim();
			getProjectParamHandler().getParamResponse(response, paramId);

		}else if( type.equals("delete_project_param") ) {
			// called when adding a user param
			String paramId = body.getTextContent().trim();
			getProjectParamHandler().deleteParamResponse(response, paramId);

		}else if( type.equals("set_project_param") ) {
			String projectId = body.getAttribute("id");
//			String userId = HiveMessage.optionalElementContent(body, "user_name");
			Element param = (Element)body.getElementsByTagName("param").item(0);
			getProjectParamHandler().setParamResponse(response, param, projectId);

		// SECTION Hive
		}else if( type.equals("get_all_hive") ){
			// called when the Hive section is opened
			getAllHive(response);

		}else if( type.equals("get_all_global") ){
			// called when the the "Global Params" subtree of the Hive section is opened
			// return global parameters
			String path = body.getTextContent();
			// no obvious effect or function of path argument, ignore for now
			path.length();			
			getGlobalParamHandler().allParamsResponse(response);

		}else if( type.equals("set_global") ){
			HiveMessage.optionalElementContent(body,"project_path");
			HiveMessage.optionalElementContent(body,"can_override");
			Element param = (Element)body.getElementsByTagName("param").item(0);
			getGlobalParamHandler().setParamResponse(response, param);

		}else if( type.equals("get_global") ) {
			// called when adding a user param
			String paramId = body.getTextContent().trim();
			getGlobalParamHandler().getParamResponse(response, paramId);

		}else if( type.equals("delete_global") ) {
			// called when adding a user param
			String paramId = body.getTextContent().trim();
			getGlobalParamHandler().deleteParamResponse(response, paramId);


		// SECTION Cells
		}else if( type.equals("get_all_cell") ){
			// called when the Cells section is opened
			String projectId = body.getElementsByTagName("project").item(0).getTextContent();
			// typically empty
			getAllCells(response, projectId);
		}else if( type.equals("get_cell") ){
			// called when a cell is clicked in the admin tree
			String id = body.getAttribute("id");
			String path = body.getElementsByTagName("project_path").item(0).getTextContent();
			getCell(response, id, path);
		}else if( type.equals("get_all_cell_param") ){
			// called when clicked on "Params" subtree of a cell
			// returns a list of associated parameters
			String id = body.getAttribute("id");
			String path = body.getElementsByTagName("project_path").item(0).getTextContent();
			getCell(response, id, path);

		// SECTION Users
		}else if( type.equals("get_all_user") ){
			// called when the Users section is opened
			getAllUsers(response);

		}else if( type.equals("get_user") ){
			// called to display user details
			String userId = body.getTextContent().trim();
			getUser(response, userId);

		}else if( type.equals("delete_user") ){
			// called to display user details
			String userId = body.getTextContent().trim();
			deleteUser(response, userId);

		}else if( type.equals("set_user") ){
			// called to add/update user
			String userId = HiveMessage.optionalElementContent(body, "user_name");
			String fullName = HiveMessage.optionalElementContent(body, "full_name");
			String email = HiveMessage.optionalElementContent(body, "email");
			if( email != null && email.length() == 0 ){
				email = null;
			}
			String isAdmin = HiveMessage.optionalElementContent(body, "is_admin");
			boolean admin = false;
			if( isAdmin != null && isAdmin.equals("true") ){
				admin = true;
			}
			String password = HiveMessage.optionalElementContent(body, "password");
			
			setUser(response, userId, fullName, email, admin, password);
		}else if( type.equals("set_user_param") ) {
			// called when adding a user param
			String userId = HiveMessage.optionalElementContent(body, "user_name");			
			Element param = (Element)body.getElementsByTagName("param").item(0);
			getUserParamHandler().setParamResponse(response, param, userId);

		}else if( type.equals("get_user_param") ) {
			// called when adding a user param
			String paramId = body.getTextContent().trim();
			getUserParamHandler().getParamResponse(response, paramId);

		}else if( type.equals("delete_user_param") ) {
			// called when adding a user param
			String paramId = body.getTextContent().trim();
			getUserParamHandler().deleteParamResponse(response, paramId);

		}else if( type.equals("get_all_user_param") ) {
			// called when the Params subtree for a user is opened
			String userId = HiveMessage.optionalElementContent(body, "user_name");
			getUserParamHandler().allParamsResponse(response, userId);

		}else if( type.equals("get_all_project_user_param") ) {
			// called when the Params subtree for a user is opened
			String projectPath = HiveMessage.optionalElementContent(body, "path");
			String userId = HiveMessage.optionalElementContent(body, "user_name");
			getProjectUserParamHandler().allParamsResponse(response, projectPath, userId);

		}else if( type.equals("get_project_user_param") ) {
			String paramId = body.getTextContent().trim();
			getProjectUserParamHandler().getParamResponse(response, paramId);

		}else if( type.equals("delete_project_user_param") ) {
			String paramId = body.getTextContent().trim();
			getProjectUserParamHandler().deleteParamResponse(response, paramId);

		}else if( type.equals("set_project_user_param") ) {
			// called when adding a user param
			String userId = HiveMessage.optionalElementContent(body, "user_name");			
			String projectId = body.getAttribute("id");
			Element param = (Element)body.getElementsByTagName("param").item(0);
			getProjectUserParamHandler().setParamResponse(response, param, projectId, userId);

		}else if( type.equals("delete_user_param") ) {
			String paramId = body.getTextContent();
			getUserParamHandler().deleteParamResponse(response, paramId);

		}else if( type.equals("set_project") ){
			// called to add/update project
			String id = body.getAttribute("id");
			String name = HiveMessage.optionalElementContent(body, "name");
			String key = HiveMessage.optionalElementContent(body, "key");
			String wiki = HiveMessage.optionalElementContent(body, "wiki");
			String description = HiveMessage.optionalElementContent(body, "description");
			String path = HiveMessage.optionalElementContent(body, "path");
			
			setProject(response, id, name, key, wiki, description, path);
			
		}else{
			// return error
			response.setResultStatus("ERROR", "Method '"+type+"' not supported (yet)");
		}
	}


	protected abstract void deleteUser(HiveResponse response, String userId);
	protected abstract void setRole(HiveResponse response, String userId, String role, String projectId);
	protected abstract void deleteRole(HiveResponse response, String userId, String role, String projectId);
	protected abstract void setProject(HiveResponse response, String id, String name, String key, String wiki, String description,String path);
	protected abstract void setUser(HiveResponse response, String userId, String fullName, String email, boolean admin, String password);
	protected abstract void getAllProject(HiveResponse response);
	protected abstract void getProject(HiveResponse response, String projectId, String path);
	protected abstract void getAllRoles(HiveResponse response, String projectId, String userId);
	protected abstract void getAllHive(HiveResponse response);

	protected abstract void getAllCells(HiveResponse response, String projectId) throws JAXBException;
	protected abstract void getCell(HiveResponse response, String id, String path);

	protected abstract void getAllUsers(HiveResponse response);
	protected abstract void getUser(HiveResponse response, String userId);


	protected abstract void setPassword(HiveResponse Response, Credentials user, String newPassword);

	@Override
	public String getCellId() {
		return "PM";
	}

	protected abstract void getUserConfiguration(User user, HiveRequest request, HiveResponse response, String project, UriInfo uri) throws JAXBException;


	abstract ParamHandler getGlobalParamHandler();
	abstract ParamHandler getUserParamHandler();
	abstract ParamHandler getProjectUserParamHandler();
	abstract ParamHandler getProjectParamHandler();

	protected abstract User accessUserByCredentials(Credentials cred);
}