|
| 1 | +/* |
| 2 | + * Copyright 2004-present the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.springframework.security.web.util.matcher; |
| 18 | + |
| 19 | +import java.net.InetAddress; |
| 20 | + |
| 21 | +import org.jspecify.annotations.Nullable; |
| 22 | + |
| 23 | +/** |
| 24 | + * Matches an {@link InetAddress}. |
| 25 | + * |
| 26 | + * @author Rossen Stoyanchev |
| 27 | + * @author Rob Winch |
| 28 | + * @since 7.1 |
| 29 | + */ |
| 30 | +@FunctionalInterface |
| 31 | +public interface InetAddressMatcher { |
| 32 | + |
| 33 | + /** |
| 34 | + * Whether the given address matches. |
| 35 | + * @param address the {@link InetAddress} to check |
| 36 | + * @return {@code true} if the address matches, {@code false} otherwise |
| 37 | + */ |
| 38 | + boolean matches(InetAddress address); |
| 39 | + |
| 40 | + /** |
| 41 | + * Whether the given address string matches. |
| 42 | + * @param address the IP address string to check (may be {@code null}) |
| 43 | + * @return {@code true} if the address matches, {@code false} otherwise or if |
| 44 | + * {@code null} |
| 45 | + * @since 7.1 |
| 46 | + */ |
| 47 | + default boolean matches(@Nullable String address) { |
| 48 | + return (address != null) ? matches(InetAddressParser.parseAddress(address)) : false; |
| 49 | + } |
| 50 | + |
| 51 | +} |
0 commit comments