View Javadoc
1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec.rtsp;
17  
18  import io.netty.buffer.ByteBuf;
19  import io.netty.handler.codec.TooLongFrameException;
20  import io.netty.handler.codec.http.DefaultFullHttpRequest;
21  import io.netty.handler.codec.http.DefaultHttpRequest;
22  import io.netty.handler.codec.http.HttpMessage;
23  import io.netty.handler.codec.http.HttpRequest;
24  
25  /**
26   * Decodes {@link ByteBuf}s into RTSP requests represented in
27   * {@link HttpRequest}s.
28   * <p>
29   * <h3>Parameters that prevents excessive memory consumption</h3>
30   * <table border="1">
31   * <tr>
32   * <th>Name</th><th>Meaning</th>
33   * </tr>
34   * <tr>
35   * <td>{@code maxInitialLineLength}</td>
36   * <td>The maximum length of the initial line (e.g. {@code "SETUP / RTSP/1.0"})
37   *     If the length of the initial line exceeds this value, a
38   *     {@link TooLongFrameException} will be raised.</td>
39   * </tr>
40   * <tr>
41   * <td>{@code maxHeaderSize}</td>
42   * <td>The maximum length of all headers.  If the sum of the length of each
43   *     header exceeds this value, a {@link TooLongFrameException} will be raised.</td>
44   * </tr>
45   * <tr>
46   * <td>{@code maxContentLength}</td>
47   * <td>The maximum length of the content.  If the content length exceeds this
48   *     value, a {@link TooLongFrameException} will be raised.</td>
49   * </tr>
50   * </table>
51   */
52  public class RtspRequestDecoder extends RtspObjectDecoder {
53  
54      /**
55       * Creates a new instance with the default
56       * {@code maxInitialLineLength (4096}}, {@code maxHeaderSize (8192)}, and
57       * {@code maxContentLength (8192)}.
58       */
59      public RtspRequestDecoder() {
60      }
61  
62      /**
63       * Creates a new instance with the specified parameters.
64       */
65      public RtspRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxContentLength) {
66          super(maxInitialLineLength, maxHeaderSize, maxContentLength);
67      }
68  
69      public RtspRequestDecoder(
70              int maxInitialLineLength, int maxHeaderSize, int maxContentLength, boolean validateHeaders) {
71          super(maxInitialLineLength, maxHeaderSize, maxContentLength, validateHeaders);
72      }
73  
74      @Override
75      protected HttpMessage createMessage(String[] initialLine) throws Exception {
76          return new DefaultHttpRequest(RtspVersions.valueOf(initialLine[2]),
77                  RtspMethods.valueOf(initialLine[0]), initialLine[1], validateHeaders);
78      }
79  
80      @Override
81      protected HttpMessage createInvalidMessage() {
82          return new DefaultFullHttpRequest(RtspVersions.RTSP_1_0, RtspMethods.OPTIONS, "/bad-request", validateHeaders);
83      }
84  
85      @Override
86      protected boolean isDecodingRequest() {
87          return true;
88      }
89  }