ok2c commented on code in PR #697: URL: https://github.com/apache/httpcomponents-core/pull/697#discussion_r4110809633
########## httpcore5/src/main/java/org/apache/hc/core5/http/signature/MessageSignatureContext.java: ########## @@ -0,0 +1,192 @@ +/* + * ==================================================================== + * 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.core5.http.signature; + +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.Locale; +import java.util.Map; + +import org.apache.hc.core5.annotation.Contract; +import org.apache.hc.core5.annotation.ThreadingBehavior; +import org.apache.hc.core5.http.HttpMessage; +import org.apache.hc.core5.http.HttpRequest; +import org.apache.hc.core5.http.MessageHeaders; +import org.apache.hc.core5.util.Args; + +/** + * Message context needed to resolve RFC 9421 components. Its thread-safety depends on + * the supplied HTTP message and trailer instances. + * This object intentionally contains no key lookup, cryptography, or signature policy. + * + * @since 5.5 + */ +@Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL) +public final class MessageSignatureContext { + + private final HttpMessage target; + private final HttpRequest relatedRequest; + private final MessageHeaders trailers; + private final MessageHeaders relatedRequestTrailers; + private final Map<String, StructuredFieldValueType> structuredFieldTypes; + + private MessageSignatureContext(final Builder builder) { + this.target = Args.notNull(builder.target, "Target message"); + this.relatedRequest = builder.relatedRequest; + this.trailers = builder.trailers; + this.relatedRequestTrailers = builder.relatedRequestTrailers; + this.structuredFieldTypes = Collections.unmodifiableMap(new LinkedHashMap<>(builder.structuredFieldTypes)); + } + + /** + * Creates a builder for a context targeting the given message. + * + * @param target the message to be signed or verified. + * @since 5.5 + */ + public static Builder builder(final HttpMessage target) { + return new Builder(target); + } + + /** + * Returns the target message to be signed or verified. Review Comment: @arturobernalg `@since 5.5` are redundant at the method level if this is a new class which has `@since 5.5` at the class level. Besides, a lot of javadcs in this change-set are useless. Like this one. Can you tweak your code generator to stop adding javadocs that carry no useful information? -- 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]
