com.ibm.bpe.xpath.spi

Class XPathExtensionFunctionDescriptor

  • java.lang.Object
    • com.ibm.bpe.xpath.spi.XPathExtensionFunctionDescriptor


  • public class XPathExtensionFunctionDescriptor
    extends java.lang.Object
    This class describes a single XPath extension function that can be used in XPath expressions and conditions in a BPEL process. It provides all necessary information for the runtime environment to register and call the custom XPath function. The extension function can be exposed to the process runtime environment by implementing the XPathExtensionFunctionPlugin interface and providing a service configuration file.
    A complete function description comprises the following aspects:
    • the name of the function
    • the XML namespace of the extension function
    • the XML namespace prefix, used for this function in the expression or condition
    • the class name of the Java class that provides the functions implementation
    • the types of parameters
    • the type of the return value
    • the types of expressions and conditions where this function should be available
    Since:
    8.5
    • Constructor Detail

      • XPathExtensionFunctionDescriptor

        public XPathExtensionFunctionDescriptor(java.lang.String name,
                                        java.lang.String namespace,
                                        java.lang.String prefix,
                                        java.lang.String className,
                                        XPathExtensionFunctionDescriptor.ParameterType[] parameterTypes,
                                        XPathExtensionFunctionDescriptor.ParameterType returnType,
                                        XPathExtensionFunctionDescriptor.ExpressionType[] expressionTypes)
        Constructor setting all members.
        Parameters:
        name - The name of the function.
        namespace - The XML namespace of the XPath function.
        prefix - The XML namespace prefix, used for this function in the expression or condition.
        className - The class name of the Java class that provides the functions implementation.
        parameterTypes - The types of parameters
        returnType - The type of the return value.
        expressionTypes - The types of expressions and conditions, where this function should be available.
    • Method Detail

      • getName

        public java.lang.String getName()
        The name of the XPath function. It must match the XPath function name as well as the Java method in the class that provides the implementation of the method.
        Returns:
        The function name.
      • getPrefix

        public java.lang.String getPrefix()
        The namespace prefix used in the XPath expression or condition.
        Returns:
        The XML prefix.
      • getClassName

        public java.lang.String getClassName()
        The Java class name that contains the implementation of this function.
        Returns:
        The class name.
      • getNamespace

        public java.lang.String getNamespace()
        The namespace of the XPath function.
        Returns:
        The namespace.
      • setName

        public void setName(java.lang.String name)
        Sets the name of the XPath function.
        Parameters:
        name - The function name.
      • setPrefix

        public void setPrefix(java.lang.String prefix)
        Sets the XML prefix of the function.
        Parameters:
        prefix - The XML prefix.
      • setClassName

        public void setClassName(java.lang.String className)
        Sets the class name of the Java implementation.
        Parameters:
        className - The class name.
      • setNamespace

        public void setNamespace(java.lang.String namespace)
        Sets the XML namespace for the function.
        Parameters:
        namespace - The namespace.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
IBM Business Process ManagerTM
Release 8