atom.ws.model.AbstractContextService Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.ws.model;

import atom.app.ActivityList;
import atom.app.ActivityThread;
import atom.app.ClientNotifier;
import atom.beans.ChangeSet;

import java.util.ArrayList;
import java.util.List;

/**
 * Abstract context service.
 *
 * @author Serge Voloshyn
 * @version 1.2 3/1/15
 */
public abstract class AbstractContextService {
    /**
     * Service callback.
     */
    protected interface ServiceCallback {
        /**
         * On processing finish.
         *
         * @param clientId  client identifier
         * @param changeSet resulting change set
         */
        void onFinish(String clientId, List changeSet);
    }

    /**
     * Process start activity message.
     *
     * @param message  message from client
     * @param client   current client request context
     * @param callback processing callback
     */
    protected final void processMessage(final AbstractMessage message,
                                        final ClientRequestContext client,
                                        final ServiceCallback callback) {
        if (message instanceof StartActivityMessage) {
            processStartActivity((StartActivityMessage) message,
                    client, callback);
        } else if (message instanceof HandleEventMessage) {
            processHandleEvent((HandleEventMessage) message,
                    client, callback);
        } else if (message instanceof TimezoneOffsetMessage) {
            processTimezoneOffset((TimezoneOffsetMessage) message,
                    client);
        } else {
            throw new IllegalArgumentException(String.format(
                    "Unhandled message '%s'", message));
        }
    }

    /**
     * Process start activity message.
     *
     * @param message  start activity message
     * @param client   current client request context
     * @param callback processing callback
     */
    @SuppressWarnings("PMD.UnusedPrivateMethod")
    private void processStartActivity(final StartActivityMessage message,
                                      final ClientRequestContext client,
                                      final ServiceCallback callback) {
        final List changeSets = ContextService.getInstance()
                .startActivity(message.getClientId(),
                        message.getLayers(), message.getIntent(),
                        client);
        callback.onFinish(message.getClientId(), changeSets);
    }

    /**
     * Process handle event message.
     *
     * @param message  handle event message
     * @param client   current client request context
     * @param callback processing callback
     */
    @SuppressWarnings("PMD.UnusedPrivateMethod")
    private void processHandleEvent(final HandleEventMessage message,
                                    final ClientRequestContext client,
                                    final ServiceCallback callback) {
        final List changeSets = ContextService.getInstance()
                .handleEvent(message.getClientId(),
                        message.getLayers(), message.getIdentity(),
                        message.getEventType(),
                        message.getChangeSet(), client);
        callback.onFinish(message.getClientId(), changeSets);
    }

    /**
     * Process timezone offset message.
     *
     * @param message timezone offset message
     * @param client  current client request context
     */
    @SuppressWarnings("PMD.UnusedPrivateMethod")
    private void processTimezoneOffset(final TimezoneOffsetMessage message,
                                       final ClientRequestContext client) {
        ContextService.getInstance().sendTimezoneOffset(message.getClientId(),
                message.getMinutes(), client);
    }

    /**
     * Sets client notifier for current activity thread.
     *
     * @param clientId client identifier
     * @param context  current client request context
     * @param notifier client notifier
     */
    protected static void setClientNotifier(final String clientId,
                                            final ClientRequestContext context,
                                            final ClientNotifier notifier) {
        final ActivityThread activityThread
                = ContextService.getActivityThread(clientId, context);
        activityThread.setClientNotifier(notifier);
    }

    /**
     * Create list of layer indexes from the thread.
     *
     * @param thread current activity thread
     * @return list of layer indexes from the thread
     */
    protected static List getClientLayers(
            final ActivityThread thread) {
        final ActivityList activities = thread.getCurrentActivities();
        final List layers = new ArrayList<>(activities.length());
        for (int layer = 0; layer < activities.length(); layer++) {
            if (activities.get(layer) != null) {
                layers.add(layer);
            }
        }
        return layers;
    }
}