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 import org.java_websocket.WebSocket;
  25
  26 /**
  27  * This class encapsulate messages and the web socket on which they are handled.
  28  *
  29  * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
  30  * @param <M> the generic type of message being handled
  31  */
  32 public final class MessageBlock<M> {
  33
  34     // List of Messages received on a web socket
  35     private final List<M> messages;
  36
  37     // The web socket on which the messages are handled
  38     private final WebSocket webSocket;
  39
  40     /**
  41      * Instantiates a new message block.
  42      *
  43      * @param messages the messages in the message block
  44      * @param webSocket the web socket used to handle the message block
  45      */
  46     public MessageBlock(final List<M> messages, final WebSocket webSocket) {
  47         this.messages = messages;
  48         this.webSocket = webSocket;
  49     }
  50
  51     /**
  52      * Gets the messages.
  53      *
  54      * @return the messages
  55      */
  56     public List<M> getMessages() {
  57         return messages;
  58     }
  59
  60     /**
  61      * Gets the web socket.
  62      *
  63      * @return the web socket
  64      */
  65     public WebSocket getConnection() {
  66         return webSocket;
  67     }
  68
  69 }