com.sabratec.applinx.framework.sso

Class GXSSOConfig

java.lang.Object

com.sabratec.applinx.framework.sso.GXSSOConfig

All Implemented Interfaces:

Serializable

public class GXSSOConfig
extends Object
implements Serializable

This class manages the configuration of a single signOn process against a given host. It holds a GXISignOnScreenRecognizer which determines whether the screen is a signOn screen, a GXIUserPasswordRetriever which returns a user password from an external resource, and a GXISSOExecuter which performs the SignOn.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GXSSOConfig()

Method Summary

Modifier and Type	Method and Description
boolean	get_Enabled() For .NET framework usage.
GXISignOnScreenRecognizer	getSignOnScreenRecognizer() Determines the type of SignOn screen recognizer to use
GXISSOExecuter	getSsoExecuter() Determines the type of single SignOn executer to use
GXIUserPasswordRetriever	getUserPasswordRetriever() Determines the type of user/password retriever to use
boolean	isEnabled() Determines whether to activate a single sign on to the host
void	set_Enabled(boolean enabled) For .NET framework usage.
void	setEnabled(boolean enabled) Determines whether to activate the single sign option.
void	setSignOnScreenRecognizer(GXISignOnScreenRecognizer signOnScreenRecognizer) Determines the method to use to recognize the sign on screen.
void	setSsoExecuter(GXISSOExecuter ssoExecuter) Determines what happens once the SignOn is recognized Using an action key (enter an action key) Executing a path (enter a path name) Set in the code
void	setUserPasswordRetriever(GXIUserPasswordRetriever userPasswordRetriever) Determines the type of user/password retriever to use Based on information retrieved from an HTTP request Based on information retrieved from an HTTP session Set in the code

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GXSSOConfig

public GXSSOConfig()

Method Detail

isEnabled

public boolean isEnabled()

Determines whether to activate a single sign on to the host

Returns:

whether the single signon mechanism is active

setEnabled

public void setEnabled(boolean enabled)

Determines whether to activate the single sign option.

Parameters:

enabled - if the sign signon mechanism is active

getUserPasswordRetriever

public GXIUserPasswordRetriever getUserPasswordRetriever()

Determines the type of user/password retriever to use

Returns:

the type of user/password retriever to use

setUserPasswordRetriever

public void setUserPasswordRetriever(GXIUserPasswordRetriever userPasswordRetriever)

Determines the type of user/password retriever to use

• Based on information retrieved from an HTTP request
• Based on information retrieved from an HTTP session
• Set in the code

Parameters:

userPasswordRetriever - the type of user/password retriever to use

getSignOnScreenRecognizer

public GXISignOnScreenRecognizer getSignOnScreenRecognizer()

Determines the type of SignOn screen recognizer to use

Returns:

the type of SignOn screen recognizer to use

setSignOnScreenRecognizer

public void setSignOnScreenRecognizer(GXISignOnScreenRecognizer signOnScreenRecognizer)

Determines the method to use to recognize the sign on screen.

• According to the screen name.
• Automatically recognize the user name and password fields.
• Set from the code.

Parameters:

signOnScreenRecognizer - the type of SignOn screen recognizer to use

getSsoExecuter

public GXISSOExecuter getSsoExecuter()

Determines the type of single SignOn executer to use

Returns:

Determines the type of single SignOn screen executer to use

setSsoExecuter

public void setSsoExecuter(GXISSOExecuter ssoExecuter)

Determines what happens once the SignOn is recognized

• Using an action key (enter an action key)
• Executing a path (enter a path name)
• Set in the code

Parameters:

ssoExecuter - the type of single SignOn executer to use

get_Enabled

public boolean get_Enabled()

For .NET framework usage. Expose the method as a property.

set_Enabled

public void set_Enabled(boolean enabled)

For .NET framework usage. Expose the method as a property.