summaryrefslogtreecommitdiffstats
path: root/container-disc/src/main/java/com/yahoo/container/jdisc/FilterUtil.java
blob: 24af56788b96c5c4c421a7e2a83e67d9d2d2e54c (plain) (blame)
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
101
102
103
104
105
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.jdisc;

import com.yahoo.component.ComponentId;
import com.yahoo.component.ComponentSpecification;
import com.yahoo.component.provider.ComponentRegistry;
import com.yahoo.container.http.filter.FilterChainRepository;
import com.yahoo.jdisc.application.BindingRepository;
import com.yahoo.jdisc.application.UriPattern;
import com.yahoo.jdisc.http.filter.RequestFilter;
import com.yahoo.jdisc.http.filter.ResponseFilter;
import com.yahoo.jdisc.http.filter.SecurityRequestFilter;
import com.yahoo.jdisc.http.filter.SecurityRequestFilterChain;

import java.util.List;

/**
 * Helper class to set up filter binding repositories based on config.
 *
 * @author Øyvind Bakksjø
 */
class FilterUtil {

    private static final ComponentId SEARCH_SERVER_COMPONENT_ID = ComponentId.fromString("SearchServer");

    private final BindingRepository<RequestFilter> requestFilters;
    private final BindingRepository<ResponseFilter> responseFilters;

    private FilterUtil(BindingRepository<RequestFilter> requestFilters, BindingRepository<ResponseFilter> responseFilters) {
        this.requestFilters = requestFilters;
        this.responseFilters = responseFilters;
    }

    private void configureFilters(List<FilterSpec> filtersConfig, FilterChainRepository filterChainRepository) {
        for (FilterSpec filterConfig : filtersConfig) {
            Object filter = filterChainRepository.getFilter(ComponentSpecification.fromString(filterConfig.getId()));
            if (filter == null) {
                throw new RuntimeException("No http filter with id " + filterConfig.getId());
            }
            addFilter(filter, filterConfig.getBinding());
        }
    }

    private void addFilter(Object filter, String binding) {
        if (filter instanceof RequestFilter && filter instanceof ResponseFilter) {
            throw new RuntimeException("The filter " + filter.getClass().getName() + 
                                       " is unsupported since it's both a RequestFilter and a ResponseFilter.");
        } else if (filter instanceof RequestFilter) {
            requestFilters.put(new UriPattern(binding), (RequestFilter) filter);
        } else if (filter instanceof ResponseFilter) {
            responseFilters.put(new UriPattern(binding), (ResponseFilter) filter);
        } else {
            throw new RuntimeException("Unknown filter type " + filter.getClass().getName());
        }
    }

    //TVT: remove
    private void configureLegacyFilters(ComponentId id, ComponentRegistry<SecurityRequestFilter> legacyRequestFilters) {
        ComponentId serverName = id.getNamespace();
        if (SEARCH_SERVER_COMPONENT_ID.equals(serverName) && !legacyRequestFilters.allComponents().isEmpty()) {
            requestFilters.bind("http://*/*",
                                SecurityRequestFilterChain.newInstance(legacyRequestFilters.allComponents()));
        }
    }

    /**
     * Populates binding repositories with filters based on config.
     *
     * @param requestFilters output argument that will be mutated
     * @param responseFilters output argument that will be mutated
     */
    public static void setupFilters(ComponentId componentId,
                                    ComponentRegistry<SecurityRequestFilter> legacyRequestFilters,
                                    List<FilterSpec> filtersConfig,
                                    FilterChainRepository filterChainRepository,
                                    BindingRepository<RequestFilter> requestFilters,
                                    BindingRepository<ResponseFilter> responseFilters) {
        FilterUtil filterUtil = new FilterUtil(requestFilters, responseFilters);

        // TODO: remove
        filterUtil.configureLegacyFilters(componentId, legacyRequestFilters);

        filterUtil.configureFilters(filtersConfig, filterChainRepository);
    }

    public static class FilterSpec {

        private final String id;
        private final String binding;

        public FilterSpec(String id, String binding) {
            this.id = id;
            this.binding = binding;
        }

        public String getId() {
            return id;
        }

        public String getBinding() {
            return binding;
        }
    }

}