com.liferay.oauth.service

Class OAuthApplicationLocalServiceUtil

java.lang.Object

com.liferay.oauth.service.OAuthApplicationLocalServiceUtil

@ProviderType
public class OAuthApplicationLocalServiceUtil
extends java.lang.Object

Provides the local service utility for OAuthApplication. This utility wraps com.liferay.oauth.service.impl.OAuthApplicationLocalServiceImpl 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:

OAuthApplicationLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
OAuthApplicationLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static OAuthApplication	addOAuthApplication(long userId, java.lang.String name, java.lang.String description, int accessLevel, boolean shareableAccessToken, java.lang.String callbackURI, java.lang.String websiteURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static OAuthApplication	addOAuthApplication(OAuthApplication oAuthApplication) Adds the o auth application to the database.
static OAuthApplication	createOAuthApplication(long oAuthApplicationId) Creates a new o auth application with the primary key.
static void	deleteLogo(long oAuthApplicationId)
static OAuthApplication	deleteOAuthApplication(long oAuthApplicationId) Deletes the o auth application with the primary key from the database.
static OAuthApplication	deleteOAuthApplication(OAuthApplication oAuthApplication) Deletes the o auth application from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <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.
static <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.
static <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.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
static OAuthApplication	fetchOAuthApplication(long oAuthApplicationId)
static OAuthApplication	fetchOAuthApplication(java.lang.String consumerKey)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static OAuthApplication	getOAuthApplication(long oAuthApplicationId) Returns the o auth application with the primary key.
static OAuthApplication	getOAuthApplication(java.lang.String consumerKey)
static java.util.List<OAuthApplication>	getOAuthApplications(int start, int end) Returns a range of all the o auth applications.
static java.util.List<OAuthApplication>	getOAuthApplications(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
static int	getOAuthApplicationsCount() Returns the number of o auth applications.
static int	getOAuthApplicationsCount(long companyId)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static OAuthApplicationLocalService	getService()
static java.util.List<OAuthApplication>	search(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
static int	searchCount(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
static OAuthApplication	updateLogo(long oAuthApplicationId, java.io.InputStream inputStream)
static OAuthApplication	updateOAuthApplication(long oAuthApplicationId, java.lang.String name, java.lang.String description, boolean shareableAccessToken, java.lang.String callbackURI, java.lang.String websiteURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static OAuthApplication	updateOAuthApplication(OAuthApplication oAuthApplication) Updates the o auth application in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthApplicationLocalServiceUtil

public OAuthApplicationLocalServiceUtil()

Method Detail

addOAuthApplication

public static OAuthApplication addOAuthApplication(long userId,
                                                   java.lang.String name,
                                                   java.lang.String description,
                                                   int accessLevel,
                                                   boolean shareableAccessToken,
                                                   java.lang.String callbackURI,
                                                   java.lang.String websiteURL,
                                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addOAuthApplication

public static OAuthApplication addOAuthApplication(OAuthApplication oAuthApplication)

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

Parameters:

oAuthApplication - the o auth application

Returns:

the o auth application that was added

createOAuthApplication

public static OAuthApplication createOAuthApplication(long oAuthApplicationId)

Creates a new o auth application with the primary key. Does not add the o auth application to the database.

Parameters:

oAuthApplicationId - the primary key for the new o auth application

Returns:

the new o auth application

deleteLogo

public static void deleteLogo(long oAuthApplicationId)
                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteOAuthApplication

public static OAuthApplication deleteOAuthApplication(long oAuthApplicationId)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deletes the o auth application with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

oAuthApplicationId - the primary key of the o auth application

Returns:

the o auth application that was removed

Throws:

PortalException - if a o auth application with the primary key could not be found

deleteOAuthApplication

public static OAuthApplication deleteOAuthApplication(OAuthApplication oAuthApplication)
                                               throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

oAuthApplication - the o auth application

Returns:

the o auth application that was removed

Throws:

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:

PortalException

dynamicQuery

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

dynamicQuery

public static <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

public static <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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth.model.impl.OAuthApplicationModelImpl. 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

public static <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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth.model.impl.OAuthApplicationModelImpl. 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

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

fetchOAuthApplication

public static OAuthApplication fetchOAuthApplication(long oAuthApplicationId)

fetchOAuthApplication

public static OAuthApplication fetchOAuthApplication(java.lang.String consumerKey)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getOAuthApplication

public static OAuthApplication getOAuthApplication(long oAuthApplicationId)
                                            throws com.liferay.portal.kernel.exception.PortalException

Returns the o auth application with the primary key.

Parameters:

oAuthApplicationId - the primary key of the o auth application

Returns:

the o auth application

Throws:

PortalException - if a o auth application with the primary key could not be found

getOAuthApplication

public static OAuthApplication getOAuthApplication(java.lang.String consumerKey)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getOAuthApplications

public static java.util.List<OAuthApplication> getOAuthApplications(int start,
                                                                    int end)

Returns a range of all the o auth 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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth.model.impl.OAuthApplicationModelImpl. 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 auth applications

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

Returns:

the range of o auth applications

getOAuthApplications

public static java.util.List<OAuthApplication> getOAuthApplications(long companyId,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)

getOAuthApplicationsCount

public static int getOAuthApplicationsCount()

Returns the number of o auth applications.

Returns:

the number of o auth applications

getOAuthApplicationsCount

public static int getOAuthApplicationsCount(long companyId)

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public static java.util.List<OAuthApplication> search(long companyId,
                                                      java.lang.String keywords,
                                                      java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                      int start,
                                                      int end,
                                                      com.liferay.portal.kernel.util.OrderByComparator orderByComparator)

searchCount

public static int searchCount(long companyId,
                              java.lang.String keywords,
                              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)

updateLogo

public static OAuthApplication updateLogo(long oAuthApplicationId,
                                          java.io.InputStream inputStream)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateOAuthApplication

public static OAuthApplication updateOAuthApplication(long oAuthApplicationId,
                                                      java.lang.String name,
                                                      java.lang.String description,
                                                      boolean shareableAccessToken,
                                                      java.lang.String callbackURI,
                                                      java.lang.String websiteURL,
                                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateOAuthApplication

public static OAuthApplication updateOAuthApplication(OAuthApplication oAuthApplication)

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

Parameters:

oAuthApplication - the o auth application

Returns:

the o auth application that was updated

getService

public static OAuthApplicationLocalService getService()