Record Class RegexBlock

java.lang.Object
java.lang.Record
io.camunda.connector.http.base.blocklist.block.RegexBlock
All Implemented Interfaces:
Block

public record RegexBlock(String blockName, Pattern pattern) extends Record implements Block
This class represents a Regular Expression Block that can be used to block URLs based on a regular expression pattern.

The Regex Block is defined by a blocking regular expression pattern and a block name. If a URL matches the regular expression pattern, it is considered blocked, and an exception is thrown.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RegexBlock(String blockName, Pattern pattern)
    Creates an instance of a RegexBlock record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the blockName record component.
    static RegexBlock
    create(String value, String blockName)
    Creates a new instance of the RegexBlock class with the specified regular expression pattern and block name.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the pattern record component.
    final String
    Returns a string representation of this record class.
    void
    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

    • RegexBlock

      public RegexBlock(String blockName, Pattern pattern)
      Creates an instance of a RegexBlock record class.
      Parameters:
      blockName - the value for the blockName record component
      pattern - the value for the pattern record component
  • Method Details

    • create

      public static RegexBlock create(String value, String blockName)
      Creates a new instance of the RegexBlock class with the specified regular expression pattern and block name.
      Parameters:
      value - The regular expression pattern used for blocking.
      blockName - The name of the block for identification.
      Returns:
      An instance of RegexBlock.
      Throws:
      IllegalArgumentException - if the provided regular expression pattern is invalid.
    • validate

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

      If the URL matches the regular expression pattern, 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
    • pattern

      public Pattern pattern()
      Returns the value of the pattern record component.
      Returns:
      the value of the pattern record component