Class RememberMeTokenLocalServiceUtil

Object
com.liferay.portal.kernel.service.RememberMeTokenLocalServiceUtil

public class RememberMeTokenLocalServiceUtil extends Object
Provides the local service utility for RememberMeToken. This utility wraps com.liferay.portal.service.impl.RememberMeTokenLocalServiceImpl 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • RememberMeTokenLocalServiceUtil

      public RememberMeTokenLocalServiceUtil()
  • Method Details

    • addRememberMeToken

      public static RememberMeToken addRememberMeToken(long companyId, long userId, Date expirationDate, Consumer<String> valueConsumer) throws PwdEncryptorException
      Throws:
      PwdEncryptorException
    • addRememberMeToken

      public static RememberMeToken addRememberMeToken(RememberMeToken rememberMeToken)
      Adds the remember me token to the database. Also notifies the appropriate model listeners.

      Important: Inspect RememberMeTokenLocalServiceImpl 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:
      rememberMeToken - the remember me token
      Returns:
      the remember me token that was added
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createRememberMeToken

      public static RememberMeToken createRememberMeToken(long rememberMeTokenId)
      Creates a new remember me token with the primary key. Does not add the remember me token to the database.
      Parameters:
      rememberMeTokenId - the primary key for the new remember me token
      Returns:
      the new remember me token
    • deleteExpiredRememberMeTokens

      public static void deleteExpiredRememberMeTokens(Date expirationDate)
    • deleteExpiredRememberMeTokens

      public static void deleteExpiredRememberMeTokens(long userId)
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteRememberMeToken

      public static RememberMeToken deleteRememberMeToken(long rememberMeTokenId) throws PortalException
      Deletes the remember me token with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect RememberMeTokenLocalServiceImpl 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:
      rememberMeTokenId - the primary key of the remember me token
      Returns:
      the remember me token that was removed
      Throws:
      PortalException - if a remember me token with the primary key could not be found
    • deleteRememberMeToken

      public static RememberMeToken deleteRememberMeToken(RememberMeToken rememberMeToken)
      Deletes the remember me token from the database. Also notifies the appropriate model listeners.

      Important: Inspect RememberMeTokenLocalServiceImpl 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:
      rememberMeToken - the remember me token
      Returns:
      the remember me token that was removed
    • 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 DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(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(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.model.impl.RememberMeTokenModelImpl.

      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(DynamicQuery dynamicQuery, int start, int end, 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.model.impl.RememberMeTokenModelImpl.

      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(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(DynamicQuery dynamicQuery, 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
    • fetchRememberMeToken

      public static RememberMeToken fetchRememberMeToken(long rememberMeTokenId)
    • fetchRememberMeToken

      public static RememberMeToken fetchRememberMeToken(long rememberMeTokenId, String value) throws PwdEncryptorException
      Throws:
      PwdEncryptorException
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getRememberMeToken

      public static RememberMeToken getRememberMeToken(long rememberMeTokenId) throws PortalException
      Returns the remember me token with the primary key.
      Parameters:
      rememberMeTokenId - the primary key of the remember me token
      Returns:
      the remember me token
      Throws:
      PortalException - if a remember me token with the primary key could not be found
    • getRememberMeTokens

      public static List<RememberMeToken> getRememberMeTokens(int start, int end)
      Returns a range of all the remember me tokens.

      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.model.impl.RememberMeTokenModelImpl.

      Parameters:
      start - the lower bound of the range of remember me tokens
      end - the upper bound of the range of remember me tokens (not inclusive)
      Returns:
      the range of remember me tokens
    • getRememberMeTokensCount

      public static int getRememberMeTokensCount()
      Returns the number of remember me tokens.
      Returns:
      the number of remember me tokens
    • updateRememberMeToken

      public static RememberMeToken updateRememberMeToken(RememberMeToken rememberMeToken)
      Updates the remember me token in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect RememberMeTokenLocalServiceImpl 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:
      rememberMeToken - the remember me token
      Returns:
      the remember me token that was updated
    • getService

      public static RememberMeTokenLocalService getService()
    • setService

      public static void setService(RememberMeTokenLocalService service)