org.symphonyoss.client.model.Chat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of symphony-client Show documentation
The newest version!
/*
 *
 * Copyright 2016 The Symphony Software Foundation
 *
 * Licensed to The Symphony Software Foundation (SSF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 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.symphonyoss.client.model;

import org.symphonyoss.client.services.ChatListener;
import org.symphonyoss.symphony.clients.model.SymMessage;
import org.symphonyoss.symphony.clients.model.SymStream;
import org.symphonyoss.symphony.clients.model.SymUser;


import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;


/**
 * Chat is a core model that defines an active conversation between users.  It includes the ability to register
 * ChatListener callbacks, which are monitored by the ChatService. Once defined, make sure to add the chat model to the
 * ChatService in order to receive events when a listeners are defined.
 *
 * @author Frank Tarsillo
 */
public class Chat {
    private Set remoteUsers;
    private SymUser localUser;
    private SymStream stream;
    private String streamId;


    private final Set chatListeners = ConcurrentHashMap.newKeySet();

    private SymMessage lastMessage;


    /**
     * @return current stream ID for chat session
     */
    public String getStreamId() {

        return streamId;
    }

    public void setStreamId(String streamId) {
        this.streamId = streamId;

        if (stream == null)
            stream = new SymStream();

        stream.setStreamId(streamId);

    }

    public Set getRemoteUsers() {
        return remoteUsers;
    }

    public void setRemoteUsers(Set remoteUsers) {
        this.remoteUsers = remoteUsers;
    }

    @SuppressWarnings("unused")
    public SymUser getLocalUser() {
        return localUser;
    }

    public void setLocalUser(SymUser localUser) {
        this.localUser = localUser;
    }

    public SymStream getStream() {
        return stream;
    }


    public void setStream(SymStream stream) {
        this.stream = stream;
        streamId = stream.getStreamId();

    }


    /**
     * Push message to all registered listeners.
     *
     * @param message Message
     */
    public void onChatMessage(SymMessage message) {

        lastMessage = message;

        for (ChatListener chatListener : chatListeners)
            chatListener.onChatMessage(message);

    }

    /**
     * Register Chat listeners. A chat can have more than one listener at any time.
     * Please use {@link #addListener(ChatListener)}
     *
     * @param chatListener Listener to register
     * @return Success
     */
    @Deprecated
    public boolean registerListener(ChatListener chatListener) {


        return addListener(chatListener);

    }

    /**
     * Add Chat listeners. A chat can have more than one listener at any time.
     *
     * @param chatListener Listener to add
     * @return Success
     */
    public boolean addListener(ChatListener chatListener) {

        if (lastMessage != null)
            chatListener.onChatMessage(lastMessage);

        return chatListeners.add(chatListener);

    }

    /**
     * Remove a specific listener
     *
     * @param chatListener Listener to remove
     * @return True if listener was removed
     */
    @SuppressWarnings("UnusedReturnValue")
    public boolean removeListener(ChatListener chatListener) {
        return chatListeners.remove(chatListener);
    }

    @SuppressWarnings("unused")
    public SymMessage getLastMessage() {

        return lastMessage;
    }


    /**
     * Sometimes you want to have the last message...just in case!
     *
     * @param lastMessage Last message recorded
     */
    public void setLastMessage(SymMessage lastMessage) {
        this.lastMessage = lastMessage;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }

        if (this.getClass() != obj.getClass())
            return false;

        final Chat other = (Chat) obj;

        return !(this.stream == null || !this.stream.equals(other.stream));
    }


    @Override
    public int hashCode() {
        return Objects.hash(stream, remoteUsers);
    }

}