core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/messaging/impl/ws/messageblock/MessageBlock.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.core.infrastructure.messaging.impl.ws.messageblock;
  22
  23 import java.util.List;
  24
  25 import org.java_websocket.WebSocket;
  26
  27 /**
  28  * This class encapsulate messages and the web socket on which they are handled.
  29  *
  30  * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
  31  * @param <M> the generic type of message being handled
  32  */
  33 public final class MessageBlock<M> {
  34
  35     // List of Messages received on a web socket
  36     private final List<M> messages;
  37
  38     // The web socket on which the messages are handled
  39     private final WebSocket webSocket;
  40
  41     /**
  42      * Instantiates a new message block.
  43      *
  44      * @param messages the messages in the message block
  45      * @param webSocket the web socket used to handle the message block
  46      */
  47     public MessageBlock(final List<M> messages, final WebSocket webSocket) {
  48         this.messages = messages;
  49         this.webSocket = webSocket;
  50     }
  51
  52     /**
  53      * Gets the messages.
  54      *
  55      * @return the messages
  56      */
  57     public List<M> getMessages() {
  58         return messages;
  59     }
  60
  61     /**
  62      * Gets the web socket.
  63      *
  64      * @return the web socket
  65      */
  66     public WebSocket getConnection() {
  67         return webSocket;
  68     }
  69
  70 }