org.openfact.events.admin.AdminEventQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openfact-server-spi-private Show documentation
The newest version!
package org.openfact.events.admin;

import java.util.Date;
import java.util.List;

public interface AdminEventQuery {

    /**
     * Search by resource organization
     *
     * @param organizationId organization id
     * @return Associated AdminEventQuery for method chaining
     */
    AdminEventQuery organization(String organizationId);

    /**
     * Search by authentication organization
     *
     * @param organizationId organization name
     * @return Associated AdminEventQuery for method chaining
     */
    AdminEventQuery authOrganization(String organizationId);

    /**
     * Search by authenticated user
     *
     * @param userId user email
     * @return Associated AdminEventQuery for method chaining
     */
    AdminEventQuery authUser(String userId);

    /**
     * Search by request ip address
     *
     * @param ipAddress
     * @return Associated AdminEventQuery for method chaining
     */
    AdminEventQuery authIpAddress(String ipAddress);

    /**
     * Search by operation type
     *
     * @param operations
     * @return this for method chaining
     */
    AdminEventQuery operation(OperationType... operations);

    /**
     * Search by {@link ResourceType}.
     *
     * @param resourceTypes
     * @return this for method chaining
     */
    AdminEventQuery resourceType(String... resourceTypes);

    /**
     * Search by resource path. Supports wildcards * and **. For example:
     * 
     * */master - matches 'organizations/master'
     * **/00d4b16f - matches 'organizations/master/clients/00d4b16f'
     * organizations/master/** - matches anything under 'organizations/master'
     * 
     *
     * @param resourcePath
     * @return this for method chaining
     */
    AdminEventQuery resourcePath(String resourcePath);

    /**
     * Search by events after the specified time
     *
     * @param fromTime from date
     * @return this for method chaining
     */
    AdminEventQuery fromTime(Date fromTime);

    /**
     * Search by events before the specified time
     *
     * @param toTime to date
     * @return this for method chaining
     */
    AdminEventQuery toTime(Date toTime);

    /**
     * Used for pagination
     *
     * @param first first result to return
     * @return this for method chaining
     */
    AdminEventQuery firstResult(int first);

    /**
     * Use for pagination
     *
     * @param max the maximum results to return
     * @return this for method chaining
     */
    AdminEventQuery maxResults(int max);

    /**
     * Executes the createQuery and returns the results
     *
     * @return
     */
    List getResultList();
}