Class OAuthClientEntryLocalServiceUtil

java.lang.Object
com.liferay.oauth.client.persistence.service.OAuthClientEntryLocalServiceUtil

public class OAuthClientEntryLocalServiceUtil extends Object
Provides the local service utility for OAuthClientEntry. This utility wraps com.liferay.oauth.client.persistence.service.impl.OAuthClientEntryLocalServiceImpl 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

    • OAuthClientEntryLocalServiceUtil

      public OAuthClientEntryLocalServiceUtil()
  • Method Details

    • addOAuthClientEntry

      public static OAuthClientEntry addOAuthClientEntry(long userId, String authRequestParametersJSON, String authServerWellKnownURI, String infoJSON, long metadataCacheTime, String oidcUserInfoMapperJSON, String tokenRequestParametersJSON) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOAuthClientEntry

      public static OAuthClientEntry addOAuthClientEntry(OAuthClientEntry oAuthClientEntry)
      Adds the o auth client entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect OAuthClientEntryLocalServiceImpl 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:
      oAuthClientEntry - the o auth client entry
      Returns:
      the o auth client entry that was added
    • createOAuthClientEntry

      public static OAuthClientEntry createOAuthClientEntry(long oAuthClientEntryId)
      Creates a new o auth client entry with the primary key. Does not add the o auth client entry to the database.
      Parameters:
      oAuthClientEntryId - the primary key for the new o auth client entry
      Returns:
      the new o auth client entry
    • 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
    • deleteOAuthClientEntry

      public static OAuthClientEntry deleteOAuthClientEntry(long oAuthClientEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the o auth client entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect OAuthClientEntryLocalServiceImpl 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:
      oAuthClientEntryId - the primary key of the o auth client entry
      Returns:
      the o auth client entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a o auth client entry with the primary key could not be found
    • deleteOAuthClientEntry

      public static OAuthClientEntry deleteOAuthClientEntry(long companyId, String authServerWellKnownURI, String clientId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteOAuthClientEntry

      public static OAuthClientEntry deleteOAuthClientEntry(OAuthClientEntry oAuthClientEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the o auth client entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect OAuthClientEntryLocalServiceImpl 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:
      oAuthClientEntry - the o auth client entry
      Returns:
      the o auth client entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.oauth.client.persistence.model.impl.OAuthClientEntryModelImpl.

      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.oauth.client.persistence.model.impl.OAuthClientEntryModelImpl.

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

      public static OAuthClientEntry fetchOAuthClientEntry(long oAuthClientEntryId)
    • fetchOAuthClientEntry

      public static OAuthClientEntry fetchOAuthClientEntry(long companyId, String authServerWellKnownURI, String clientId)
    • getActionableDynamicQuery

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

      public static List<OAuthClientEntry> getAuthServerWellKnownURISuffixOAuthClientEntries(long companyId, String authServerWellKnownURISuffix)
    • getCompanyOAuthClientEntries

      public static List<OAuthClientEntry> getCompanyOAuthClientEntries(long companyId)
    • getIndexableActionableDynamicQuery

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

      public static List<OAuthClientEntry> getOAuthClientEntries(int start, int end)
      Returns a range of all the o auth client entries.

      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.oauth.client.persistence.model.impl.OAuthClientEntryModelImpl.

      Parameters:
      start - the lower bound of the range of o auth client entries
      end - the upper bound of the range of o auth client entries (not inclusive)
      Returns:
      the range of o auth client entries
    • getOAuthClientEntriesCount

      public static int getOAuthClientEntriesCount()
      Returns the number of o auth client entries.
      Returns:
      the number of o auth client entries
    • getOAuthClientEntry

      public static OAuthClientEntry getOAuthClientEntry(long oAuthClientEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the o auth client entry with the primary key.
      Parameters:
      oAuthClientEntryId - the primary key of the o auth client entry
      Returns:
      the o auth client entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a o auth client entry with the primary key could not be found
    • getOAuthClientEntry

      public static OAuthClientEntry getOAuthClientEntry(long companyId, String authServerWellKnownURI, String clientId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • getUserOAuthClientEntries

      public static List<OAuthClientEntry> getUserOAuthClientEntries(long userId)
    • updateOAuthClientEntry

      public static OAuthClientEntry updateOAuthClientEntry(long oAuthClientEntryId, String authRequestParametersJSON, String authServerWellKnownURI, String infoJSON, long metadataCacheTime, String oidcUserInfoMapperJSON, String tokenRequestParametersJSON) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateOAuthClientEntry

      public static OAuthClientEntry updateOAuthClientEntry(OAuthClientEntry oAuthClientEntry)
      Updates the o auth client entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect OAuthClientEntryLocalServiceImpl 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:
      oAuthClientEntry - the o auth client entry
      Returns:
      the o auth client entry that was updated
    • getService

      public static OAuthClientEntryLocalService getService()