jdk/src/java.httpclient/share/classes/java/net/http/SettingsFrame.java
author chegar
Mon, 18 Jul 2016 15:34:22 +0100
changeset 39730 196f4e25d9f5
parent 37720 45cd7cc65382
permissions -rw-r--r--
8160993: Fix headers in the java/net/http package Reviewed-by: alanb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
37720
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     1
/*
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     2
 * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     4
 *
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    10
 *
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    15
 * accompanied this code).
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    16
 *
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    20
 *
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
39730
196f4e25d9f5 8160993: Fix headers in the java/net/http package
chegar
parents: 37720
diff changeset
    23
 * questions.
37720
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    24
 */
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    25
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    26
package java.net.http;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    27
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    28
import java.io.IOException;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    29
import java.nio.ByteBuffer;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    30
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    31
class SettingsFrame extends Http2Frame {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    32
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    33
    int[] parameters;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    34
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    35
    public static final int TYPE = 0x4;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    36
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    37
    // Flags
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    38
    public static final int ACK = 0x1;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    39
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    40
    @Override
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    41
    String flagAsString(int flag) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    42
        switch (flag) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    43
        case ACK:
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    44
            return "ACK";
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    45
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    46
        return super.flagAsString(flag);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    47
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    48
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    49
    @Override
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    50
    public String toString() {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    51
        StringBuilder sb = new StringBuilder();
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    52
        sb.append(super.toString())
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    53
          .append(" Settings: ");
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    54
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    55
        for (int i = 0; i < MAX_PARAM; i++) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    56
            if (parameters[i] != -1) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    57
                sb.append(name(i))
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    58
                  .append("=")
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    59
                  .append(Integer.toString(parameters[i]))
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    60
                  .append(' ');
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    61
            }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    62
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    63
        return sb.toString();
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    64
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    65
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    66
    // Parameters
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    67
    public static final int HEADER_TABLE_SIZE = 0x1;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    68
    public static final int ENABLE_PUSH = 0x2;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    69
    public static final int MAX_CONCURRENT_STREAMS = 0x3;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    70
    public static final int INITIAL_WINDOW_SIZE = 0x4;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    71
    public static final int MAX_FRAME_SIZE = 0x5;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    72
    public static final int MAX_HEADER_LIST_SIZE = 0x6;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    73
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    74
    private String name(int i) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    75
        switch (i+1) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    76
        case HEADER_TABLE_SIZE:
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    77
            return "HEADER_TABLE_SIZE";
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    78
        case ENABLE_PUSH:
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    79
            return "ENABLE_PUSH";
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    80
        case MAX_CONCURRENT_STREAMS:
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    81
            return "MAX_CONCURRENT_STREAMS";
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    82
        case INITIAL_WINDOW_SIZE:
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    83
            return "INITIAL_WINDOW_SIZE";
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    84
        case MAX_FRAME_SIZE:
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    85
            return "MAX_FRAME_SIZE";
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    86
        case MAX_HEADER_LIST_SIZE:
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    87
            return "MAX_HEADER_LIST_SIZE";
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    88
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    89
        return "unknown parameter";
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    90
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    91
    public static final int MAX_PARAM = 0x6;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    92
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    93
    public SettingsFrame() {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    94
        type = TYPE;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    95
        parameters = new int [MAX_PARAM];
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    96
        for (int i=0; i < parameters.length; i++) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    97
            parameters[i] = -1;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    98
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
    99
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   100
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   101
    public int getParameter(int paramID) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   102
        if (paramID > MAX_PARAM) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   103
            throw new IllegalArgumentException("illegal parameter");
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   104
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   105
        return parameters[paramID-1];
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   106
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   107
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   108
    public SettingsFrame setParameter(int paramID, int value) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   109
        if (paramID > MAX_PARAM) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   110
            throw new IllegalArgumentException("illegal parameter");
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   111
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   112
        parameters[paramID-1] = value;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   113
        return this;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   114
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   115
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   116
    @Override
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   117
    void readIncomingImpl(ByteBufferConsumer bc) throws IOException {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   118
        if (length % 6 != 0) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   119
            throw new IOException("Protocol error: invalid settings frame");
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   120
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   121
        int n = length / 6;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   122
        for (int i=0; i<n; i++) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   123
            int id = bc.getShort();
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   124
            int val = bc.getInt();
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   125
            if (id > 0 || id <= MAX_PARAM) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   126
                // a known parameter. Ignore otherwise
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   127
                parameters[id-1] = val;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   128
            }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   129
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   130
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   131
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   132
    @Override
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   133
    void computeLength() {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   134
        length = 0;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   135
        for (int i : parameters) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   136
            if (i != -1) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   137
                length += 6;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   138
            }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   139
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   140
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   141
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   142
    @Override
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   143
    void writeOutgoing(ByteBufferGenerator bg) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   144
        super.writeOutgoing(bg);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   145
        ByteBuffer buf = bg.getBuffer(length);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   146
        for (int i = 0; i < MAX_PARAM; i++) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   147
            if (parameters[i] != -1) {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   148
                buf.putShort((short)(i+1));
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   149
                buf.putInt(parameters[i]);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   150
            }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   151
        }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   152
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   153
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   154
    private static final int K = 1024;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   155
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   156
    public static SettingsFrame getDefaultSettings() {
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   157
        SettingsFrame f = new SettingsFrame();
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   158
        // TODO: check these values
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   159
        f.setParameter(ENABLE_PUSH, 1);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   160
        f.setParameter(HEADER_TABLE_SIZE, 4 * K);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   161
        f.setParameter(MAX_CONCURRENT_STREAMS, 35);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   162
        f.setParameter(INITIAL_WINDOW_SIZE, 16 * K);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   163
        f.setParameter(MAX_FRAME_SIZE, 16 * K);
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   164
        return f;
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   165
    }
45cd7cc65382 8087124: HTTP/2 implementation
michaelm
parents:
diff changeset
   166
}