Interface IPolicyRule

    • Method Detail

      • getDescription

        java.lang.String getDescription()
        Gets the description for this policy rule.

        Returns:
        The Description for this rule.
      • getName

        java.lang.String getName()
        Returns the name of the policy rule class.

        Returns:
        The name of the policy class.
      • getInstanceName

        java.lang.String getInstanceName()
        Returns the name of the policy rule instance.

        Returns:
        The name of the policy rule instance. If none is set the name of the implementation will be returned.
      • setPredicate

        void setPredicate​(IExpression exp)
        Sets a predicate expression for rule matching.

        Parameters:
        exp - The predicate expression for the rule.
      • getPredicate

        IExpression getPredicate()
        Returns the predicate expression for the rule.

        Returns:
        The predicate expression for the rule.
      • apply

        PolicyResult apply​(IRequest req)
        Applies the policy on the given Request. This may modify the request appropriately.

        Specified by:
        apply in interface IPolicy
        Parameters:
        req - The request on which to apply policy.
        Returns:
        The PolicyResult object.
      • getInstanceParams

        java.util.Vector<java.lang.String> getInstanceParams()
        Return configured parameters for a policy rule instance.
        Returns:
        nvPairs A Vector of name/value pairs. Each name/value pair is constructed as a String in name=value format.
      • getDefaultParams

        java.util.Vector<java.lang.String> getDefaultParams()
        Return default parameters for a policy implementation.
        Returns:
        nvPairs A Vector of name/value pairs. Each name/value pair is constructed as a String in name=value.
      • setError

        void setError​(IRequest req,
                      java.lang.String format,
                      java.lang.Object[] params)
      • setInstanceName

        void setInstanceName​(java.lang.String instanceName)