|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="5.5", sinceVersion="4.0") public interface IAuthenticationManager
This interface offers methods for authentication operations.
Method Summary | |
---|---|
void |
clearInactiveSessions(SessionConfig sessionConfig,
int minutes,
ITransaction transaction)
Deletes the sessions inactive for the specified amount of minutes. |
void |
endImpersonation(SessionConfig sessionConfig)
Ends an impersonation in the current thread, that has been started by impersonate(String) . |
Collection<SessionConfig> |
getSessionsByUserId(SessionConfig sessionConfig,
String userId,
ITransaction transaction)
Returns a collection of active session objects for the given user. |
String |
getUserIdBySessionId(SessionConfig sessionConfig,
ITransaction transaction)
Deprecated. Since 4.0.8, this method was replaced by SessionConfig.getUserId() . |
SessionConfig |
impersonate(String userId)
The authenticated user in the current thread impersonates another user. |
void |
keepSessionAlive(SessionConfig sessionConfig)
Keeps the specified session alive by updating the last time the session was used. |
SessionConfig |
login(String login,
String password,
ITransaction transaction)
Logins a user using the specified password as his credentials, and returns the new SessionConfig for the logged in user. |
SessionConfig |
login(String securityAlias,
String login,
String password,
ITransaction transaction)
Logins a user using the specified JAAS security alias, password as his credentials, and returns the new SessionConfig for the logged in user. |
String |
loginFramworkClockUser(ITransaction transaction)
Deprecated. Since 4.0.8, instead of calling this method generate a impersonated SessionConfig by calling impersonate(String)
using UserConfig.USER_FRAMEWORKCLOCK_ID as parameter. |
SessionConfig |
loginUser(String userId,
ITransaction transaction)
Logins a user without performing any authentication. |
String |
loginUser(String login,
String password,
ITransaction transaction)
Deprecated. Since 4.0.8, this method has been replaced by login(String, String, ITransaction) . |
String |
loginUserGuest()
Deprecated. Since 4.0.8, instead of calling this method generate a impersonated SessionConfig by calling impersonate(String)
using UserConfig.USER_GUEST_ID as parameter. |
void |
logoutUser(SessionConfig sessionConfig,
ITransaction transaction)
Close the user's session given the userSession and the transaction. |
boolean |
validateSessionId(SessionConfig sessionConfig,
ITransaction transaction)
Validate the session of the User given the userSession and transaction. |
Method Detail |
---|
boolean validateSessionId(SessionConfig sessionConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- transaction
-
ManagerException
PortalException
String getUserIdBySessionId(SessionConfig sessionConfig, ITransaction transaction) throws ManagerException, PortalException
SessionConfig.getUserId()
.
sessionConfig
- transaction
-
ManagerException
PortalException
@Deprecated String loginUser(String login, String password, ITransaction transaction) throws ManagerException, PortalException
login(String, String, ITransaction)
.
login
- password
- transaction
-
ManagerException
PortalException
SessionConfig login(String login, String password, ITransaction transaction) throws PortalException
login
- the user's login.password
- the user's password.transaction
- the transaction for persistence access.
PortalException
loginUser(String, ITransaction)
SessionConfig login(String securityAlias, String login, String password, ITransaction transaction) throws PortalException
securityAlias
- the JAAS security alias to use. If null, the default security alias
specified in the lumisportalconfig.xml file is used.login
- the user's login.password
- the user's password.transaction
- the transaction for persistence access.
PortalException
loginUser(String, ITransaction)
SessionConfig loginUser(String userId, ITransaction transaction) throws PortalException
userId
- the userId.transaction
- the transaction for persistence access.
PortalException
@Deprecated String loginUserGuest() throws ManagerException, PortalException
impersonate(String)
using UserConfig.USER_GUEST_ID
as parameter.
ManagerException
PortalException
void logoutUser(SessionConfig sessionConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- transaction
-
ManagerException
PortalException
void clearInactiveSessions(SessionConfig sessionConfig, int minutes, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- minutes
- transaction
-
ManagerException
PortalException
@Deprecated String loginFramworkClockUser(ITransaction transaction) throws ManagerException, PortalException
impersonate(String)
using UserConfig.USER_FRAMEWORKCLOCK_ID
as parameter.
transaction
-
ManagerException
PortalException
void keepSessionAlive(SessionConfig sessionConfig) throws ManagerException, PortalException
sessionConfig
-
ManagerException
PortalException
SessionConfig impersonate(String userId) throws PortalException
endImpersonation(SessionConfig)
to end an impersonation
initiated by this method.
userId
- the user id.
PortalException
void endImpersonation(SessionConfig sessionConfig) throws PortalException
impersonate(String)
.
sessionConfig
- the impersonated session config.
IllegalArgumentException
- if sessionConfig is not the current
impersonated SessionConfig instance.
PortalException
Collection<SessionConfig> getSessionsByUserId(SessionConfig sessionConfig, String userId, ITransaction transaction) throws PortalException
sessionConfig
- userId
- transaction
-
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |