View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.websocket.common.io.payload;
20  
21  import java.nio.ByteBuffer;
22  
23  import org.eclipse.jetty.websocket.api.BadPayloadException;
24  import org.eclipse.jetty.websocket.api.extensions.Frame;
25  
26  /**
27   * Process the payload (for demasking, validating, etc..)
28   */
29  public interface PayloadProcessor
30  {
31      /**
32       * Used to process payloads for in the spec.
33       * 
34       * @param payload
35       *            the payload to process
36       * @throws BadPayloadException
37       *             the exception when the payload fails to validate properly
38       */
39      public void process(ByteBuffer payload);
40  
41      public void reset(Frame frame);
42  }