com.liferay.oauth.service

Class OAuthUserLocalServiceUtil

java.lang.Object

com.liferay.oauth.service.OAuthUserLocalServiceUtil

public class OAuthUserLocalServiceUtil
extends java.lang.Object

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

OAuthUserLocalService

Constructor Summary

Constructors

Constructor and Description
OAuthUserLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static OAuthUser	addOAuthUser(long userId, long oAuthApplicationId, java.lang.String accessToken, java.lang.String accessSecret, ServiceContext serviceContext)
static OAuthUser	addOAuthUser(OAuthUser oAuthUser) Adds the o auth user to the database.
static OAuthUser	createOAuthUser(long oAuthUserId) Creates a new o auth user with the primary key.
static OAuthUser	deleteOAuthUser(long oAuthUserId) Deletes the o auth user with the primary key from the database.
static OAuthUser	deleteOAuthUser(long userId, long oAuthApplicationId)
static OAuthUser	deleteOAuthUser(OAuthUser oAuthUser) Deletes the o auth user from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(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(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static OAuthUser	fetchOAuthUser(long oAuthUserId)
static OAuthUser	fetchOAuthUser(long userId, long oAuthApplicationId)
static OAuthUser	fetchOAuthUser(java.lang.String accessToken)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.util.List<OAuthUser>	getOAuthApplicationOAuthUsers(long oAuthApplicationId, int start, int end, OrderByComparator orderByComparator)
static int	getOAuthApplicationOAuthUsersCount(long oAuthApplicationId)
static OAuthUser	getOAuthUser(long oAuthUserId) Returns the o auth user with the primary key.
static OAuthUser	getOAuthUser(long userId, long oAuthApplicationId)
static OAuthUser	getOAuthUser(java.lang.String accessToken)
static java.util.List<OAuthUser>	getOAuthUsers(int start, int end) Returns a range of all the o auth users.
static int	getOAuthUsersCount() Returns the number of o auth users.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static OAuthUserLocalService	getService()
static java.util.List<OAuthUser>	getUserOAuthUsers(long userId, int start, int end, OrderByComparator orderByComparator)
static int	getUserOAuthUsersCount(long userId)
static OAuthUser	updateOAuthUser(long userId, long oAuthApplicationId, java.lang.String accessToken, java.lang.String accessSecret, ServiceContext serviceContext)
static OAuthUser	updateOAuthUser(OAuthUser oAuthUser) Updates the o auth user 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

OAuthUserLocalServiceUtil

public OAuthUserLocalServiceUtil()

Method Detail

addOAuthUser

public static OAuthUser addOAuthUser(long userId,
                                     long oAuthApplicationId,
                                     java.lang.String accessToken,
                                     java.lang.String accessSecret,
                                     ServiceContext serviceContext)
                              throws PortalException

Throws:

PortalException

addOAuthUser

public static OAuthUser addOAuthUser(OAuthUser oAuthUser)

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

Parameters:

oAuthUser - the o auth user

Returns:

the o auth user that was added

createOAuthUser

public static OAuthUser createOAuthUser(long oAuthUserId)

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

Parameters:

oAuthUserId - the primary key for the new o auth user

Returns:

the new o auth user

deleteOAuthUser

public static OAuthUser deleteOAuthUser(long oAuthUserId)
                                 throws PortalException

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

Parameters:

oAuthUserId - the primary key of the o auth user

Returns:

the o auth user that was removed

Throws:

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

deleteOAuthUser

public static OAuthUser deleteOAuthUser(long userId,
                                        long oAuthApplicationId)
                                 throws PortalException

Throws:

PortalException

deleteOAuthUser

public static OAuthUser deleteOAuthUser(OAuthUser oAuthUser)
                                 throws PortalException

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

Parameters:

oAuthUser - the o auth user

Returns:

the o auth user that was removed

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> 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> java.util.List<T> dynamicQuery(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.model.impl.OAuthUserModelImpl.

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(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 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.model.impl.OAuthUserModelImpl.

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(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(DynamicQuery dynamicQuery,
                                     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

fetchOAuthUser

public static OAuthUser fetchOAuthUser(long oAuthUserId)

fetchOAuthUser

public static OAuthUser fetchOAuthUser(long userId,
                                       long oAuthApplicationId)

fetchOAuthUser

public static OAuthUser fetchOAuthUser(java.lang.String accessToken)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOAuthApplicationOAuthUsers

public static java.util.List<OAuthUser> getOAuthApplicationOAuthUsers(long oAuthApplicationId,
                                                                      int start,
                                                                      int end,
                                                                      OrderByComparator orderByComparator)

getOAuthApplicationOAuthUsersCount

public static int getOAuthApplicationOAuthUsersCount(long oAuthApplicationId)

getOAuthUser

public static OAuthUser getOAuthUser(long oAuthUserId)
                              throws PortalException

Returns the o auth user with the primary key.

Parameters:

oAuthUserId - the primary key of the o auth user

Returns:

the o auth user

Throws:

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

getOAuthUser

public static OAuthUser getOAuthUser(long userId,
                                     long oAuthApplicationId)
                              throws PortalException

Throws:

PortalException

getOAuthUser

public static OAuthUser getOAuthUser(java.lang.String accessToken)
                              throws PortalException

Throws:

PortalException

getOAuthUsers

public static java.util.List<OAuthUser> getOAuthUsers(int start,
                                                      int end)

Returns a range of all the o auth users.

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.model.impl.OAuthUserModelImpl.

Parameters:

start - the lower bound of the range of o auth users

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

Returns:

the range of o auth users

getOAuthUsersCount

public static int getOAuthUsersCount()

Returns the number of o auth users.

Returns:

the number of o auth users

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getUserOAuthUsers

public static java.util.List<OAuthUser> getUserOAuthUsers(long userId,
                                                          int start,
                                                          int end,
                                                          OrderByComparator orderByComparator)

getUserOAuthUsersCount

public static int getUserOAuthUsersCount(long userId)

updateOAuthUser

public static OAuthUser updateOAuthUser(long userId,
                                        long oAuthApplicationId,
                                        java.lang.String accessToken,
                                        java.lang.String accessSecret,
                                        ServiceContext serviceContext)
                                 throws PortalException

Throws:

PortalException

updateOAuthUser

public static OAuthUser updateOAuthUser(OAuthUser oAuthUser)

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

Parameters:

oAuthUser - the o auth user

Returns:

the o auth user that was updated

getService

public static OAuthUserLocalService getService()