pt.webdetails.cda.push.CdaPushQueryEndpoint.java Source code

Introduction

Here is the source code for pt.webdetails.cda.push.CdaPushQueryEndpoint.java

Source

/*!
 * Copyright 2018 Webdetails, a Hitachi Vantara company. All rights reserved.
 *
 * This software was developed by Webdetails and is provided under the terms
 * of the Mozilla Public License, Version 2.0, or any later version. You may not use
 * this file except in compliance with the license. If you need a copy of the license,
 * please go to  http://mozilla.org/MPL/2.0/. The Initial Developer is Webdetails.
 *
 * Software distributed under the Mozilla Public License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
 * the license for the specific language governing your rights and limitations.
 */

package pt.webdetails.cda.push;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.pentaho.platform.api.engine.IPentahoRequestContext;
import org.pentaho.platform.engine.core.system.PentahoRequestContextHolder;
import org.pentaho.platform.web.websocket.WebsocketEndpointConfig;

import javax.websocket.CloseReason;
import javax.websocket.Endpoint;
import javax.websocket.EndpointConfig;
import javax.websocket.Session;

/**
 * Websocket implementation for CDA queries.
 * This Endpoint is registered in plugin.spring.xml fille by means of the {@link org.pentaho.platform.web.websocket.WebsocketEndpointConfig} bean.
 */
public class CdaPushQueryEndpoint extends Endpoint {

    private final Log logger = LogFactory.getLog(CdaPushQueryEndpoint.class);

    private CdaPushQueryMessageHandler queryHandler;

    /**
     * This method is called whenever a client creates a new websocket connection to the URL registered to
     * this endpoint.
     *
     * @param session the websocket session.
     * @param endpointConfig the endpoint configuration.
     */
    @Override
    public void onOpen(Session session, EndpointConfig endpointConfig) {
        PentahoRequestContextHolder.setRequestContext(() -> (String) endpointConfig.getUserProperties()
                .get(WebsocketEndpointConfig.getInstanceToReadProperties().getServletContextPathPropertyName()));
        IPentahoRequestContext requestContext = PentahoRequestContextHolder.getRequestContext();

        this.queryHandler = new CdaPushQueryMessageHandler(session, requestContext);
        this.queryHandler.getWebsocketJsonQueryEndpoint().onOpen(null);

        session.setMaxTextMessageBufferSize(Integer.parseInt(endpointConfig.getUserProperties()
                .get(WebsocketEndpointConfig.getInstanceToReadProperties().getMaxMessagePropertyName())
                .toString()));
        session.setMaxBinaryMessageBufferSize(Integer.parseInt(endpointConfig.getUserProperties()
                .get(WebsocketEndpointConfig.getInstanceToReadProperties().getMaxMessagePropertyName())
                .toString()));

        session.addMessageHandler(queryHandler);
    }

    /**
     * Executed whenever a connected websocket connection is terminated or timeouts according
     * to the web server or container configurations (the connection is not kept alive forever
     * to better manage server resources, so it is disconnected after a defined period of time - timeout).
     *
     * @param session the websocket session.
     * @param closeReason the reason for closing the connection.
     */
    @Override
    public void onClose(Session session, CloseReason closeReason) {
        this.queryHandler.getWebsocketJsonQueryEndpoint().onClose();
    }

    /**
     * Executed whenever there is an error associated with the websocket connection. We close the
     * underlying websocket implementation when this happens
     *
     * @param session the websocket session.
     * @param throwable the {@link Throwable} that occurred.
     */
    @Override
    public void onError(Session session, Throwable throwable) {
        if (logger.isDebugEnabled()) {
            logger.debug("Error occurred in session id " + session.getId(), throwable);
        }
        this.queryHandler.getWebsocketJsonQueryEndpoint().onClose();
    }

}