Package org.opensearch.painless.spi

Class WhitelistClassBinding

  • public class WhitelistClassBinding
extends java.lang.Object
    A class binding represents a method call that stores state. Each class binding's Java class must have exactly one public constructor and one public method excluding those inherited directly from Object. The canonical type name parameters provided must match those of the constructor and method combined. The constructor for a class binding's Java class will be called when the binding method is called for the first time at which point state may be stored for the arguments passed into the constructor. The method for a binding class will be called each time the binding method is called and may use the previously stored state.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.util.List<java.lang.String> canonicalTypeNameParameters
      A List of Strings that are the Painless type names for the parameters of the constructor which can be used to look up the Java constructor through reflection.
      java.lang.String methodName
      The method name for this class binding.
      java.lang.String origin
      Information about where this constructor was allowlisted from.
      java.util.Map<java.lang.Class<?>,​java.lang.Object> painlessAnnotations
      The Map of annotations for this class binding.
      java.lang.String returnCanonicalTypeName
      The canonical type name for the return type.
      java.lang.String targetJavaClassName
      The Java class name this class binding targets.

    • Constructor Summary

      Constructors 
      Constructor Description
      WhitelistClassBinding​(java.lang.String origin, java.lang.String targetJavaClassName, java.lang.String methodName, java.lang.String returnCanonicalTypeName, java.util.List<java.lang.String> canonicalTypeNameParameters, java.util.List<java.lang.Object> painlessAnnotations)
      Standard constructor.

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • origin

        public final java.lang.String origin
        Information about where this constructor was allowlisted from.

      • targetJavaClassName

        public final java.lang.String targetJavaClassName
        The Java class name this class binding targets.

      • methodName

        public final java.lang.String methodName
        The method name for this class binding.

      • returnCanonicalTypeName

        public final java.lang.String returnCanonicalTypeName
        The canonical type name for the return type.

      • canonicalTypeNameParameters

        public final java.util.List<java.lang.String> canonicalTypeNameParameters
        A List of Strings that are the Painless type names for the parameters of the constructor which can be used to look up the Java constructor through reflection.

      • painlessAnnotations

        public final java.util.Map<java.lang.Class<?>,​java.lang.Object> painlessAnnotations
        The Map of annotations for this class binding.

    • Constructor Detail

      • WhitelistClassBinding

        public WhitelistClassBinding​(java.lang.String origin,
                             java.lang.String targetJavaClassName,
                             java.lang.String methodName,
                             java.lang.String returnCanonicalTypeName,
                             java.util.List<java.lang.String> canonicalTypeNameParameters,
                             java.util.List<java.lang.Object> painlessAnnotations)
        Standard constructor. All values must be not null.