com.liferay.saml.persistence.service

Interface SamlSpSessionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SamlSpSessionLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SamlSpSessionLocalService
extends BaseLocalService, PersistedModelLocalService

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

SamlSpSessionLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
SamlSpSession	addSamlSpSession(SamlSpSession samlSpSession) Adds the saml sp session to the database.
SamlSpSession	addSamlSpSession(java.lang.String samlSpSessionKey, java.lang.String assertionXml, java.lang.String jSessionId, java.lang.String nameIdFormat, java.lang.String nameIdNameQualifier, java.lang.String nameIdSPNameQualifier, java.lang.String nameIdValue, java.lang.String sessionIndex, ServiceContext serviceContext)
SamlSpSession	createSamlSpSession(long samlSpSessionId) Creates a new saml sp session with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
SamlSpSession	deleteSamlSpSession(long samlSpSessionId) Deletes the saml sp session with the primary key from the database.
SamlSpSession	deleteSamlSpSession(SamlSpSession samlSpSession) Deletes the saml sp session from the database.
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
SamlSpSession	fetchSamlSpSession(long samlSpSessionId)
SamlSpSession	fetchSamlSpSessionByJSessionId(java.lang.String jSessionId)
SamlSpSession	fetchSamlSpSessionBySamlSpSessionKey(java.lang.String samlSpSessionKey)
SamlSpSession	fetchSamlSpSessionBySessionIndex(java.lang.String sessionIndex)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
SamlSpSession	getSamlSpSession(long samlSpSessionId) Returns the saml sp session with the primary key.
SamlSpSession	getSamlSpSessionByJSessionId(java.lang.String jSessionId)
SamlSpSession	getSamlSpSessionBySamlSpSessionKey(java.lang.String samlSpSessionKey)
SamlSpSession	getSamlSpSessionBySessionIndex(java.lang.String sessionIndex)
java.util.List<SamlSpSession>	getSamlSpSessions(int start, int end) Returns a range of all the saml sp sessions.
java.util.List<SamlSpSession>	getSamlSpSessions(java.lang.String nameIdValue)
int	getSamlSpSessionsCount() Returns the number of saml sp sessions.
SamlSpSession	updateSamlSpSession(long samlSpSessionId, java.lang.String jSessionId)
SamlSpSession	updateSamlSpSession(long samlSpSessionId, java.lang.String samlSpSessionKey, java.lang.String assertionXml, java.lang.String jSessionId, java.lang.String nameIdFormat, java.lang.String nameIdNameQualifier, java.lang.String nameIdSPNameQualifier, java.lang.String nameIdValue, java.lang.String sessionIndex, ServiceContext serviceContext)
SamlSpSession	updateSamlSpSession(SamlSpSession samlSpSession) Updates the saml sp session in the database or adds it if it does not yet exist.

Method Detail

addSamlSpSession

@Indexable(type=REINDEX)
SamlSpSession addSamlSpSession(SamlSpSession samlSpSession)

Adds the saml sp session to the database. Also notifies the appropriate model listeners.

Parameters:

samlSpSession - the saml sp session

Returns:

the saml sp session that was added

addSamlSpSession

SamlSpSession addSamlSpSession(java.lang.String samlSpSessionKey,
                               java.lang.String assertionXml,
                               java.lang.String jSessionId,
                               java.lang.String nameIdFormat,
                               java.lang.String nameIdNameQualifier,
                               java.lang.String nameIdSPNameQualifier,
                               java.lang.String nameIdValue,
                               java.lang.String sessionIndex,
                               ServiceContext serviceContext)
                        throws PortalException

Throws:

PortalException

createSamlSpSession

@Transactional(enabled=false)
SamlSpSession createSamlSpSession(long samlSpSessionId)

Creates a new saml sp session with the primary key. Does not add the saml sp session to the database.

Parameters:

samlSpSessionId - the primary key for the new saml sp session

Returns:

the new saml sp session

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteSamlSpSession

@Indexable(type=DELETE)
SamlSpSession deleteSamlSpSession(long samlSpSessionId)
                                                   throws PortalException

Deletes the saml sp session with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

samlSpSessionId - the primary key of the saml sp session

Returns:

the saml sp session that was removed

Throws:

PortalException - if a saml sp session with the primary key could not be found

deleteSamlSpSession

@Indexable(type=DELETE)
SamlSpSession deleteSamlSpSession(SamlSpSession samlSpSession)

Deletes the saml sp session from the database. Also notifies the appropriate model listeners.

Parameters:

samlSpSession - the saml sp session

Returns:

the saml sp session that was removed

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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.saml.persistence.model.impl.SamlSpSessionModelImpl.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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.saml.persistence.model.impl.SamlSpSessionModelImpl.

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

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

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

fetchSamlSpSession

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpSession fetchSamlSpSession(long samlSpSessionId)

fetchSamlSpSessionByJSessionId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpSession fetchSamlSpSessionByJSessionId(java.lang.String jSessionId)

fetchSamlSpSessionBySamlSpSessionKey

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpSession fetchSamlSpSessionBySamlSpSessionKey(java.lang.String samlSpSessionKey)

fetchSamlSpSessionBySessionIndex

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpSession fetchSamlSpSessionBySessionIndex(java.lang.String sessionIndex)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getSamlSpSession

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpSession getSamlSpSession(long samlSpSessionId)
                                                                                           throws PortalException

Returns the saml sp session with the primary key.

Parameters:

samlSpSessionId - the primary key of the saml sp session

Returns:

the saml sp session

Throws:

PortalException - if a saml sp session with the primary key could not be found

getSamlSpSessionByJSessionId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpSession getSamlSpSessionByJSessionId(java.lang.String jSessionId)
                                                                                                       throws PortalException

Throws:

PortalException

getSamlSpSessionBySamlSpSessionKey

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpSession getSamlSpSessionBySamlSpSessionKey(java.lang.String samlSpSessionKey)
                                                                                                             throws PortalException

Throws:

PortalException

getSamlSpSessionBySessionIndex

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpSession getSamlSpSessionBySessionIndex(java.lang.String sessionIndex)
                                                                                                         throws PortalException

Throws:

PortalException

getSamlSpSessions

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

Returns a range of all the saml sp sessions.

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.saml.persistence.model.impl.SamlSpSessionModelImpl.

Parameters:

start - the lower bound of the range of saml sp sessions

end - the upper bound of the range of saml sp sessions (not inclusive)

Returns:

the range of saml sp sessions

getSamlSpSessions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SamlSpSession> getSamlSpSessions(java.lang.String nameIdValue)

getSamlSpSessionsCount

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

Returns the number of saml sp sessions.

Returns:

the number of saml sp sessions

updateSamlSpSession

SamlSpSession updateSamlSpSession(long samlSpSessionId,
                                  java.lang.String jSessionId)
                           throws PortalException

Throws:

PortalException

updateSamlSpSession

SamlSpSession updateSamlSpSession(long samlSpSessionId,
                                  java.lang.String samlSpSessionKey,
                                  java.lang.String assertionXml,
                                  java.lang.String jSessionId,
                                  java.lang.String nameIdFormat,
                                  java.lang.String nameIdNameQualifier,
                                  java.lang.String nameIdSPNameQualifier,
                                  java.lang.String nameIdValue,
                                  java.lang.String sessionIndex,
                                  ServiceContext serviceContext)
                           throws PortalException

Throws:

PortalException

updateSamlSpSession

@Indexable(type=REINDEX)
SamlSpSession updateSamlSpSession(SamlSpSession samlSpSession)

Updates the saml sp session in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

samlSpSession - the saml sp session

Returns:

the saml sp session that was updated