Record Class UrlBlock

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

public record UrlBlock(String value, String blockName) extends Record implements Block
This class represents a URL Block that can be used to block specific URLs based on a substring match.

The URL Block is defined by a blocking value and a block name. If a URL contains the blocking value as a substring, it is considered blocked, and an exception is thrown.

For example, if the value is "example.com" and a URL contains "http://www.example.com", it will be blocked.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UrlBlock(String value, String blockName)
    Creates an instance of a UrlBlock record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the blockName record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    final String
    Returns a string representation of this record class.
    void
    Validates a given URL against the blocking criteria.
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • UrlBlock

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

    • validate

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

      If the URL contains the blocking value as a substring, 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.
    • value

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

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