Package io.camunda.connector.http.base.blocklist.block

Record Class PortBlock

java.lang.Object
java.lang.Record
io.camunda.connector.http.base.blocklist.block.PortBlock
All Implemented Interfaces:
Block
public record PortBlock(String blockName, Set<Integer> blockedPorts) extends Record implements Block
This class represents a Port Block that can be used to block URLs based on specific port numbers.

The Port Block is defined by a comma-separated list of port numbers and a block name. If a URL's port matches any of the specified port numbers, it is considered blocked, and an exception is thrown.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PortBlock(String blockName, Set<Integer> blockedPorts)
    Creates an instance of a PortBlock record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<Integer>
    blockedPorts()
    Returns the value of the blockedPorts record component.
    String
    blockName()
    Returns the value of the blockName record component.
    static PortBlock
    create(String value, String blockName)
    Creates a new instance of the PortBlock class with the specified port numbers and block name.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    void
    validate(String url)
    Validates a given URL against the blocking criteria.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PortBlock

      public PortBlock(String blockName, Set<Integer> blockedPorts)
      Creates an instance of a PortBlock record class.
      Parameters:
      blockName - the value for the blockName record component
      blockedPorts - the value for the blockedPorts record component

  • Method Details

    • create

      public static PortBlock create(String value, String blockName)
      Creates a new instance of the PortBlock class with the specified port numbers and block name.
      Parameters:
      value - The comma-separated list of port numbers used for blocking.
      blockName - The name of the block for identification.
      Returns:
      An instance of PortBlock.
      Throws:
      IllegalArgumentException - if the provided port numbers or format are invalid.
      NumberFormatException - if the provided port numbers cannot be parsed as integers.
      NullPointerException - if either 'value' or 'blockName' is null.

    • validate

      public void validate(String url)
      Validates a given URL against the blocking criteria.

      If the URL's port matches any of the specified port numbers, a ConnectorInputException is thrown, indicating that the URL is blocked.

      Specified by:
      validate in interface Block
      Parameters:
      url - The URL to validate.
      Throws:
      ConnectorInputException - if the URL matches the block conditions.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • blockName

      public String blockName()
      Returns the value of the blockName record component.
      Returns:
      the value of the blockName record component

    • blockedPorts

      public Set<Integer> blockedPorts()
      Returns the value of the blockedPorts record component.
      Returns:
      the value of the blockedPorts record component