Package org.forgerock.opendj.config

Record Class Deprecated

java.lang.Object
java.lang.Record
org.forgerock.opendj.config.Deprecated
Record Components:
definition - The managed object definition
propertyName - The property name of managed object that is marked as deprecated. Must be null when the deprecation applies to the managed object itself.
isForRemoval - Is component deprecated for removal in future release.
since - The version that indicates where this component was deprecated for removal
isEnabledCondition - A condition under which the deprecation is considered to be enabled.
public record Deprecated(AbstractManagedObjectDefinition<?,?> definition, String propertyName, boolean isForRemoval, com.forgerock.opendj.util.Version since, Condition isEnabledCondition) extends Record
Holds deprecation information of configuration objects or properties. These can be:
  • Deprecated (for removal): the configuration object or property has been replaced with an improved version, and it is no longer under development. Example : SNMP connection handler. There are better alternatives (Prometheus), this feature is based on a library that is no longer maintained and unlikely to compile in future.
  • Legacy (not recommended): where configuration object or property is not a best practice anymore but is supported for interoperability and migration reasons. Example : DIGEST-MD5 SASL mechanism. This SASL mechanism uses cryptography with known weaknesses and shouldn't be used in production. However, for interoperability with legacy systems, it may be supported.

  • Constructor Details

    • Deprecated

      public Deprecated(AbstractManagedObjectDefinition<?,?> definition, String propertyName, boolean isForRemoval, com.forgerock.opendj.util.Version since, Condition isEnabledCondition)
      Creates an instance of a Deprecated record class.
      Parameters:
      definition - the value for the definition record component
      propertyName - the value for the propertyName record component
      isForRemoval - the value for the isForRemoval record component
      since - the value for the since record component
      isEnabledCondition - the value for the isEnabledCondition record component

  • Method Details

    • getDeprecationMessage

      public LocalizableMessage getDeprecationMessage()
      Gets the deprecation message.
      Returns:
      Short localizable deprecation message.

    • getFullDeprecationMessage

      public LocalizableMessage getFullDeprecationMessage()
      Gets the full deprecation message with reason of deprecation and existing alternative(s).
      Returns:
      Full localizable deprecation message.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • definition

      public AbstractManagedObjectDefinition<?,?> definition()
      Returns the value of the definition record component.
      Returns:
      the value of the definition record component

    • propertyName

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

    • isForRemoval

      public boolean isForRemoval()
      Returns the value of the isForRemoval record component.
      Returns:
      the value of the isForRemoval record component

    • since

      public com.forgerock.opendj.util.Version since()
      Returns the value of the since record component.
      Returns:
      the value of the since record component

    • isEnabledCondition

      public Condition isEnabledCondition()
      Returns the value of the isEnabledCondition record component.
      Returns:
      the value of the isEnabledCondition record component