public interface ILogonAuthentication extends IAuthentication
IAuthentication
that provides more powerful
authentication services. This interface is used only in portal authentication framework.Modifier and Type | Method and Description |
---|---|
IAuthScheme |
getAuthScheme(String authschemeName)
Returns auth scheme by its name if available
|
IAuthScheme[] |
getAuthSchemes()
Returns the names of the available auth schemes.
|
ILogonFrontend |
getLogonFrontend(String authSchemeName)
Returns the LogonFrontend for the auth scheme.
|
boolean |
isAuthenticated(IUser user)
Deprecated.
|
boolean |
isAuthSchemeSufficient(IUser user,
String authscheme)
Checks if the current logged in user has satisfied the auth scheme with name
authscheme . |
Subject |
logon(HttpServletRequest req,
HttpServletResponse resp,
String authscheme)
Function that is intended for programmatic logon.
|
forceLoggedInUser, forceLogoffUser, getLoggedInUser, getLoggedInUser, logout
initialize
Subject logon(HttpServletRequest req, HttpServletResponse resp, String authscheme) throws LoginException
IAuthentication.forceLoggedInUser(HttpServletRequest,HttpServletResponse )
.
The function follows
the specific syntax: The parameter authscheme
determines which
logon variant will be used, e.g. which authentication mechanism will be used.
The standard mechanism does the following: Looks up for the parameter
j_user
and j_password
(see the constants ILoginConstants.LOGON_UID_ALIAS
and ILoginConstants.LOGON_PWD_ALIAS
) in the servlet request and uses them for logon
against the user repository that's configured. On successful return (i.e. if
no exception is being thrown) a Subject
is returned. In order to get an
IUser
object from this subject, call
Subject.getPrincipals()
and
iterate through the returned Set of principals.For error situations please see the below list of possible exception
req
- HttpServletRequestresp
- HttpServletResponseauthscheme
- The name of the auth scheme to perform logon.null
otherwise.LoginException
- if the logon fails. The message of the exception is the
key for the error message.boolean isAuthSchemeSufficient(IUser user, String authscheme)
authscheme
.user
- object returned by IAuthentication.getLoggedInUser()
.authscheme
- auth scheme to be satisfiedtrue
if yes, false
if not.ILogonFrontend getLogonFrontend(String authSchemeName)
authSchemeName
- name of the auth schemenull
IAuthScheme[] getAuthSchemes()
IAuthScheme getAuthScheme(String authschemeName)
authschemeName
- name of the auth schemeboolean isAuthenticated(IUser user)
IUser
object is result of an authentication process.user
- user to check.true
if authenticated, otherwise false.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