001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.protocol.ws.api.event;
018
019import org.apache.wicket.protocol.ws.api.WebSocketRequestHandler;
020import org.apache.wicket.protocol.ws.api.message.BinaryMessage;
021import org.apache.wicket.util.lang.Args;
022
023/**
024 * Payload for event broadcasting when a binary message comes in the WebSocket connection
025 * 
026 * @since 6.0
027 */
028public class WebSocketBinaryPayload extends WebSocketPayload<BinaryMessage>
029{
030        private final BinaryMessage binaryMessage;
031
032        public WebSocketBinaryPayload(BinaryMessage binaryMessage, WebSocketRequestHandler handler)
033        {
034                super(handler);
035
036                this.binaryMessage = Args.notNull(binaryMessage, "binaryMessage");
037        }
038
039        @Override
040        public final BinaryMessage getMessage()
041        {
042                return binaryMessage;
043        }
044}