de.lemo.apps.restws.client.InitialisationImpl.java Source code

Java tutorial

Introduction

Here is the source code for de.lemo.apps.restws.client.InitialisationImpl.java

Source

/**
 * File ./src/main/java/de/lemo/apps/restws/client/InitialisationImpl.java
 * Lemo-Application-Server for learning analytics.
 * Copyright (C) 2015
 * Leonard Kappe, Andreas Pursian, Sebastian Schwarzrock, Boris Wenzlaff
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
**/

package de.lemo.apps.restws.client;

import java.io.IOException;
import java.util.Date;
import java.util.List;

import javax.ws.rs.core.Response;

import org.apache.commons.httpclient.HttpStatus;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.HttpClient;
import org.apache.http.conn.ConnectionPoolTimeoutException;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.conn.PoolingClientConnectionManager;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
import org.apache.tapestry5.StreamResponse;
import org.apache.tapestry5.json.JSONObject;
import org.apache.tapestry5.util.TextStreamResponse;
import org.jboss.resteasy.client.ClientExecutor;
import org.jboss.resteasy.client.ClientRequest;
import org.jboss.resteasy.client.ClientResponse;
import org.jboss.resteasy.client.ProxyFactory;
import org.jboss.resteasy.client.core.executors.ApacheHttpClient4Executor;
import org.jboss.resteasy.plugins.providers.RegisterBuiltin;
import org.jboss.resteasy.spi.ResteasyProviderFactory;
import org.slf4j.Logger;

import de.lemo.apps.application.config.ServerConfiguration;
import de.lemo.apps.exceptions.RestServiceCommunicationException;
import de.lemo.apps.restws.entities.CourseObject;
import de.lemo.apps.restws.entities.ResultListCourseObject;
import de.lemo.apps.restws.entities.ResultListLongObject;
import de.lemo.apps.restws.entities.ResultListStringObject;
import de.lemo.apps.restws.proxies.service.ServiceConnectorManager;
import de.lemo.apps.restws.proxies.service.ServiceCourseDetails;
import de.lemo.apps.restws.proxies.service.ServiceLearningObjects;
import de.lemo.apps.restws.proxies.service.ServiceLearningTypes;
import de.lemo.apps.restws.proxies.service.ServiceLoginAuthentification;
import de.lemo.apps.restws.proxies.service.ServiceRatedObjects;
import de.lemo.apps.restws.proxies.service.ServiceStartTime;
import de.lemo.apps.restws.proxies.service.ServiceTaskManager;
import de.lemo.apps.restws.proxies.service.ServiceTeacherCourses;
import de.lemo.apps.restws.proxies.service.ServiceUserInformation;

public class InitialisationImpl implements Initialisation {

    public static final String DMS_BASE_URL = ServerConfiguration.getInstance().getDMSBaseUrl();
    private static final String SERVICE_BASE_URL = "/services";
    public static final String SERVICE_PREFIX_URL = DMS_BASE_URL + SERVICE_BASE_URL;
    private static final String SERVICE_STARTTIME_URL = SERVICE_PREFIX_URL + "/starttime";
    private static final String SERVICE_COURSE_URL = SERVICE_PREFIX_URL + "/courses";
    private static final String SERVICE_RATED_OBJECTS_URL = SERVICE_PREFIX_URL + "/ratedobjects";
    private static final String SERVICE_LEARNING_OBJECTS_URL = SERVICE_PREFIX_URL + "/learningobjects";
    private static final String SERVICE_LEARNING_TYPES_URL = SERVICE_PREFIX_URL + "/learningtypes";
    private static final String SERVICE_AUTH_URL = SERVICE_PREFIX_URL + "/authentification";
    private static final String SERVICE_USER_COURSES_URL = SERVICE_PREFIX_URL + "/teachercourses";
    private static final String SERVICE_CONNECTOR_MANAGER = SERVICE_PREFIX_URL + "/connectors";
    private static final String SERVICE_TASK_MANAGER = SERVICE_PREFIX_URL + "/tasks";

    private PoolingClientConnectionManager connectionManager = new PoolingClientConnectionManager();
    private HttpClient httpClient = new DefaultHttpClient(connectionManager);

    private HttpParams initHttpParams() {
        connectionManager.setDefaultMaxPerRoute(20);
        HttpParams params = this.httpClient.getParams();
        HttpConnectionParams.setConnectionTimeout(params, 5000);
        HttpConnectionParams.setSoTimeout(params, 5000);

        return params;
    }

    final HttpParams params = initHttpParams();

    private ClientExecutor clientExecutor = new ApacheHttpClient4Executor(httpClient);

    private ServiceCourseDetails courseDetailsList = ProxyFactory.create(ServiceCourseDetails.class,
            InitialisationImpl.SERVICE_COURSE_URL, clientExecutor);

    private ServiceCourseDetails courseDetails = ProxyFactory.create(ServiceCourseDetails.class,
            InitialisationImpl.SERVICE_COURSE_URL, clientExecutor);

    private ServiceRatedObjects ratedObjects = ProxyFactory.create(ServiceRatedObjects.class,
            InitialisationImpl.SERVICE_RATED_OBJECTS_URL, clientExecutor);

    private ServiceLearningObjects learningObjects = ProxyFactory.create(ServiceLearningObjects.class,
            InitialisationImpl.SERVICE_LEARNING_OBJECTS_URL, clientExecutor);

    private ServiceLearningTypes learningTypes = ProxyFactory.create(ServiceLearningTypes.class,
            InitialisationImpl.SERVICE_LEARNING_TYPES_URL, clientExecutor);

    private ServiceLoginAuthentification loginAuth = ProxyFactory.create(ServiceLoginAuthentification.class,
            InitialisationImpl.SERVICE_AUTH_URL, clientExecutor);

    private ServiceTeacherCourses teacherCourses = ProxyFactory.create(ServiceTeacherCourses.class,
            InitialisationImpl.SERVICE_USER_COURSES_URL, clientExecutor);

    private ServiceUserInformation userInfo = ProxyFactory.create(ServiceUserInformation.class,
            InitialisationImpl.SERVICE_PREFIX_URL, clientExecutor);

    private ServiceConnectorManager connectorManager = ProxyFactory.create(ServiceConnectorManager.class,
            InitialisationImpl.SERVICE_CONNECTOR_MANAGER, clientExecutor);

    private ServiceTaskManager taskManager = ProxyFactory.create(ServiceTaskManager.class,
            InitialisationImpl.SERVICE_TASK_MANAGER, clientExecutor);

    private Logger logger;

    public InitialisationImpl(Logger logger) {
        // Initialise the Rest session
        this.logger = logger;
        this.logger.debug("Register Rest Service");
        RegisterBuiltin.register(ResteasyProviderFactory.getInstance());
    }

    public Boolean defaultConnectionCheck() throws RestServiceCommunicationException {

        try {
            // not a proxy object because we want to get the http status
            ClientRequest request = new ClientRequest(InitialisationImpl.SERVICE_STARTTIME_URL, clientExecutor);
            ClientResponse<ServiceStartTime> response = request.get(ServiceStartTime.class);

            if (response.getStatus() != HttpStatus.SC_OK) {
                throw new ClientProtocolException(
                        "Default Connection Check: Failed : HTTP error code : " + response.getStatus());
            }
            response.releaseConnection();
            return true;
        } catch (final Exception e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        }

    }

    public Date getStartTime() throws RestServiceCommunicationException {

        try {
            // TODO we could use a proxy object here, just as everywhere else
            final ClientRequest request = new ClientRequest(InitialisationImpl.SERVICE_STARTTIME_URL);
            ClientResponse<ServiceStartTime> response = request.get(ServiceStartTime.class);

            if (response.getStatus() != HttpStatus.SC_OK) {
                throw new RuntimeException("Failed : HTTP error code : " + response.getStatus());
            }
            // / XXX this seems like a duplication of the request above!
            final ServiceStartTime serviceProxy = ProxyFactory.create(ServiceStartTime.class,
                    InitialisationImpl.SERVICE_STARTTIME_URL);
            response.releaseConnection();
            if (serviceProxy != null) {
                return new Date(serviceProxy.startTimeJson().getTime());
            }
            return null;
        } catch (final ClientProtocolException e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        } catch (final IOException e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        } catch (final Exception e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        }

    }

    public ResultListCourseObject getCoursesDetails(final List<Long> ids) throws RestServiceCommunicationException {

        try {

            if (defaultConnectionCheck()) {
                return courseDetailsList.getCoursesDetails(ids);
            }
            // XXX wrong message? May should be "no connection"
            logger.info("No course details found. Returning empty resultset.");
            return new ResultListCourseObject();
        } catch (final Exception e) {
            throw new RestServiceCommunicationException(this.toString() + " 0 " + e.getLocalizedMessage());
        }
    }

    public CourseObject getCourseDetails(final Long id) throws RestServiceCommunicationException {

        try {

            if (defaultConnectionCheck()) {

                return courseDetails.getCourseDetails(id);

            }

            logger.info("No course details found. Returning empty resultset.");
            return new CourseObject();

        } catch (final Exception e) {
            throw new RestServiceCommunicationException();
        }
    }

    public ResultListStringObject getRatedObjects(final List<Long> courseIds)
            throws RestServiceCommunicationException {

        try {

            if (defaultConnectionCheck()) {

                return ratedObjects.getRatedObjects(courseIds);

            }
            logger.info("No Rated objects found. Returning empty resultset.");
            return new ResultListStringObject();
        } catch (final Exception e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        }
    }

    public ResultListStringObject getLearningObjects(final List<Long> courseIds)
            throws RestServiceCommunicationException {

        try {

            if (defaultConnectionCheck()) {

                return learningObjects.getLearningObjects(courseIds);

            }
            logger.info("No Learning objects found. Returning empty resultset.");
            return new ResultListStringObject();
        } catch (final Exception e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        }
    }

    public ResultListStringObject getLearningTypes(final List<Long> courseIds)
            throws RestServiceCommunicationException {

        try {

            if (defaultConnectionCheck()) {

                return learningTypes.getLearningTypes(courseIds);

            }
            logger.info("No Learning types found. Returning empty resultset.");
            return new ResultListStringObject();
        } catch (final Exception e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        }
    }

    public ResultListLongObject identifyUserName(final String login) throws RestServiceCommunicationException {

        try {

            if (defaultConnectionCheck()) {
                return loginAuth.authentificateUser(login);
            }

        } catch (final Exception e) {

            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());

        }

        logger.info("User could not be identified. Returning empty resultset.");
        return new ResultListLongObject();

    }

    public ResultListLongObject getUserCourses(Long userId) throws RestServiceCommunicationException {

        try {

            if (defaultConnectionCheck()) {
                return teacherCourses.getTeachersCourses(userId);
            }

        } catch (final Exception e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        }

        logger.info("Courses could not be loaded. Returning empty resultset.");
        return new ResultListLongObject();

    }

    public ResultListCourseObject getUserCourses(Long userId, Long amount, Long offset)
            throws RestServiceCommunicationException {

        try {

            if (defaultConnectionCheck()) {
                return userInfo.getCoursesByUser(userId, amount, offset);
            }

        } catch (final Exception e) {
            throw new RestServiceCommunicationException(this.toString() + " " + e.getLocalizedMessage());
        }

        logger.info("Courses could not be loaded. Returning empty resultset.");
        return new ResultListCourseObject();

    }

    @Override
    public JSONObject taskResult(String taskId) {

        JSONObject json = new JSONObject();
        Response taskResult = null;
        try {
            taskResult = taskManager.taskResult(taskId);
        } catch (RuntimeException e) {
            if (!e.getCause().getClass().equals(ConnectionPoolTimeoutException.class)) {
                // ignore ConnectionPoolTimeoutException, rethrow anything else
                //throw e;
            }
        }

        int status = (taskResult == null) ? HttpStatus.SC_GATEWAY_TIMEOUT : taskResult.getStatus();

        if (status == HttpStatus.SC_INTERNAL_SERVER_ERROR) {
            // DMS error (maybe a processing timeout)
            json.put("status", HttpStatus.SC_BAD_GATEWAY);
        } else {
            json.put("status", status);
        }

        if (status == HttpStatus.SC_OK) {
            @SuppressWarnings("unchecked")
            ClientResponse<String> clientResponse = (ClientResponse<String>) taskResult;
            String analysisResult = clientResponse.getEntity(String.class);
            json.put("bideResult", new JSONObject(analysisResult));
        }
        return json;
    }

}