org.wso2.carbon.device.mgt.extensions.remote.session.endpoint.DeviceSessionSubscriptionEndpoint.java Source code

Introduction

Here is the source code for org.wso2.carbon.device.mgt.extensions.remote.session.endpoint.DeviceSessionSubscriptionEndpoint.java

Source

/*
 * Copyright (c) 2017, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. licenses this file to you under the Apache License,
 * deviceId 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.wso2.carbon.device.mgt.extensions.remote.session.endpoint;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.device.mgt.extensions.remote.session.endpoint.utils.HttpSessionConfigurator;
import org.wso2.carbon.device.mgt.extensions.remote.session.endpoint.utils.ServiceHolder;
import org.wso2.carbon.device.mgt.extensions.remote.session.exception.RemoteSessionManagementException;

import javax.websocket.CloseReason;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;

/**
 * This class represents web socket endpoint to manage Remote Sessions
 */
@ServerEndpoint(value = "/devices/{deviceType}/{deviceId}/{operationId}", configurator = HttpSessionConfigurator.class)
public class DeviceSessionSubscriptionEndpoint extends SubscriptionEndpoint {

    private static final Log log = LogFactory.getLog(DeviceSessionSubscriptionEndpoint.class);

    /**
     * Web socket onOpen use when device connect to web socket url
     *
     * @param session     - Web socket Session
     * @param deviceType  - DeviceType
     * @param deviceId    - Device Identifier
     * @param operationId - Operations Id
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("deviceType") String deviceType,
            @PathParam("deviceId") String deviceId, @PathParam("operationId") String operationId) {
        try {
            ServiceHolder.getInstance().getRemoteSessionManagementService().initializeSession(session, deviceType,
                    deviceId, operationId);
        } catch (RemoteSessionManagementException e) {
            if (log.isDebugEnabled()) {
                log.error("Error occurred while initializing session ", e);
            }
            try {
                session.close(e.getCloseReason());
            } catch (IOException ex) {
                log.error("Failed to disconnect the client.", ex);
            }
        }
    }

    /**
     * Web socket onMessage use when device sends a string message
     *
     * @param session    - Registered  session.
     * @param message    - String message  which needs to send to peer
     * @param deviceType - DeviceType
     * @param deviceId   - Device Identifier
     */
    @OnMessage
    public void onMessage(Session session, String message, @PathParam("deviceType") String deviceType,
            @PathParam("deviceId") String deviceId) {
        super.onMessage(session, message, deviceType, deviceId);
    }

    /**
     * Web socket onMessage use when device sends a byte message
     *
     * @param session    - Registered  session.
     * @param message    - Byte message  which needs to send to peer
     * @param deviceType - DeviceType
     * @param deviceId   - Device Identifier
     */
    @OnMessage
    public void onMessage(Session session, byte[] message, @PathParam("deviceType") String deviceType,
            @PathParam("deviceId") String deviceId) {
        super.onMessage(session, message, deviceType, deviceId);
    }

    /**
     * Web socket onClose use to handle  socket connection close
     *
     * @param session    - Registered  session.
     * @param deviceType - DeviceType
     * @param deviceId   - Device Identifier
     * @param reason     - Status code for web-socket close.
     */
    @OnClose
    public void onClose(Session session, CloseReason reason, @PathParam("deviceType") String deviceType,
            @PathParam("deviceId") String deviceId) {
        super.onClose(session, reason, deviceType, deviceId);
    }

    /**
     * Web socket onError use to handle  socket connection error
     *
     * @param session    - Registered  session.
     * @param throwable  - Web socket exception
     * @param deviceType - DeviceType
     * @param deviceId   - Device Identifier
     */
    @OnError
    public void onError(Session session, Throwable throwable, @PathParam("deviceType") String deviceType,
            @PathParam("deviceId") String deviceId) {
        super.onError(session, throwable, deviceType, deviceId);
    }
}