All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface ibs.ebf.session.ISessionProperties

public interface ISessionProperties

extends Serializable

existsInForm(String)

Checks if given key exists in the form submitted by the user.

existsInSession(String)

Checks if given key exists in the session/custom values container.

getBusinessUnitId()

Returns value of the submitted field Business Unit Id If not found, returns Default business unit id as defined in the application controls.

getFormId()

Returns value of the submitted field Form ID.

getFormKeys()

Returns all keys submitted in a form by the user.

getFormKeysValues()

Returns IKeys object from session properties containing all the key value pairs submitted by the user.

getFormValue(String)

Call this method to access a value for the given key.

getFormValue(String, String)

Call this method to access a value for the given key.

getFormValues(String)

Call this method to access a (multiple) values for the given key.

getIpAddr()

Returns IpAddress of the remote host (Value of REMOTE_HOST in HTTP Header).

getLoginAttempts()

Returns a counter indicating number of times user in current session has made unsuccessful attempts to login.

getLoginId()

Returns value of the submitted field Login Id.

getPassword()

Returns value of the submitted field Password.

getSessionKeys()

Returns all session/custom keys.

getSessionRecord(String)

This method provides access to previously stored IbsRecord objects.

getSessionResultSet(String)

This method provides access to previously stored EbfResultSet objects.

getSessionTable(String)

This method provides access to previously stored IbsTable objects.

getSessionValue(String)

Call this method to access a value for the given session key.

getSessionValue(String, String)

Call this method to access a value for the given session key.

getSessionValues(String)

Call this method to access a (multiple) values for the given key.

isLoginVerified()

Check to see if user login is set as verified.

setLoginAttempt()

If this server instance is configured to use external (custom) Login Verification mechanism, the process simply has to call this method to indicate that there was a failed login attempt in this session.

setLoginId(String)

Allows application developer to set login_id for current user session.

setLoginVerified(boolean)

If this server instance is configured to use external (custom) Login Verification mechanism, the process simply has to call this method to set user login as verified or not verified.

setPassword(String)

Allows application developer to set password for current user session.

setSessionRecord(String, IbsRecord)

This method allows app developer to store IbsRecord objects for later use in template formatting.

setSessionResultSet(String, ResultSet)

This method allows app developer to store ResultSet objects for later use in template formatting.

setSessionTable(String, IbsTable)

This method allows app developer to store IbsTable objects for later use in template formatting.

setSessionValue(String, String)

This method allows app developer to set session/custom key/value in the session properties.

setSessionValue(String, String[])

This method allows app developer to set session/custom key/values in the session properties.

 public abstract IKeys getFormKeysValues()

Returns IKeys object from session properties containing all the key value pairs submitted by the user.

Returns:

IKeys An object of type IKeys containing all the key value pairs submitted by the user.

See Also:

IKeys

 public abstract Enumeration getFormKeys()

Returns all keys submitted in a form by the user.

Returns:

An Enumeration of all form keys.

 public abstract Enumeration getSessionKeys()

Returns all session/custom keys.

Returns:

An Enumeration of all session/custom keys.

 public abstract String getIpAddr()

Returns IpAddress of the remote host (Value of REMOTE_HOST in HTTP Header). If not found, returns 'unknown'.

Returns:

A string containing Ip Address of the remote host.

 public abstract String getFormId()

Returns value of the submitted field Form ID. If not found, returns Default form id as defined in the application controls.

Returns:

A string containing submitted Form Id.

 public abstract String getBusinessUnitId()

Returns value of the submitted field Business Unit Id If not found, returns Default business unit id as defined in the application controls.

Returns:

A string containing submitted Business Unit Id.

 public abstract String getLoginId() throws KeyNotFoundException

Returns value of the submitted field Login Id. If not found, returns empty string.

Returns:

A string containing submitted 'Login Id'.

 public abstract String getPassword() throws KeyNotFoundException

Returns value of the submitted field Password. If not found, returns empty string.

Returns:

A string containing submitted 'Login Id'.

 public abstract int getLoginAttempts()

Returns a counter indicating number of times user in current session has made unsuccessful attempts to login.

Returns:

An integer value for number of login attempts.

 public abstract boolean isLoginVerified()

Check to see if user login is set as verified.

Returns:

boolean value. true if login was verified. false otherwise.

 public abstract void setLoginAttempt()

If this server instance is configured to use external (custom) Login Verification mechanism, the process simply has to call this method to indicate that there was a failed login attempt in this session.

 public abstract void setLoginVerified(boolean true_or_false)

If this server instance is configured to use external (custom) Login Verification mechanism, the process simply has to call this method to set user login as verified or not verified.

Parameters:

true_or_false - A boolean flag - 'true' sets login as verified. 'false' set is as not verified.

 public abstract void setLoginId(String login_id)

Allows application developer to set login_id for current user session. This method should be used only if you wish to bypass build-in access control mechanism for your entire application.

Parameters:

login_id - A String containing login id.

 public abstract void setPassword(String password)

Allows application developer to set password for current user session. This method should be used only if you wish to bypass build-in access control mechanism for your entire application.

Parameters:

password - A String containing user password.

 public abstract boolean existsInForm(String key)

Checks if given key exists in the form submitted by the user. Returns 'true' if key was found, otherwise returns 'false'.

Parameters:

key - A key submitted by the user.

Returns:

A boolean value

 public abstract boolean existsInSession(String key)

Checks if given key exists in the session/custom values container. Returns 'true' if key was found, otherwise returns 'false'.

Parameters:

key - A key in the session/custom values container.

Returns:

A boolean value

 public abstract String getFormValue(String key)

Call this method to access a value for the given key. This method looks at the keys and values submitted in the form. If it finds multiple values for the given key, returns very first value in the list. If it does not find given key, returns an empty string ("").

Parameters:

key - A key submitted by the user.

Returns:

String A value submitted for the given key. If key is not found, returns "".

 public abstract String getFormValue(String key,
                                     String default_value)

Call this method to access a value for the given key. This method looks at the keys and values submitted in the form. If it finds multiple values for the given key, returns very first value in the list. If it does not find given key, returns 'default_value'.

Parameters:

key - A key submitted by the user.

default_value - A value to be returned if key was not found.

Returns:

String A value submitted for the given key or 'default_value' if key was not found.

 public abstract String[] getFormValues(String key)

Call this method to access a (multiple) values for the given key. This method looks at the keys and values submitted in the form. This method call is valid even if given key has only one value. Call to this method always returns a String array (String[]). If it does not find given key, returns an empty String array.

Parameters:

key - A key submitted by the user.

Returns:

String[] An array containg one or more values submitted for the given key or an empty array of string if key was not found.

 public abstract String[] getSessionValues(String key)

Call this method to access a (multiple) values for the given key. This method looks at the keys and values in the custom values container. This method call is valid even if given key has only one value. Call to this method always returns a String array (String[]). If it does not find given key, returns an empty String array.

Parameters:

key - A key in the custom values container.

Returns:

String[] An array containg one or more values assigned to the given key or an empty array of string if key was not found.

 public abstract String getSessionValue(String key)

Call this method to access a value for the given session key. This method looks at the keys and values in the custom values container. If it finds multiple values for the given key, returns very first value in the list. If it does not find given key, returns an empty string.

Parameters:

key - A key in the custom values container.

Returns:

String A value assigned to the given key. If key is not found, returns empty string.

 public abstract String getSessionValue(String key,
                                        String default_value)

Call this method to access a value for the given session key. This method looks at the keys and values in the custom values container. If it finds multiple values for the given key, returns very first value in the list. If it does not find given key, returns 'default_value'.

Parameters:

key - A key in the custom values container.

default_value - A value to be returned if key was not found.

Returns:

String A value assigned to the given key or 'default_value' if key was not found.

 public abstract void setSessionValue(String key,
                                      String value)

This method allows app developer to set session/custom key/value in the session properties.

Parameters:

key - A key for the custom values

value - A String containing value for the given key.

 public abstract void setSessionValue(String key,
                                      String values[])

This method allows app developer to set session/custom key/values in the session properties.

Parameters:

key - A key for the custom values

values - An array of String containing values for the given key. May contain one or more values.

 public abstract void setSessionResultSet(String result_set_name,
                                          ResultSet rs)

This method allows app developer to store ResultSet objects for later use in template formatting.

Parameters:

result_set_name - A name given to this result set. Later, this name will be used to access the result set.

rs - An object of type ResultSet

 public abstract void setSessionTable(String table_name,
                                      IbsTable table)

This method allows app developer to store IbsTable objects for later use in template formatting.

Parameters:

table_name - A name given to this IbsTable. Later, this name will be used to access the table data.

table - An object of type IbsTable

 public abstract void setSessionRecord(String record_name,
                                       IbsRecord record)

This method allows app developer to store IbsRecord objects for later use in template formatting.

Parameters:

record_name - A name given to this IbsRecord. Later, this name will be used to access the record data.

record - An object of type IbsRecord

 public abstract ResultSet getSessionResultSet(String result_set_name)

This method provides access to previously stored EbfResultSet objects. It returns null if given name not found in storage area.

Parameters:

result_set_name - Name of the previously stored ResultSet object.

Returns:

ResultSet An object of type ResultSet

 public abstract IbsTable getSessionTable(String table_name)

This method provides access to previously stored IbsTable objects. It returns null if given name not found in storage area.

Parameters:

table_name - Name of the previously stored IbsTable object.

Returns:

IbsTable An object of type IbsTable

 public abstract IbsRecord getSessionRecord(String record_name)

This method provides access to previously stored IbsRecord objects. It returns null if given name not found in storage area.

Parameters:

record_name - Name of the previously stored IbsRecord object.

Returns:

IbsRecord An object of type IbsRecord

All Packages  Class Hierarchy  This Package  Previous  Next  Index