1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.config.plugins.validation.validators;
18
19 import org.apache.logging.log4j.Logger;
20 import org.apache.logging.log4j.core.config.plugins.validation.ConstraintValidator;
21 import org.apache.logging.log4j.core.config.plugins.validation.constraints.ValidHost;
22 import org.apache.logging.log4j.status.StatusLogger;
23
24 import java.net.InetAddress;
25 import java.net.UnknownHostException;
26
27 /**
28 * Validator that checks an object to verify it is a valid hostname or IP address. Validation rules follow the same
29 * logic as in {@link InetAddress#getByName(String)}.
30 *
31 * @since 2.8
32 */
33 public class ValidHostValidator implements ConstraintValidator<ValidHost> {
34
35 private static final Logger LOGGER = StatusLogger.getLogger();
36
37 private ValidHost annotation;
38
39 @Override
40 public void initialize(final ValidHost annotation) {
41 this.annotation = annotation;
42 }
43
44 @Override
45 public boolean isValid(final String name, final Object value) {
46 if (value == null) {
47 LOGGER.error(annotation.message());
48 return false;
49 }
50 if (value instanceof InetAddress) {
51 // InetAddress factory methods all have built in validation
52 return true;
53 }
54 try {
55 InetAddress.getByName(value.toString());
56 return true;
57 } catch (final UnknownHostException e) {
58 LOGGER.error(annotation.message(), e);
59 return false;
60 }
61 }
62 }