io.confluent.kafka.connect.utils.config

Class ValidPort

java.lang.Object

io.confluent.kafka.connect.utils.config.ValidPort

All Implemented Interfaces:

org.apache.kafka.common.config.ConfigDef.Validator

public class ValidPort
extends Object
implements org.apache.kafka.common.config.ConfigDef.Validator

Validator is used to validate that the config setting is in the proper range for a TCP or UDP port.

Method Summary

Modifier and Type	Method and Description
void	ensureValid(String setting, Object value) Method is used to validate that the supplied port is within the valid range.
static ValidPort	of() Creates a default instance of the validator in the non privileged port range of 1025 through 65535.
static ValidPort	of(int start, int end) Creates a validator in the port range specified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static ValidPort of()

Creates a default instance of the validator in the non privileged port range of 1025 through 65535.

Returns:

ConfigDef.Validator checking for ports in the range of 1025 through 65535.

of

public static ValidPort of(int start,
                           int end)

Creates a validator in the port range specified.

Parameters:

start - The low port of the range.

end - The high port of the range.

Returns:

ConfigDef.Validator Validator for the port range specified.

Throws:

IllegalStateException - Throws if the start not a valid port number.

IllegalStateException - Throws if the end not a valid port number.

IllegalStateException - Throws if the start is greater than end.

ensureValid

public void ensureValid(String setting,
                        Object value)

Method is used to validate that the supplied port is within the valid range.

Specified by:

ensureValid in interface org.apache.kafka.common.config.ConfigDef.Validator

Parameters:

setting - name of the setting being tested.

value - value being tested.