summaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/servlet/HttpHeader.java
blob: 95963b504f35865a1336cec4c62368c45edf2abc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/*
 * Copyright © 2016-2018 European Support Limited
 *
 * Licensed 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.
 */
package org.openecomp.sdc.logging.servlet;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Function;

/**
 * Handles any of possible header names to read a value for that header. This is useful for backward compatibility, if multiple headers may have the
 * same meaning. For instance, when requests come from multiple service, some using an old header and others using a new header to pass the same
 * information.
 *
 * @author evitaliy
 * @since 25 Mar 2018
 */
public class HttpHeader {

    private static final String NAMES_CANNOT_BE_NULL = "Names cannot be null";
    private static final String AT_LEAST_ONE_NAME_REQUIRED = "At least one name required";
    private final List<String> headerNames;

    /**
     * Receives a list of accepted header names as a String array.
     *
     * @param headerNames cannot be null or empty
     */
    public HttpHeader(String... headerNames) {
        if (Objects.requireNonNull(headerNames, NAMES_CANNOT_BE_NULL).length < 1) {
            throw new IllegalArgumentException(AT_LEAST_ONE_NAME_REQUIRED);
        }
        this.headerNames = Arrays.asList(headerNames);
    }

    /**
     * Receives a list of accepted header names as a list of String.
     *
     * @param headerNames cannot be null or empty
     */
    public HttpHeader(List<String> headerNames) {
        if (Objects.requireNonNull(headerNames, NAMES_CANNOT_BE_NULL).isEmpty()) {
            throw new IllegalArgumentException(AT_LEAST_ONE_NAME_REQUIRED);
        }
        this.headerNames = new ArrayList<>(headerNames);
    }

    /**
     * Returns the value of any of the possible headers.
     *
     * @param reader function for reading an HTTP header.
     * @return value or empty if not found
     */
    public Optional<String> getAny(Function<String, String> reader) {
        for (String k : headerNames) {
            String value = reader.apply(k);
            if (value != null) {
                return Optional.of(value);
            }
        }
        return Optional.empty();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        HttpHeader that = (HttpHeader) o;
        return Objects.equals(headerNames, that.headerNames);
    }

    @Override
    public int hashCode() {
        return Objects.hash(headerNames);
    }

    @Override
    public String toString() {
        return "HttpHeader{headerNames=" + headerNames + '}';
    }
}