Class OAuth2AuthorizationLocalServiceUtil

java.lang.Object
com.liferay.oauth2.provider.service.OAuth2AuthorizationLocalServiceUtil

public class OAuth2AuthorizationLocalServiceUtil extends Object
Provides the local service utility for OAuth2Authorization. This utility wraps com.liferay.oauth2.provider.service.impl.OAuth2AuthorizationLocalServiceImpl 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

    • OAuth2AuthorizationLocalServiceUtil

      public OAuth2AuthorizationLocalServiceUtil()
  • Method Details

    • addOAuth2Authorization

      @Deprecated public static OAuth2Authorization addOAuth2Authorization(long companyId, long userId, String userName, long oAuth2ApplicationId, long oAuth2ApplicationScopeAliasesId, String accessTokenContent, Date accessTokenCreateDate, Date accessTokenExpirationDate, String remoteIPInfo, String refreshTokenContent, Date refreshTokenCreateDate, Date refreshTokenExpirationDate)
    • addOAuth2Authorization

      public static OAuth2Authorization addOAuth2Authorization(long companyId, long userId, String userName, long oAuth2ApplicationId, long oAuth2ApplicationScopeAliasesId, String accessTokenContent, Date accessTokenCreateDate, Date accessTokenExpirationDate, String remoteHostInfo, String remoteIPInfo, String refreshTokenContent, Date refreshTokenCreateDate, Date refreshTokenExpirationDate)
    • addOAuth2Authorization

      public static OAuth2Authorization addOAuth2Authorization(OAuth2Authorization oAuth2Authorization)
      Adds the o auth2 authorization to the database. Also notifies the appropriate model listeners.

      Important: Inspect OAuth2AuthorizationLocalServiceImpl 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:
      oAuth2Authorization - the o auth2 authorization
      Returns:
      the o auth2 authorization that was added
    • addOAuth2ScopeGrantOAuth2Authorization

      public static boolean addOAuth2ScopeGrantOAuth2Authorization(long oAuth2ScopeGrantId, long oAuth2AuthorizationId)
    • addOAuth2ScopeGrantOAuth2Authorization

      public static boolean addOAuth2ScopeGrantOAuth2Authorization(long oAuth2ScopeGrantId, OAuth2Authorization oAuth2Authorization)
    • addOAuth2ScopeGrantOAuth2Authorizations

      public static boolean addOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId, List<OAuth2Authorization> oAuth2Authorizations)
    • addOAuth2ScopeGrantOAuth2Authorizations

      public static boolean addOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId, long[] oAuth2AuthorizationIds)
    • clearOAuth2ScopeGrantOAuth2Authorizations

      public static void clearOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId)
    • createOAuth2Authorization

      public static OAuth2Authorization createOAuth2Authorization(long oAuth2AuthorizationId)
      Creates a new o auth2 authorization with the primary key. Does not add the o auth2 authorization to the database.
      Parameters:
      oAuth2AuthorizationId - the primary key for the new o auth2 authorization
      Returns:
      the new o auth2 authorization
    • 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
    • deleteExpiredOAuth2Authorizations

      public static void deleteExpiredOAuth2Authorizations() throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteOAuth2Authorization

      public static OAuth2Authorization deleteOAuth2Authorization(long oAuth2AuthorizationId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the o auth2 authorization with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect OAuth2AuthorizationLocalServiceImpl 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:
      oAuth2AuthorizationId - the primary key of the o auth2 authorization
      Returns:
      the o auth2 authorization that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a o auth2 authorization with the primary key could not be found
    • deleteOAuth2Authorization

      public static OAuth2Authorization deleteOAuth2Authorization(OAuth2Authorization oAuth2Authorization)
      Deletes the o auth2 authorization from the database. Also notifies the appropriate model listeners.

      Important: Inspect OAuth2AuthorizationLocalServiceImpl 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:
      oAuth2Authorization - the o auth2 authorization
      Returns:
      the o auth2 authorization that was removed
    • deleteOAuth2ScopeGrantOAuth2Authorization

      public static void deleteOAuth2ScopeGrantOAuth2Authorization(long oAuth2ScopeGrantId, long oAuth2AuthorizationId)
    • deleteOAuth2ScopeGrantOAuth2Authorization

      public static void deleteOAuth2ScopeGrantOAuth2Authorization(long oAuth2ScopeGrantId, OAuth2Authorization oAuth2Authorization)
    • deleteOAuth2ScopeGrantOAuth2Authorizations

      public static void deleteOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId, List<OAuth2Authorization> oAuth2Authorizations)
    • deleteOAuth2ScopeGrantOAuth2Authorizations

      public static void deleteOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId, long[] oAuth2AuthorizationIds)
    • 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.oauth2.provider.model.impl.OAuth2AuthorizationModelImpl.

      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.oauth2.provider.model.impl.OAuth2AuthorizationModelImpl.

      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
    • fetchOAuth2Authorization

      public static OAuth2Authorization fetchOAuth2Authorization(long oAuth2AuthorizationId)
    • fetchOAuth2AuthorizationByAccessTokenContent

      public static OAuth2Authorization fetchOAuth2AuthorizationByAccessTokenContent(String accessTokenContent)
    • fetchOAuth2AuthorizationByRefreshTokenContent

      public static OAuth2Authorization fetchOAuth2AuthorizationByRefreshTokenContent(String refreshTokenContent)
    • fetchOAuth2AuthorizationByRememberDeviceContent

      public static OAuth2Authorization fetchOAuth2AuthorizationByRememberDeviceContent(long userId, long oAuth2ApplicationId, String rememberDeviceContent)
    • getActionableDynamicQuery

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

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

      public static OAuth2Authorization getOAuth2Authorization(long oAuth2AuthorizationId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the o auth2 authorization with the primary key.
      Parameters:
      oAuth2AuthorizationId - the primary key of the o auth2 authorization
      Returns:
      the o auth2 authorization
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a o auth2 authorization with the primary key could not be found
    • getOAuth2AuthorizationByAccessTokenContent

      public static OAuth2Authorization getOAuth2AuthorizationByAccessTokenContent(String accessTokenContent) throws NoSuchOAuth2AuthorizationException
      Throws:
      NoSuchOAuth2AuthorizationException
    • getOAuth2AuthorizationByRefreshTokenContent

      public static OAuth2Authorization getOAuth2AuthorizationByRefreshTokenContent(String refreshTokenContent) throws NoSuchOAuth2AuthorizationException
      Throws:
      NoSuchOAuth2AuthorizationException
    • getOAuth2Authorizations

      public static List<OAuth2Authorization> getOAuth2Authorizations(int start, int end)
      Returns a range of all the o auth2 authorizations.

      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.oauth2.provider.model.impl.OAuth2AuthorizationModelImpl.

      Parameters:
      start - the lower bound of the range of o auth2 authorizations
      end - the upper bound of the range of o auth2 authorizations (not inclusive)
      Returns:
      the range of o auth2 authorizations
    • getOAuth2Authorizations

      public static List<OAuth2Authorization> getOAuth2Authorizations(long oAuth2ApplicationId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<OAuth2Authorization> orderByComparator)
    • getOAuth2AuthorizationsCount

      public static int getOAuth2AuthorizationsCount()
      Returns the number of o auth2 authorizations.
      Returns:
      the number of o auth2 authorizations
    • getOAuth2AuthorizationsCount

      public static int getOAuth2AuthorizationsCount(long oAuth2ApplicationId)
    • getOAuth2ScopeGrantOAuth2Authorizations

      public static List<OAuth2Authorization> getOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId)
    • getOAuth2ScopeGrantOAuth2Authorizations

      public static List<OAuth2Authorization> getOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId, int start, int end)
    • getOAuth2ScopeGrantOAuth2Authorizations

      public static List<OAuth2Authorization> getOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<OAuth2Authorization> orderByComparator)
    • getOAuth2ScopeGrantOAuth2AuthorizationsCount

      public static int getOAuth2ScopeGrantOAuth2AuthorizationsCount(long oAuth2ScopeGrantId)
    • getOAuth2ScopeGrantPrimaryKeys

      public static long[] getOAuth2ScopeGrantPrimaryKeys(long oAuth2AuthorizationId)
      Returns the oAuth2ScopeGrantIds of the o auth2 scope grants associated with the o auth2 authorization.
      Parameters:
      oAuth2AuthorizationId - the oAuth2AuthorizationId of the o auth2 authorization
      Returns:
      long[] the oAuth2ScopeGrantIds of o auth2 scope grants associated with the o auth2 authorization
    • getOAuth2ScopeGrants

      public static Collection<OAuth2ScopeGrant> getOAuth2ScopeGrants(long oAuth2AuthorizationId)
    • 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
    • getUserOAuth2Authorizations

      public static List<OAuth2Authorization> getUserOAuth2Authorizations(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<OAuth2Authorization> orderByComparator)
    • getUserOAuth2AuthorizationsCount

      public static int getUserOAuth2AuthorizationsCount(long userId)
    • hasOAuth2ScopeGrantOAuth2Authorization

      public static boolean hasOAuth2ScopeGrantOAuth2Authorization(long oAuth2ScopeGrantId, long oAuth2AuthorizationId)
    • hasOAuth2ScopeGrantOAuth2Authorizations

      public static boolean hasOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId)
    • setOAuth2ScopeGrantOAuth2Authorizations

      public static void setOAuth2ScopeGrantOAuth2Authorizations(long oAuth2ScopeGrantId, long[] oAuth2AuthorizationIds)
    • updateOAuth2Authorization

      public static OAuth2Authorization updateOAuth2Authorization(OAuth2Authorization oAuth2Authorization)
      Updates the o auth2 authorization in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect OAuth2AuthorizationLocalServiceImpl 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:
      oAuth2Authorization - the o auth2 authorization
      Returns:
      the o auth2 authorization that was updated
    • updateRememberDeviceContent

      public static OAuth2Authorization updateRememberDeviceContent(String refreshTokenContent, String rememberDeviceContent)
    • getService

      public static OAuth2AuthorizationLocalService getService()