Package com.sun.identity.log

Class LogQuery

java.lang.Object
com.sun.identity.log.LogQuery
@SupportedAll @Deprecated(since="8.0.0", forRemoval=true) public class LogQuery extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
LogQuery defines the query format that the reader api supports. This class contains a list of individual query elements and also stores information about whether all the query to be satisfied or any one to be satisfied. It also allows caller to set required number of most recent records and to specify the sortby field name (optional).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALL_RECORDS
    Deprecated, for removal: This API element is subject to removal in a future version.
    All the records that matches query criteria (if any) will be retrieved.
    static final int
    MATCH_ALL_CONDITIONS
    Deprecated, for removal: This API element is subject to removal in a future version.
    matching condition, values of globalOperand.
    static final int
    MATCH_ANY_CONDITION
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final int
    MOST_RECENT_MAX_RECORDS
    Deprecated, for removal: This API element is subject to removal in a future version.
    when maximum records asked Most recent maximum number of records to be collected.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LogQuery()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Default constructor It creates the new object and assigns space to them.
    LogQuery(int max_record)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Customized constructor to set only maxrecord.
    LogQuery(int max_Record, int matchCriteria, String sortingBy)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Customized constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addQuery(QueryElement qryElement)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds a query element to the list present in LogQuery.
    ArrayList
    getColumns()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the table column names selected.
    int
    getGlobalOperand()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the value of global operand set in the query.
    int
    getNumRecordsWanted()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ArrayList
    getQueries()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the full list of query
    String
    getSortingField()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the field name on which records to be sorted.
    void
    setColumns(ArrayList columns)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the columns to be selected.
    void
    setGlobalOperand(int no)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the globalOperand field to either any query criteria match or to match all the criteria.
    void
    setMaxRecord(int value)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setSortingField(String fieldName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the field name on which records to be sorted.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • MATCH_ALL_CONDITIONS

      public static final int MATCH_ALL_CONDITIONS
      Deprecated, for removal: This API element is subject to removal in a future version.
      matching condition, values of globalOperand. All the queries to be applied successfully
      See Also:

    • MATCH_ANY_CONDITION

      public static final int MATCH_ANY_CONDITION
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • MOST_RECENT_MAX_RECORDS

      public static final int MOST_RECENT_MAX_RECORDS
      Deprecated, for removal: This API element is subject to removal in a future version.
      when maximum records asked Most recent maximum number of records to be collected. Here maximum number will be as stored in the configuration.
      See Also:

    • ALL_RECORDS

      public static final int ALL_RECORDS
      Deprecated, for removal: This API element is subject to removal in a future version.
      All the records that matches query criteria (if any) will be retrieved. Maximum number of records as configured will be ignored.
      See Also:

  • Constructor Details

    • LogQuery

      public LogQuery()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default constructor It creates the new object and assigns space to them. It sets default values when applicable.

    • LogQuery

      public LogQuery(int max_record)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Customized constructor to set only maxrecord.
      Parameters:
      max_record - is maximum number of most recent records to be returned.

    • LogQuery

      public LogQuery(int max_Record, int matchCriteria, String sortingBy) throws IllegalArgumentException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Customized constructor.
      Parameters:
      max_Record - the maximum number of most recent records to be returned
      matchCriteria - whether all queries or any one to match.
      sortingBy - fieldname on which records to be sorted.
      Throws:
      IllegalArgumentException - if any of the max_Record/matchCriteria is not valid.

  • Method Details

    • setGlobalOperand

      public void setGlobalOperand(int no) throws IllegalArgumentException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the globalOperand field to either any query criteria match or to match all the criteria.
      Parameters:
      no - the value to set to globalOperand
      Throws:
      IllegalArgumentException - when parameter is passed as neither all nor any match.

    • setMaxRecord

      public void setMaxRecord(int value)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addQuery

      public void addQuery(QueryElement qryElement)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds a query element to the list present in LogQuery.
      Parameters:
      qryElement - the query to be added into the list

    • getQueries

      public ArrayList getQueries()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the full list of query
      Returns:
      full list of query

    • getNumRecordsWanted

      public int getNumRecordsWanted()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getGlobalOperand

      public int getGlobalOperand()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the value of global operand set in the query.
      Returns:
      the value of global operand set in the query.

    • setSortingField

      public void setSortingField(String fieldName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the field name on which records to be sorted.
      Parameters:
      fieldName - field name on which records to be sorted.

    • getSortingField

      public String getSortingField()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the field name on which records to be sorted.
      Returns:
      the field name on which records to be sorted.

    • setColumns

      public void setColumns(ArrayList columns)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the columns to be selected. This applies to flatfile logging also; means "fields", rather than "columns" then.
      Parameters:
      columns - to request.

    • getColumns

      public ArrayList getColumns()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the table column names selected. This applies to flatfile logging also; means "fields", rather than "columns" then.
      Returns:
      the ArrayList of columns specified.