1 /*
2  * JBoss, Home of Professional Open Source.
3  * Copyright 2014 Red Hat, Inc., and individual contributors
4  * as indicated by the @author tags.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  *  Unless required by applicable law or agreed to in writing, software
13  *  distributed under the License is distributed on an "AS IS" BASIS,
14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  *  See the License for the specific language governing permissions and
16  *  limitations under the License.
17  */
18
19 package io.undertow.predicate;
20
21 import java.util.Map;
22
23 import io.undertow.server.HttpServerExchange;
24 import io.undertow.util.AttachmentKey;
25
26 /**
27  * A predicate.
28  *
29  * This is mainly uses by handlers as a way to decide if a request should have certain
30  * processing applied, based on the given conditions.
31  *
32  * @author Stuart Douglas
33  */
34 public interface Predicate {
35
36     /**
37      * Attachment key that can be used to store additional predicate context that allows the predicates to store
38      * additional information. For example a predicate that matches on a regular expression can place additional
39      * information about match groups into the predicate context.
40      *
41      * Predicates must not rely on this attachment being present, it will only be present if the predicate is being
42      * used in a situation where this information may be required by later handlers.
43      *
44      */
45     AttachmentKey<Map<String, Object>> PREDICATE_CONTEXT = AttachmentKey.create(Map.class);
46
47     boolean resolve(final HttpServerExchange value);
48
49 }
50