001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.config.plugins.validation.constraints; 018 019import java.lang.annotation.Documented; 020import java.lang.annotation.ElementType; 021import java.lang.annotation.Retention; 022import java.lang.annotation.RetentionPolicy; 023import java.lang.annotation.Target; 024 025import org.apache.logging.log4j.core.config.plugins.validation.Constraint; 026import org.apache.logging.log4j.core.config.plugins.validation.validators.ValidPortValidator; 027 028/** 029 * Indicates that a plugin attribute must be a valid port number. A valid port number is an integer between 0 and 030 * 65535. 031 * 032 * @since 2.8 033 */ 034@Documented 035@Retention(RetentionPolicy.RUNTIME) 036@Target({ElementType.FIELD, ElementType.PARAMETER}) 037@Constraint(ValidPortValidator.class) 038public @interface ValidPort { 039 040 /** 041 * The message to be logged if this constraint is violated. This should normally be overridden. 042 */ 043 String message() default "The port number is invalid"; 044}