Class AuditEventLocalServiceUtil

java.lang.Object
com.liferay.portal.security.audit.storage.service.AuditEventLocalServiceUtil

public class AuditEventLocalServiceUtil extends Object
Provides the local service utility for AuditEvent. This utility wraps com.liferay.portal.security.audit.storage.service.impl.AuditEventLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
See Also:
Generated:
  • Constructor Details

    • AuditEventLocalServiceUtil

      public AuditEventLocalServiceUtil()
  • Method Details

    • addAuditEvent

      public static AuditEvent addAuditEvent(AuditEvent auditEvent)
      Adds the audit event to the database. Also notifies the appropriate model listeners.

      Important: Inspect AuditEventLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      auditEvent - the audit event
      Returns:
      the audit event that was added
    • addAuditEvent

      public static AuditEvent addAuditEvent(com.liferay.portal.kernel.audit.AuditMessage auditMessage)
    • addAuditEvents

      public static void addAuditEvents(List<com.liferay.portal.kernel.audit.AuditMessage> auditMessages)
    • createAuditEvent

      public static AuditEvent createAuditEvent(long auditEventId)
      Creates a new audit event with the primary key. Does not add the audit event to the database.
      Parameters:
      auditEventId - the primary key for the new audit event
      Returns:
      the new audit event
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteAuditEvent

      public static AuditEvent deleteAuditEvent(AuditEvent auditEvent)
      Deletes the audit event from the database. Also notifies the appropriate model listeners.

      Important: Inspect AuditEventLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      auditEvent - the audit event
      Returns:
      the audit event that was removed
    • deleteAuditEvent

      public static AuditEvent deleteAuditEvent(long auditEventId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the audit event with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AuditEventLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      auditEventId - the primary key of the audit event
      Returns:
      the audit event that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a audit event with the primary key could not be found
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
      Performs a dynamic query on the database and returns a range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.security.audit.storage.model.impl.AuditEventModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
      Performs a dynamic query on the database and returns an ordered range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.security.audit.storage.model.impl.AuditEventModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchAuditEvent

      public static AuditEvent fetchAuditEvent(long auditEventId)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getAuditEvent

      public static AuditEvent getAuditEvent(long auditEventId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the audit event with the primary key.
      Parameters:
      auditEventId - the primary key of the audit event
      Returns:
      the audit event
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a audit event with the primary key could not be found
    • getAuditEvents

      public static List<AuditEvent> getAuditEvents(int start, int end)
      Returns a range of all the audit events.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.security.audit.storage.model.impl.AuditEventModelImpl.

      Parameters:
      start - the lower bound of the range of audit events
      end - the upper bound of the range of audit events (not inclusive)
      Returns:
      the range of audit events
    • getAuditEvents

      public static List<AuditEvent> getAuditEvents(long companyId, int start, int end)
    • getAuditEvents

      public static List<AuditEvent> getAuditEvents(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)
    • getAuditEvents

      public static List<AuditEvent> getAuditEvents(long companyId, long groupId, long userId, String userName, Date createDateGT, Date createDateLT, String eventType, String className, String classPK, String clientHost, String clientIP, String serverName, int serverPort, String sessionID, boolean andSearch, int start, int end)
    • getAuditEvents

      public static List<AuditEvent> getAuditEvents(long companyId, long groupId, long userId, String userName, Date createDateGT, Date createDateLT, String eventType, String className, String classPK, String clientHost, String clientIP, String serverName, int serverPort, String sessionID, boolean andSearch, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)
    • getAuditEventsCount

      public static int getAuditEventsCount()
      Returns the number of audit events.
      Returns:
      the number of audit events
    • getAuditEventsCount

      public static int getAuditEventsCount(long companyId)
    • getAuditEventsCount

      public static int getAuditEventsCount(long companyId, long groupId, long userId, String userName, Date createDateGT, Date createDateLT, String eventType, String className, String classPK, String clientHost, String clientIP, String serverName, int serverPort, String sessionID, boolean andSearch)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateAuditEvent

      public static AuditEvent updateAuditEvent(AuditEvent auditEvent)
      Updates the audit event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AuditEventLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      auditEvent - the audit event
      Returns:
      the audit event that was updated
    • getService

      public static AuditEventLocalService getService()