View Javadoc

1   /*
2    * Copyright 2013 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 org.jboss.netty.handler.codec.spdy;
17  
18  import java.util.List;
19  import java.util.Map;
20  import java.util.Set;
21  
22  /**
23   * A SPDY Protocol HEADERS Frame
24   */
25  public interface SpdyHeadersFrame extends SpdyStreamFrame {
26  
27      /**
28       * Returns {@code true} if this header block is invalid.
29       * A RST_STREAM frame with code PROTOCOL_ERROR should be sent.
30       */
31      boolean isInvalid();
32  
33      /**
34       * Marks this header block as invalid.
35       */
36      void setInvalid();
37  
38      /**
39       * Returns {@code true} if this header block has been truncated due to
40       * length restrictions.
41       */
42      boolean isTruncated();
43  
44      /**
45       * Mark this header block as truncated.
46       */
47      void setTruncated();
48  
49      /**
50       * Returns the {@link SpdyHeaders}.
51       */
52      SpdyHeaders headers();
53  
54      /**
55       * @deprecated Use {@link SpdyHeaders#headers()} instead.
56       */
57      @Deprecated
58      String getHeader(String name);
59  
60      /**
61       * @deprecated Use {@link SpdyHeaders#headers()} instead.
62       */
63      @Deprecated
64      List<String> getHeaders(String name);
65  
66      /**
67       * @deprecated Use {@link SpdyHeaders#headers()} instead.
68       */
69      @Deprecated
70      List<Map.Entry<String, String>> getHeaders();
71  
72      /**
73       * @deprecated Use {@link SpdyHeaders#headers()} instead.
74       */
75      @Deprecated
76      boolean containsHeader(String name);
77  
78      /**
79       * @deprecated Use {@link SpdyHeaders#headers()} instead.
80       */
81      @Deprecated
82      Set<String> getHeaderNames();
83  
84      /**
85       * @deprecated Use {@link SpdyHeaders#headers()} instead.
86       */
87      @Deprecated
88      void addHeader(String name, Object value);
89  
90      /**
91       * @deprecated Use {@link SpdyHeaders#headers()} instead.
92       */
93      @Deprecated
94      void setHeader(String name, Object value);
95  
96      /**
97       * @deprecated Use {@link SpdyHeaders#headers()} instead.
98       */
99      @Deprecated
100     void setHeader(String name, Iterable<?> values);
101 
102     /**
103      * @deprecated Use {@link SpdyHeaders#headers()} instead.
104      */
105     @Deprecated
106     void removeHeader(String name);
107 
108     /**
109      * @deprecated Use {@link SpdyHeaders#headers()} instead.
110      */
111     @Deprecated
112     void clearHeaders();
113 }