public interface IAuthentication extends IConfigurable
ILogonAuthentication
Modifier and Type | Method and Description |
---|---|
IUser |
forceLoggedInUser(HttpServletRequest req,
HttpServletResponse resp)
Checks whether the user is currently logged in and returns an
implementation of IUser
If the user is not yet logged in, a respective logon page is written as
ServletResponse.
|
void |
forceLogoffUser(HttpServletRequest req,
HttpServletResponse resp,
String url)
Logoff user by invalidate the user session and deleting the
authentication cookies.
|
IUser |
getLoggedInUser()
Checks whether the user is currently logged in and returns an
implementation of IUser.
|
IUser |
getLoggedInUser(HttpServletRequest req,
HttpServletResponse resp)
Returns the authenticated user.
|
void |
logout(HttpServletRequest req,
HttpServletResponse resp)
Logouts current user.
|
initialize
IUser forceLoggedInUser(HttpServletRequest req, HttpServletResponse resp)
If the user is not yet logged in, a respective logon page is written as
ServletResponse. In that case (i.e. null
is returned) the
calling servlet can simply end their doGet or doPost method with return.
Example:
IUser uid = forceLoggedInUser(req, res); if (uid == null) return;
req
- HttpServletRequestresp
- HttpServletResponsenull
otherwise.IUser getLoggedInUser()
IUser getLoggedInUser(HttpServletRequest req, HttpServletResponse resp)
req
- as HttpServletRequestresp
- as HttpServletResponsevoid logout(HttpServletRequest req, HttpServletResponse resp)
Some cookies will be deleted in the HttpServletResponse.
req
- HttpServletRequestresp
- HttpServletResponsevoid forceLogoffUser(HttpServletRequest req, HttpServletResponse resp, String url)
The user will also be sent to a logoff page which acknowledges that a logoff has taken place with a link for the user to logon again.
Example:
forceLogoffUser(req, res, returnURL);
req
- HttpServletRequestresp
- HttpServletResponseurl
- url to use to logon again.Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] CORE-TOOLS
|
[sap.com]
|
default
|
BC-JAS
|
[sap.com] ENGFACADE
|
[sap.com] tc/je/usermanagement/api
|
api
|
BC-JAS-SEC
|
[sap.com] ENGINEAPI
|
[sap.com]
|
-
|
BC-JAS-SEC-UME
|
[sap.com] ENGINEAPI
|
[sap.com]
|
default
|
BC-JAS-SEC-UME
|
Copyright 2018 SAP AG Complete Copyright Notice