com.sap.security.api.logon

Interface IAuthScheme

public interface IAuthScheme

Interface that represents the authentication scheme object. This interface is used only in portal authentication framework.

See Also:

ILogonFrontend

Method Summary

String	getAuthenticationTemplate()
ILogonFrontend	getLogonFrontend() Gets the logon frontend information that comes with this authscheme
AppConfigurationEntry[]	getModules() Deprecated. Use getAuthenticationTemplate instead to get the name of the authentication template which contains the login modules that are processed for logon.
String	getName() Gets the name of the authscheme.
int	getPriority() Gets the priority of an authscheme.

Method Detail

getName

String getName()

Gets the name of the authscheme.

Returns:

name of the authentication scheme

getPriority

int getPriority()

Gets the priority of an authscheme. Allowed are all numerical values. It is recommended that the default authentication scheme has priority 0.

Returns:

priority of the authentication scheme.

getModules

AppConfigurationEntry[] getModules()

Deprecated. Use getAuthenticationTemplate instead to get the name of the authentication template which contains the login modules that are processed for logon.

Gets the authentication modules in the order of their priority.

Returns:

array of authentication module entries.

getAuthenticationTemplate

String getAuthenticationTemplate()

Returns:

returns the authentication template that corresponds to this authscheme.

getLogonFrontend

ILogonFrontend getLogonFrontend()

Gets the logon frontend information that comes with this authscheme

Returns:

a reference to a ILogonFrontend object

Access Rights

This class can be accessed from:

SC	DC
[sap.com] ENGINEAPI	[sap.com] com.sap.security.api.sda
[sap.com] ENGFACADE	[sap.com] tc/je/usermanagement/api
[sap.com] CORE-TOOLS	[sap.com] com.sap.engine.client.lib