Package oracle.rules.sdk2.decisionpoint

Class DecisionPointBuilder

java.lang.Object
oracle.rules.sdk2.decisionpoint.DecisionPointBuilder
public class DecisionPointBuilder extends Object
Builder for creating a decision point.

  • Field Details

    • DECISION_TRACE_OFF

      public static final int DECISION_TRACE_OFF
      See Also:

    • DECISION_TRACE_PRODUCTION

      public static final int DECISION_TRACE_PRODUCTION
      See Also:

    • DECISION_TRACE_DEVELOPMENT

      public static final int DECISION_TRACE_DEVELOPMENT
      See Also:

  • Constructor Details

    • DecisionPointBuilder

      public DecisionPointBuilder()
      Constructor.

  • Method Details

    • with

      public DecisionPointBuilder with(DictionaryFQN fqn)
      Fluent interface method which aliases the setDictionaryFQN(oracle.rules.sdk2.repository.DictionaryFQN) method. This will cause the decision point to retrieve the dictionary with the indicated name from the MDS repository.
      Parameters:
      fqn - the name of the dictionary to be used
      Returns:
      self

    • with

      public DecisionPointBuilder with(RuleDictionary dict)
      Fluent interface method which aliases the setDictionary(oracle.rules.sdk2.dictionary.RuleDictionary) method. This will cause the decision point to use the specified dictionary.
      Parameters:
      dict - the caller-loaded dictionary to be used
      Returns:
      self

    • with

      public DecisionPointBuilder with(String decisionFunction)
      Fluent interface method which aliases the setDecisionFunction(java.lang.String) method. This will cause the decision point to use the specified decision function.
      Parameters:
      decisionFunction - the unqualified name of the decision function to call
      Returns:
      self

    • build

      public DecisionPoint build() throws SDKException
      Constructs and returns a DecisionPoint instance from the values specified in this builder.
      Returns:
      a new DecisionPoint instance
      Throws:
      SDKException - if the builder has not been properly specified

    • setDecisionTraceLevel

      public DecisionPointBuilder setDecisionTraceLevel(int level)
      Set the decision trace level. This defaults to DECISION_TRACE_OFF
      Parameters:
      level - the decision trace level, as defined in RuleSession
      Returns:
      this

    • getDecisionTraceLevel

      public int getDecisionTraceLevel()
      Retrieve the decision trace level.
      Returns:
      the decision trace level

    • setDecisionTraceLimit

      public DecisionPointBuilder setDecisionTraceLimit(int limit)
      Set the decision trace limit. This defaults to 10000.
      Parameters:
      limit - the decision trace limit, as defined in RuleSession
      Returns:
      this

    • getDecisionTraceLimit

      public int getDecisionTraceLimit()
      Retrieve the decision trace limit.
      Returns:
      the decision trace limit

    • setConfig

      public DecisionPointBuilder setConfig(Map<?,?> config)
      Parameters:
      config - the Map instance to use
      Returns:
      this

    • getConfig

      public Map getConfig()
      Retrieve the config map to be used for the RuleSession.
      Returns:
      the config map

    • shouldPool

      public boolean shouldPool()
      By default, the decision point will manage a pool of RuleSession instances. This returns the value of whether or not it should do this.
      Returns:
      true if the decision point will manage a pool, false otherwise

    • setShouldPool

      public DecisionPointBuilder setShouldPool(boolean shouldPool)
      Set the value of the pooling attribute. If set to false, the caller must supply a RuleSession instance configued with the necessary RL code to the DecisionPointInstance before calling the invoke method. Not using the pool management capabilities of decision point is considered an advanced usecase.
      Returns:
      self

    • shouldRefresh

      public boolean shouldRefresh()
      By default, the decision point will detect changes to the rule dictionary identified by the DictionaryFQN. When a change is detected, the dictionary is reloaded and the pool of RuleSession instances is refreshed if shouldPool() is true. This is only applicable if the DecisionPointBuilder has the DictionaryFQN set.
      Returns:
      true if the decision point respond to dictionary changes.

    • setShouldRefresh

      public DecisionPointBuilder setShouldRefresh(boolean shouldRefresh)
      Set the value of the dictionary refresh attribute. If set to false, the dictionary is loaded once and not reloaded if the dictionary is modified. This is only applicable if the DecisionPointBuilder has the DictionaryFQN set.
      Returns:
      self

    • setInitialSize

      public DecisionPointBuilder setInitialSize(int size)
      Set the initial size of the rule session pool managed by the decision point. This should only be changed after thorough performance analysis.
      Returns:
      self

    • setSoftMaxSize

      public DecisionPointBuilder setSoftMaxSize(int size)
      Set the soft maximum size of the rule session pool managed by the decision point. This should only be changed after thorough performance analysis.
      Returns:
      self

    • setDebug

      @Deprecated public DecisionPointBuilder setDebug(boolean debug)
      Deprecated.
      Previously controlled debug output. Now a noop.
      Parameters:
      debug - true to turn debug output on, false to turn it off
      Returns:
      self

    • isDebug

      @Deprecated public boolean isDebug()
      Deprecated.
      Previously controlled debug output. Now a noop.
      Returns:
      true to turn debug output on, false to turn it off

    • getDictionaryFQN

      public DictionaryFQN getDictionaryFQN()
      Return the fully-qualified name of the dictionary that this decision point is using.
      Returns:
      fully-qualified name of dictionary

    • setDictionaryFQN

      public DecisionPointBuilder setDictionaryFQN(DictionaryFQN fqn)
      This will cause the decision point to retrieve the dictionary with the indicated name from the MDS repository.
      Parameters:
      fqn - the name of the dictionary to be used.
      Returns:
      self

    • setDictionary

      public DecisionPointBuilder setDictionary(RuleDictionary dict)
      Sets the rule dictionary instance, when loaded by developer code instead of through MDS. The preferred way of loading the rule dictionary is to configure MDS and then set only the name of the dictionary which this decision point should use. Do not call setDictionaryName in this case.
      Parameters:
      dict - a reference to a RuleDictionary to be used by this DecisionPoint
      Returns:
      self

    • getDictionary

      public RuleDictionary getDictionary()
      The rule dictionary instance, when loaded by client code instead of through MDS.
      Returns:
      the specified dictionary

    • setDecisionFunction

      public DecisionPointBuilder setDecisionFunction(String decisionFunction)
      Set the unqualified name of the decision function to call as part of this decision point. This is the name only, and not the fully-qualified name.
      Parameters:
      decisionFunction - name of the decision function to call
      Returns:
      self

    • getDecisionFunction

      public String getDecisionFunction()
      Return the name of the decision function to be executed in this decision point.
      Returns:
      the name of the decision function

    • setClassLoader

      public DecisionPointBuilder setClassLoader(ClassLoader loader)
      Set the classloader to be used by this decision point. Typically, this does not need to be set explictly, as the environment will contain an appropriate classloader.
      Parameters:
      loader - ClassLoader instance from which to load the built-in rules DecisionPointDictioanry
      Returns:
      self

    • getClassLoader

      public ClassLoader getClassLoader()
      The classloader to be used by this decision point.
      Returns:
      the classloader instance to be used by this decision point, or null if the default one is to be used

    • getProperties

      public Map<String,Object> getProperties()
      Return all properties accessible by the DecisionPointInstance
      Returns:
      a map of all properties

    • getProperty

      public Object getProperty(String name)
      Return a single property value
      Parameters:
      name - name of the property value to retrieve
      Returns:
      the value of the property name

    • setProperty

      public DecisionPointBuilder setProperty(String name, Object value)
      Set a single property value. These properties are local to the decision point and do not affect the JVM system properties.
      Parameters:
      name - the name of the property to set
      value - the value of the property
      Returns:
      self

    • getCurrentDate

      public Calendar getCurrentDate()
      Return the current date used by this decision point
      Returns:
      the calendar representing the current date

    • setCurrentDate

      public DecisionPointBuilder setCurrentDate(Calendar currentDate)
      Set the current date to be used by this decision point
      Parameters:
      currentDate - set the current date of RuleSessions used by this decision point
      Returns:
      self

    • getEffectiveDate

      public Calendar getEffectiveDate()
      Return the effective date used by this decision point
      Returns:
      the calendar representing the effective date

    • setEffectiveDate

      public DecisionPointBuilder setEffectiveDate(Calendar effectiveDate)
      Set the effective date to be used by this decision point
      Parameters:
      effectiveDate - set the effective date of RuleSessions used by this decision point
      Returns:
      self

    • createDecisionPointMetadata

      @Deprecated public static void createDecisionPointMetadata(String fileName, String decisionPointName, String topViewDefName, List<String> javaClassNames, boolean forWebService, oracle.jbo.server.DBTransactionImpl2 txn) throws SDKException
      Deprecated.
      Creates metadata for a decision point within a given dictionary file. If the file does not exist, it will be created. This method creates two decision functions, a technical wrapper decision function called name_W, and a decision function which is configurable. NOTE: This method is not UTF-8 compliant.
      Parameters:
      fileName - absolute path to file
      decisionPointName - the name of the decision point to be created, which will be the name of the decision function created as well.
      topViewDefName - the root View Definition of the JBO VO-Tree upon which the Decision Point's rules will be based.
      javaClassNames - Java classes, either as ancillary input facts or as ActionTypes
      forWebService - if true, the Decision Point will be configured for use via Decision Services as a Decision Component. If false, the D.F. will be set up for use from Java.
      txn - a Transaction object to be used to retrieve locale-specific details from the View Object hierarchy. If this value is null, then only the base VO definition in the Default Locale will be used.
      Throws:
      SDKException

    • processWebInputs

      public static DecisionPointInstance processWebInputs(RuleSession rs, DecisionPointInputs dpinputs) throws RLException, SDKException
      Create a new DecisionPointInstance using the RuleSession and DecisionPointInputs instances passed as parameters.
      Parameters:
      dpinputs - the inputs to the decision point
      Returns:
      the DecisionPointInstance in which the execution was done
      Throws:
      RLException
      SDKException

    • processWebInputs

      public static DecisionPointInstance processWebInputs(RuleSession rs, SimpleDecisionPointInput dpinput) throws RLException, SDKException
      Create a new DecisionPointInstance using the RuleSession and SimpleDecisionPointInput instances passed as parameters.
      Parameters:
      rs - rule session to use with the DecisionPointInstance
      dpinput - the inputs to the decision point
      Returns:
      the DecisionPointInstance in which the execution was done
      Throws:
      RLException
      SDKException

    • stringToFqn

      public static DictionaryFQN stringToFqn(String fqn)

    • addDataSource

      public static void addDataSource(String datasrc, String url, String user, String pw) throws SQLException, NamingException
      setup a jndi data source for unit test
      Parameters:
      datasrc - - name of data source, e.g. jdbc/MyDataSource
      url - - the "connect string" to the database, e.g. jdbc:orcl:thin:@localhost:1521:xe
      user - - DB user id
      pw - - DB password
      Throws:
      SQLException
      NamingException