com.ibm.commerce.accesscontrol.policymanager

Class AccessClause

  • java.lang.Object
    • com.ibm.commerce.accesscontrol.policymanager.AccessClause

  • public class AccessClause
extends java.lang.Object
    This class encapsulates the parameters returned from the getAccessClause() of the Policy Manager implementation. The accessClauseString carries the 'where' clause of the SQL query, and the flag prefilteringSuccessful indicates whether the prefiltering operation can be completed successfully or not.

    • Constructor Summary

      Constructors 
      Constructor and Description
      AccessClause()
      Constructs the AccessClause instance

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAccessClauseString()
      This method returns the 'where' clause of the generated query.
      java.util.ArrayList getParameterList()
      This method returns the parameters used by the access clause to build up the where clause of the query.
      boolean isPostfilteringNeeded()
      This method indicates whether or not post filtering should be done on the result of the access clause string.
      boolean isPrefilteringSuccessful()
      This method returns the flag indicating the result of the prefiltering operation.
      void postfilteringNeeded(boolean bNeeded)
      This method sets the flag indicating if post-filtering is needed.
      void prefilteringSuccessful(boolean bSuccess)
      This method sets the flag indicating the result of the Prefiltering operation.
      void setAccessClauseString(java.lang.String strClauseString)
      This method sets the 'where' clause String, generated out of the prefiltering process.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AccessClause

        public AccessClause()
        Constructs the AccessClause instance

    • Method Detail

      • getAccessClauseString

        public java.lang.String getAccessClauseString()
        This method returns the 'where' clause of the generated query. Can never be null. The isPrefilteringSuccessful() method should be called to determine if this 'where' clause is fully correct.
        Returns:
        The 'where' clause of the generated query
        See Also:
        isPrefilteringSuccessful()

      • getParameterList

        public java.util.ArrayList getParameterList()
        This method returns the parameters used by the access clause to build up the where clause of the query.
        Returns:
        java.util.ArrayList

      • isPostfilteringNeeded

        public boolean isPostfilteringNeeded()
        This method indicates whether or not post filtering should be done on the result of the access clause string. This should be checked only if pre-filtering was successful.
        Returns:
        true if postfiltering is needed.

      • isPrefilteringSuccessful

        public boolean isPrefilteringSuccessful()
        This method returns the flag indicating the result of the prefiltering operation.
        Returns:
        true if the prefiltering query generation is successful, false otherwise.

      • postfilteringNeeded

        public void postfilteringNeeded(boolean bNeeded)
        This method sets the flag indicating if post-filtering is needed. This is only meaningful if pre-filtering is successful.
        Parameters:
        bNeeded - True if post-filtering is needed, (for example, the result of the access clause query string is a super-set of the allowed resources) false if otherwise

      • prefilteringSuccessful

        public void prefilteringSuccessful(boolean bSuccess)
        This method sets the flag indicating the result of the Prefiltering operation.
        Parameters:
        The - result of the query generation. True if the query is complete by itself, otherwise false.

      • setAccessClauseString

        public void setAccessClauseString(java.lang.String strClauseString)
        This method sets the 'where' clause String, generated out of the prefiltering process.
        Parameters:
        The - 'where' clause String
Skip navigation links