Class OAuth2ApplicationLocalServiceUtil
com.liferay.oauth2.provider.service.impl.OAuth2ApplicationLocalServiceImpl 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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic OAuth2ApplicationaddOAuth2Application(long companyId, long userId, String userName, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, boolean trustedApplication, Consumer<OAuth2ScopeBuilder> builderConsumer, com.liferay.portal.kernel.service.ServiceContext serviceContext) static OAuth2ApplicationaddOAuth2Application(long companyId, long userId, String userName, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, List<String> scopeAliasesList, boolean trustedApplication, com.liferay.portal.kernel.service.ServiceContext serviceContext) static OAuth2ApplicationaddOAuth2Application(OAuth2Application oAuth2Application) Adds the o auth2 application to the database.static OAuth2ApplicationaddOrUpdateOAuth2Application(String externalReferenceCode, long userId, String userName, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, boolean trustedApplication, Consumer<OAuth2ScopeBuilder> builderConsumer, com.liferay.portal.kernel.service.ServiceContext serviceContext) static OAuth2ApplicationaddOrUpdateOAuth2Application(String externalReferenceCode, long userId, String userName, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, List<String> scopeAliasesList, boolean trustedApplication, com.liferay.portal.kernel.service.ServiceContext serviceContext) static OAuth2ApplicationcreateOAuth2Application(long oAuth2ApplicationId) Creates a new o auth2 application with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static OAuth2ApplicationdeleteOAuth2Application(long oAuth2ApplicationId) Deletes the o auth2 application with the primary key from the database.static OAuth2ApplicationdeleteOAuth2Application(OAuth2Application oAuth2Application) Deletes the o auth2 application from the database.static voiddeleteOAuth2Applications(long companyId) static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.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.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.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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.static OAuth2ApplicationfetchOAuth2Application(long oAuth2ApplicationId) static OAuth2ApplicationfetchOAuth2Application(long companyId, String clientId) static OAuth2ApplicationfetchOAuth2ApplicationByExternalReferenceCode(String externalReferenceCode, long companyId) static OAuth2ApplicationfetchOAuth2ApplicationByUuidAndCompanyId(String uuid, long companyId) Returns the o auth2 application with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic OAuth2ApplicationgetOAuth2Application(long oAuth2ApplicationId) Returns the o auth2 application with the primary key.static OAuth2ApplicationgetOAuth2Application(long companyId, String clientId) static OAuth2ApplicationgetOAuth2ApplicationByExternalReferenceCode(String externalReferenceCode, long companyId) static OAuth2ApplicationgetOAuth2ApplicationByUuidAndCompanyId(String uuid, long companyId) Returns the o auth2 application with the matching UUID and company.static List<OAuth2Application> getOAuth2Applications(int start, int end) Returns a range of all the o auth2 applications.static List<OAuth2Application> getOAuth2Applications(long companyId) static List<OAuth2Application> getOAuth2Applications(long companyId, int clientProfile) static intReturns the number of o auth2 applications.static StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static OAuth2ApplicationupdateExternalReferenceCode(long oAuth2ApplicationId, String externalReferenceCode) static OAuth2ApplicationupdateExternalReferenceCode(OAuth2Application oAuth2Application, String externalReferenceCode) static OAuth2ApplicationupdateIcon(long oAuth2ApplicationId, InputStream inputStream) static OAuth2ApplicationupdateOAuth2Application(long oAuth2ApplicationId, long oAuth2ApplicationScopeAliasesId, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, boolean trustedApplication) static OAuth2ApplicationupdateOAuth2Application(OAuth2Application oAuth2Application) Updates the o auth2 application in the database or adds it if it does not yet exist.static OAuth2ApplicationupdateScopeAliases(long userId, String userName, long oAuth2ApplicationId, List<String> scopeAliasesList)
-
Constructor Details
-
OAuth2ApplicationLocalServiceUtil
public OAuth2ApplicationLocalServiceUtil()
-
-
Method Details
-
addOAuth2Application
public static OAuth2Application addOAuth2Application(long companyId, long userId, String userName, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, boolean trustedApplication, Consumer<OAuth2ScopeBuilder> builderConsumer, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addOAuth2Application
public static OAuth2Application addOAuth2Application(long companyId, long userId, String userName, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, List<String> scopeAliasesList, boolean trustedApplication, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addOAuth2Application
Adds the o auth2 application to the database. Also notifies the appropriate model listeners.Important: Inspect OAuth2ApplicationLocalServiceImpl 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:
oAuth2Application- the o auth2 application- Returns:
- the o auth2 application that was added
-
addOrUpdateOAuth2Application
public static OAuth2Application addOrUpdateOAuth2Application(String externalReferenceCode, long userId, String userName, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, boolean trustedApplication, Consumer<OAuth2ScopeBuilder> builderConsumer, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addOrUpdateOAuth2Application
public static OAuth2Application addOrUpdateOAuth2Application(String externalReferenceCode, long userId, String userName, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, List<String> scopeAliasesList, boolean trustedApplication, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createOAuth2Application
Creates a new o auth2 application with the primary key. Does not add the o auth2 application to the database.- Parameters:
oAuth2ApplicationId- the primary key for the new o auth2 application- Returns:
- the new o auth2 application
-
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
-
deleteOAuth2Application
public static OAuth2Application deleteOAuth2Application(long oAuth2ApplicationId) throws com.liferay.portal.kernel.exception.PortalException Deletes the o auth2 application with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect OAuth2ApplicationLocalServiceImpl 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:
oAuth2ApplicationId- the primary key of the o auth2 application- Returns:
- the o auth2 application that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a o auth2 application with the primary key could not be found
-
deleteOAuth2Application
public static OAuth2Application deleteOAuth2Application(OAuth2Application oAuth2Application) throws com.liferay.portal.kernel.exception.PortalException Deletes the o auth2 application from the database. Also notifies the appropriate model listeners.Important: Inspect OAuth2ApplicationLocalServiceImpl 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:
oAuth2Application- the o auth2 application- Returns:
- the o auth2 application that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteOAuth2Applications
public static void deleteOAuth2Applications(long companyId) throws com.liferay.portal.kernel.exception.PortalException - 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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.oauth2.provider.model.impl.OAuth2ApplicationModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.oauth2.provider.model.impl.OAuth2ApplicationModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchOAuth2Application
-
fetchOAuth2Application
-
fetchOAuth2ApplicationByExternalReferenceCode
public static OAuth2Application fetchOAuth2ApplicationByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchOAuth2ApplicationByUuidAndCompanyId
public static OAuth2Application fetchOAuth2ApplicationByUuidAndCompanyId(String uuid, long companyId) Returns the o auth2 application with the matching UUID and company.- Parameters:
uuid- the o auth2 application's UUIDcompanyId- the primary key of the company- Returns:
- the matching o auth2 application, or
nullif a matching o auth2 application could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOAuth2Application
public static OAuth2Application getOAuth2Application(long oAuth2ApplicationId) throws com.liferay.portal.kernel.exception.PortalException Returns the o auth2 application with the primary key.- Parameters:
oAuth2ApplicationId- the primary key of the o auth2 application- Returns:
- the o auth2 application
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a o auth2 application with the primary key could not be found
-
getOAuth2Application
public static OAuth2Application getOAuth2Application(long companyId, String clientId) throws NoSuchOAuth2ApplicationException - Throws:
NoSuchOAuth2ApplicationException
-
getOAuth2ApplicationByExternalReferenceCode
public static OAuth2Application getOAuth2ApplicationByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOAuth2ApplicationByUuidAndCompanyId
public static OAuth2Application getOAuth2ApplicationByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the o auth2 application with the matching UUID and company.- Parameters:
uuid- the o auth2 application's UUIDcompanyId- the primary key of the company- Returns:
- the matching o auth2 application
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a matching o auth2 application could not be found
-
getOAuth2Applications
Returns a range of all the o auth2 applications.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.oauth2.provider.model.impl.OAuth2ApplicationModelImpl.- Parameters:
start- the lower bound of the range of o auth2 applicationsend- the upper bound of the range of o auth2 applications (not inclusive)- Returns:
- the range of o auth2 applications
-
getOAuth2Applications
-
getOAuth2Applications
-
getOAuth2ApplicationsCount
public static int getOAuth2ApplicationsCount()Returns the number of o auth2 applications.- Returns:
- the number of o auth2 applications
-
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
-
updateExternalReferenceCode
public static OAuth2Application updateExternalReferenceCode(long oAuth2ApplicationId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateExternalReferenceCode
public static OAuth2Application updateExternalReferenceCode(OAuth2Application oAuth2Application, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateIcon
public static OAuth2Application updateIcon(long oAuth2ApplicationId, InputStream inputStream) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateOAuth2Application
public static OAuth2Application updateOAuth2Application(long oAuth2ApplicationId, long oAuth2ApplicationScopeAliasesId, List<GrantType> allowedGrantTypesList, String clientAuthenticationMethod, long clientCredentialUserId, String clientId, int clientProfile, String clientSecret, String description, List<String> featuresList, String homePageURL, long iconFileEntryId, String jwks, String name, String privacyPolicyURL, List<String> redirectURIsList, boolean rememberDevice, boolean trustedApplication) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateOAuth2Application
Updates the o auth2 application in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect OAuth2ApplicationLocalServiceImpl 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:
oAuth2Application- the o auth2 application- Returns:
- the o auth2 application that was updated
-
updateScopeAliases
public static OAuth2Application updateScopeAliases(long userId, String userName, long oAuth2ApplicationId, List<String> scopeAliasesList) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-