com.servoy.j2db.server.headlessclient
Interface ISessionBean

All Superinterfaces:

EventListener, javax.servlet.http.HttpSessionBindingListener, IHeadlessClient

public interface ISessionBean
extends IHeadlessClient, javax.servlet.http.HttpSessionBindingListener

Interface to interact with a client from within a HTTP session, like a JSP page.

 ISessionBean servoy_hc = (ISessionBean)session.getAttribute("servoy");
 if (servoy_hc == null)
 {
        //args are solution name,username,password 
        servoy_hc = HeadlessClientFactory.createSessionBean(request, "headless_client_demo");
        session.setAttribute("servoy", servoy_hc);
 }
 //servoy_hc is now usable...
 

Sample contextName values:
1) null, main form foundset
2) "forms.<xxxxx>", for tabpanel relationless form foundset

See Also:

HeadlessClientFactory

Method Summary

IDataSet	getValueListItems(String contextName, String valuelistName) Get valuelist items as dataset.
int	setDataProviderValues(String contextName, javax.servlet.http.HttpServletRequest request_data) Set all request parameters as dataprovider values, if the names match.
void	setLocale(Locale l) Override the default used browser locale
boolean	setMainForm(String formName) Sets a form as main form.

Methods inherited from interface com.servoy.j2db.server.headlessclient.IHeadlessClient

getClientID, getDataProviderValue, getPluginAccess, isValid, setDataProviderValue, shutDown

Methods inherited from interface javax.servlet.http.HttpSessionBindingListener

valueBound, valueUnbound

Method Detail

getValueListItems

IDataSet getValueListItems(String contextName,
                           String valuelistName)

Get valuelist items as dataset.

Parameters:

contextName - the context for this request

valuelistName - the name from the valuelist

Returns:

the dataset with valuelist values

setDataProviderValues

int setDataProviderValues(String contextName,
                          javax.servlet.http.HttpServletRequest request_data)

Set all request parameters as dataprovider values, if the names match.

Parameters:

context - This is the form name or null if the method is a global method.

request_data - the page request object

setLocale

void setLocale(Locale l)

Override the default used browser locale

Parameters:

l -

setMainForm

boolean setMainForm(String formName)

Sets a form as main form.

Parameters:

formName - the name of the form to set as main form

Returns:

true if successful