com.liferay.oauth2.provider.service

Interface OAuth2ApplicationLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

OAuth2ApplicationLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface OAuth2ApplicationLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for OAuth2Application. 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:

OAuth2ApplicationLocalServiceUtil, com.liferay.oauth2.provider.service.base.OAuth2ApplicationLocalServiceBaseImpl, com.liferay.oauth2.provider.service.impl.OAuth2ApplicationLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
OAuth2Application	addOAuth2Application(long companyId, long userId, java.lang.String userName, java.util.List<GrantType> allowedGrantTypesList, java.lang.String clientId, int clientProfile, java.lang.String clientSecret, java.lang.String description, java.util.List<java.lang.String> featuresList, java.lang.String homePageURL, long iconFileEntryId, java.lang.String name, java.lang.String privacyPolicyURL, java.util.List<java.lang.String> redirectURIsList, java.util.List<java.lang.String> scopeAliasesList, com.liferay.portal.kernel.service.ServiceContext serviceContext)
OAuth2Application	addOAuth2Application(OAuth2Application oAuth2Application) Adds the o auth2 application to the database.
OAuth2Application	createOAuth2Application(long oAuth2ApplicationId) Creates a new o auth2 application with the primary key.
OAuth2Application	deleteOAuth2Application(long oAuth2ApplicationId) Deletes the o auth2 application with the primary key from the database.
OAuth2Application	deleteOAuth2Application(OAuth2Application oAuth2Application) Deletes the o auth2 application from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.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.
<T> java.util.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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
OAuth2Application	fetchOAuth2Application(long oAuth2ApplicationId)
OAuth2Application	fetchOAuth2Application(long companyId, java.lang.String clientId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
OAuth2Application	getOAuth2Application(long oAuth2ApplicationId) Returns the o auth2 application with the primary key.
OAuth2Application	getOAuth2Application(long companyId, java.lang.String clientId)
java.util.List<OAuth2Application>	getOAuth2Applications(int start, int end) Returns a range of all the o auth2 applications.
int	getOAuth2ApplicationsCount() Returns the number of o auth2 applications.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
OAuth2Application	updateIcon(long oAuth2ApplicationId, java.io.InputStream inputStream)
OAuth2Application	updateOAuth2Application(long oAuth2ApplicationId, java.util.List<GrantType> allowedGrantTypesList, java.lang.String clientId, int clientProfile, java.lang.String clientSecret, java.lang.String description, java.util.List<java.lang.String> featuresList, java.lang.String homePageURL, long iconFileEntryId, java.lang.String name, java.lang.String privacyPolicyURL, java.util.List<java.lang.String> redirectURIsList, long auth2ApplicationScopeAliasesId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
OAuth2Application	updateOAuth2Application(OAuth2Application oAuth2Application) Updates the o auth2 application in the database or adds it if it does not yet exist.
OAuth2Application	updateScopeAliases(long userId, java.lang.String userName, long oAuth2ApplicationId, java.util.List<java.lang.String> scopeAliasesList)

Method Detail

addOAuth2Application

OAuth2Application addOAuth2Application(long companyId,
                                       long userId,
                                       java.lang.String userName,
                                       java.util.List<GrantType> allowedGrantTypesList,
                                       java.lang.String clientId,
                                       int clientProfile,
                                       java.lang.String clientSecret,
                                       java.lang.String description,
                                       java.util.List<java.lang.String> featuresList,
                                       java.lang.String homePageURL,
                                       long iconFileEntryId,
                                       java.lang.String name,
                                       java.lang.String privacyPolicyURL,
                                       java.util.List<java.lang.String> redirectURIsList,
                                       java.util.List<java.lang.String> scopeAliasesList,
                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addOAuth2Application

@Indexable(type=REINDEX)
OAuth2Application addOAuth2Application(OAuth2Application oAuth2Application)

Adds the o auth2 application to the database. Also notifies the appropriate model listeners.

Parameters:

oAuth2Application - the o auth2 application

Returns:

the o auth2 application that was added

createOAuth2Application

@Transactional(enabled=false)
OAuth2Application createOAuth2Application(long oAuth2ApplicationId)

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

deleteOAuth2Application

@Indexable(type=DELETE)
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.

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

@Indexable(type=DELETE)
OAuth2Application deleteOAuth2Application(OAuth2Application oAuth2Application)

Deletes the o auth2 application from the database. Also notifies the appropriate model listeners.

Parameters:

oAuth2Application - the o auth2 application

Returns:

the o auth2 application that was removed

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

<T> java.util.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

<T> java.util.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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth2.provider.model.impl.OAuth2ApplicationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

<T> java.util.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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth2.provider.model.impl.OAuth2ApplicationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

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

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

fetchOAuth2Application

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuth2Application fetchOAuth2Application(long oAuth2ApplicationId)

fetchOAuth2Application

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuth2Application fetchOAuth2Application(long companyId,
                                                                                                            java.lang.String clientId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOAuth2Application

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuth2Application getOAuth2Application(long companyId,
                                                                                                          java.lang.String clientId)
                                                                                                   throws NoSuchOAuth2ApplicationException

Throws:

NoSuchOAuth2ApplicationException

getOAuth2Applications

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<OAuth2Application> getOAuth2Applications(int start,
                                                                                                                           int end)

Returns a range of all the o auth2 applications.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth2.provider.model.impl.OAuth2ApplicationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of o auth2 applications

end - the upper bound of the range of o auth2 applications (not inclusive)

Returns:

the range of o auth2 applications

getOAuth2ApplicationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOAuth2ApplicationsCount()

Returns the number of o auth2 applications.

Returns:

the number of o auth2 applications

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

updateIcon

OAuth2Application updateIcon(long oAuth2ApplicationId,
                             java.io.InputStream inputStream)
                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateOAuth2Application

OAuth2Application updateOAuth2Application(long oAuth2ApplicationId,
                                          java.util.List<GrantType> allowedGrantTypesList,
                                          java.lang.String clientId,
                                          int clientProfile,
                                          java.lang.String clientSecret,
                                          java.lang.String description,
                                          java.util.List<java.lang.String> featuresList,
                                          java.lang.String homePageURL,
                                          long iconFileEntryId,
                                          java.lang.String name,
                                          java.lang.String privacyPolicyURL,
                                          java.util.List<java.lang.String> redirectURIsList,
                                          long auth2ApplicationScopeAliasesId,
                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateOAuth2Application

@Indexable(type=REINDEX)
OAuth2Application updateOAuth2Application(OAuth2Application oAuth2Application)

Updates the o auth2 application in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

oAuth2Application - the o auth2 application

Returns:

the o auth2 application that was updated

updateScopeAliases

OAuth2Application updateScopeAliases(long userId,
                                     java.lang.String userName,
                                     long oAuth2ApplicationId,
                                     java.util.List<java.lang.String> scopeAliasesList)
                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException