ok2c commented on code in PR #731: URL: https://github.com/apache/httpcomponents-client/pull/731#discussion_r2682110883
########## httpclient5/src/main/java/org/apache/hc/client5/http/impl/AlpnHeaderSupport.java: ########## @@ -0,0 +1,149 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ +package org.apache.hc.client5.http.impl; + +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.apache.hc.core5.annotation.Contract; +import org.apache.hc.core5.annotation.Internal; +import org.apache.hc.core5.annotation.ThreadingBehavior; +import org.apache.hc.core5.http.Header; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.message.MessageSupport; +import org.apache.hc.core5.net.PercentCodec; +import org.apache.hc.core5.util.Args; + +/** + * Codec for the HTTP {@code ALPN} header field (RFC 7639). + * + * @since 5.7 + */ +@Contract(threading = ThreadingBehavior.IMMUTABLE) +@Internal +public final class AlpnHeaderSupport { + + private static final char[] HEXADECIMAL = "0123456789ABCDEF".toCharArray(); + + private AlpnHeaderSupport() { + } + + /** + * Formats a list of raw ALPN protocol IDs into a single {@code ALPN} header. + */ + public static Header formatValue(final List<String> protocolIds) { + Args.notEmpty(protocolIds, "protocolIds"); + return MessageSupport.headerOfTokens(HttpHeaders.ALPN, protocolIds, AlpnHeaderSupport::encodeId); + } + + /** + * Parses an {@code ALPN} header into decoded protocol IDs. + */ + public static List<String> parseValue(final Header header) { + if (header == null) { + return Collections.emptyList(); + } + final List<String> out = new ArrayList<>(); + MessageSupport.parseTokens(header, token -> { + if (!token.isEmpty()) { + out.add(decodeId(token)); + } + }); + return out; + } + + /** + * Encodes a single raw protocol ID to canonical token form. + */ + public static String encodeId(final String id) { Review Comment: @arturobernalg I asked this already, I have to ask it again. What is the reason for having to re-implement percent coding and not using PercentCodec from core? What is wrong with PercentCodec encoding? ########## httpclient5/src/main/java/org/apache/hc/client5/http/impl/AlpnHeaderSupport.java: ########## @@ -0,0 +1,149 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ +package org.apache.hc.client5.http.impl; + +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.apache.hc.core5.annotation.Contract; +import org.apache.hc.core5.annotation.Internal; +import org.apache.hc.core5.annotation.ThreadingBehavior; +import org.apache.hc.core5.http.Header; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.message.MessageSupport; +import org.apache.hc.core5.net.PercentCodec; +import org.apache.hc.core5.util.Args; + +/** + * Codec for the HTTP {@code ALPN} header field (RFC 7639). + * + * @since 5.7 + */ +@Contract(threading = ThreadingBehavior.IMMUTABLE) +@Internal +public final class AlpnHeaderSupport { + + private static final char[] HEXADECIMAL = "0123456789ABCDEF".toCharArray(); + + private AlpnHeaderSupport() { + } + + /** + * Formats a list of raw ALPN protocol IDs into a single {@code ALPN} header. + */ + public static Header formatValue(final List<String> protocolIds) { + Args.notEmpty(protocolIds, "protocolIds"); + return MessageSupport.headerOfTokens(HttpHeaders.ALPN, protocolIds, AlpnHeaderSupport::encodeId); + } + + /** + * Parses an {@code ALPN} header into decoded protocol IDs. + */ + public static List<String> parseValue(final Header header) { + if (header == null) { Review Comment: @arturobernalg This is an internal method. It does not need to do strict input validation. This is the responsibility of public methods. Keep it simple and small. ########## httpclient5/src/main/java/org/apache/hc/client5/http/impl/AlpnHeaderSupport.java: ########## @@ -0,0 +1,149 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ +package org.apache.hc.client5.http.impl; + +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.apache.hc.core5.annotation.Contract; +import org.apache.hc.core5.annotation.Internal; +import org.apache.hc.core5.annotation.ThreadingBehavior; +import org.apache.hc.core5.http.Header; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.message.MessageSupport; +import org.apache.hc.core5.net.PercentCodec; +import org.apache.hc.core5.util.Args; + +/** + * Codec for the HTTP {@code ALPN} header field (RFC 7639). + * + * @since 5.7 + */ +@Contract(threading = ThreadingBehavior.IMMUTABLE) +@Internal +public final class AlpnHeaderSupport { + + private static final char[] HEXADECIMAL = "0123456789ABCDEF".toCharArray(); + + private AlpnHeaderSupport() { + } + + /** + * Formats a list of raw ALPN protocol IDs into a single {@code ALPN} header. + */ + public static Header formatValue(final List<String> protocolIds) { + Args.notEmpty(protocolIds, "protocolIds"); + return MessageSupport.headerOfTokens(HttpHeaders.ALPN, protocolIds, AlpnHeaderSupport::encodeId); + } + + /** + * Parses an {@code ALPN} header into decoded protocol IDs. + */ + public static List<String> parseValue(final Header header) { + if (header == null) { + return Collections.emptyList(); + } + final List<String> out = new ArrayList<>(); + MessageSupport.parseTokens(header, token -> { + if (!token.isEmpty()) { + out.add(decodeId(token)); + } + }); + return out; + } + + /** + * Encodes a single raw protocol ID to canonical token form. + */ + public static String encodeId(final String id) { + Args.notBlank(id, "id"); + final byte[] bytes = id.getBytes(StandardCharsets.UTF_8); + final StringBuilder sb = new StringBuilder(bytes.length); + for (final byte b0 : bytes) { + final int b = b0 & 0xFF; + if (b == '%' || !isTchar(b)) { + appendPctEncoded(b, sb); + } else { + sb.append((char) b); + } + } + return sb.toString(); + } + + /** + * Decodes percent-encoded token to raw ID using UTF-8. + * Malformed / incomplete sequences are left literal. + */ + public static String decodeId(final String token) { + Args.notBlank(token, "token"); + try { + return PercentCodec.decode(token, StandardCharsets.UTF_8); + } catch (final IllegalArgumentException ex) { + return token; Review Comment: @arturobernalg This is a protocol error. Should not we treat it as such? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
