Uses of Class
ch.autumo.beetroot.BeetRootHTTPSession

Packages that use BeetRootHTTPSession

Package	Description
ch.autumo.beetroot	Main classes for the beetRoot framework, web server and servlet (when running in a web-container).
ch.autumo.beetroot.handler	All base handlers for different purposes.
ch.autumo.beetroot.handler.properties	Handler an entity for properties (aka settings) generated by PLANT.
ch.autumo.beetroot.handler.roles	System handlers.
ch.autumo.beetroot.handler.system	User handlers; covers all necessary handlers including password reset, user settings and 2FA.
ch.autumo.beetroot.handler.tasks	Task handlers for demonstration purposes.
ch.autumo.beetroot.handler.users	User handlers; covers all necessary handlers including password reset, user settings and 2FA.
ch.autumo.beetroot.mailing	Mailing component with implementations (default: jakarta, javax).

Uses of BeetRootHTTPSession in ch.autumo.beetroot

Methods in ch.autumo.beetroot that return BeetRootHTTPSession

Modifier and Type	Method	Description
protected BeetRootHTTPSession	AbstractBeetRootServlet.findOrCreateHttpSession(jakarta.servlet.http.HttpServletRequest request)	Lookup an existing or a new session for the request given.

Methods in ch.autumo.beetroot with parameters of type BeetRootHTTPSession

Modifier and Type	Method	Description
Session	SessionManager.findOrCreate(BeetRootHTTPSession session)	Get an existing user session or create a new one if it doesn't exist for the nano cookie.
String	LanguageManager.getLanguageFromHttpSession(BeetRootHTTPSession session)	Get language from the header of the HTTP session and use it if available in beetRoot, otherwise return default language.
Properties	LanguageManager.loadPWValidationMessages(BeetRootHTTPSession session)	Load translations for password checks.
String	LanguageManager.retrieveLanguage(BeetRootHTTPSession session)	Retrieve language when user is not or possibly not logged in.
org.nanohttpd.protocols.http.response.Response	BeetRootWebServer.serve(BeetRootHTTPSession session, jakarta.servlet.http.HttpServletRequest request)	Main serve method for the beetroot-engine in a servlet context
org.nanohttpd.protocols.http.response.Response	BeetRootWebServer.serveAtLast(BeetRootHTTPSession session)	Last call before the routed website is served.
static org.nanohttpd.protocols.http.response.Response	BeetRootWebServer.serverCommandResponse(BeetRootHTTPSession session, ClientAnswer answer)
static org.nanohttpd.protocols.http.response.Response	BeetRootWebServer.serverResponse(BeetRootHTTPSession session, Class<?> handlerClass, Object... initParameter)
String	LanguageManager.translate(String key, BeetRootHTTPSession session, Object... arguments)	Translate method.
String	LanguageManager.translateFullEscape(String key, BeetRootHTTPSession session, Object... arguments)	Translate method for the template engine and for users of this framework.
String	LanguageManager.translateTemplate(String key, BeetRootHTTPSession session, String[] values, boolean escape)	Translate method for the template engine.
String	LanguageManager.translateTemplateFullEscape(String key, BeetRootHTTPSession session, String[] values)	Translate method for the template engine.

Uses of BeetRootHTTPSession in ch.autumo.beetroot.handler

Methods in ch.autumo.beetroot.handler that return BeetRootHTTPSession

Modifier and Type	Method	Description
final BeetRootHTTPSession	BaseHandler.getCurrentSession()	Get current HTTP session process.

Methods in ch.autumo.beetroot.handler with parameters of type BeetRootHTTPSession

Modifier and Type	Method	Description
protected void	BaseHandler.addCheckBox(BeetRootHTTPSession session, String columnName)	Add proper logic for check-boxes.
HandlerResponse	BaseHandler.deleteData(BeetRootHTTPSession session, int id)	Delete data from DB.
HandlerResponse	DefaultDeleteHandler.deleteData(BeetRootHTTPSession session, int id)
String	DefaultAddHandler.extractCustomSingleInputDiv(BeetRootHTTPSession session, String val, ResultSetMetaData rsmd, String columnName, String guiColName, int idx)	Overwrite this method, if you need to add a custom field (HTML 'div'); e.g. when multiple user roles are used; in this case the 'div' is more likely consisting of 2 role assignment boxes instead of a simple input-'div' or use it for any custom 'div'.
String	DefaultEditHandler.extractCustomSingleInputDiv(BeetRootHTTPSession session, String val, ResultSetMetaData rsmd, String columnName, String guiColName, int idx)	Overwrite this method, if you need to add a custom field (HTML 'div'); e.g. when multiple user roles are used; in this case the 'div' is more likely consisting of 2 role assignment boxes instead of a simple input-'div' or use it for any custom 'div'.
String	DefaultIndexHandler.extractCustomSingleTableData(BeetRootHTTPSession session, ResultSet rsmd, String columnName, int idx, Entity entity)	Overwrite this method, if you need to add a custom data; e.g. when multiple user roles are used; in this case it is more likely that you combine more values that just one field value or use it for any custom value.
String	DefaultViewHandler.extractCustomSingleTableData(BeetRootHTTPSession session, ResultSet rsmd, String columnName, int idx, Entity entity)	Overwrite this method, if you need to add a custom data; e.g. when multiple user roles are used; in this case it is more likely that you combine more values that just one field value or use it for any custom value.
protected String	DefaultAddHandler.extractSingleInputDiv(BeetRootHTTPSession session, ResultSetMetaData rsmd, String columnName, String guiColName, int idx)	Extract one single input div with label and input tags from result set standing at current row.
protected String	DefaultAddHandler.extractSingleInputDiv(BeetRootHTTPSession session, Map<String,String> data, ResultSetMetaData rsmd, String columnName, String guiColName, int idx)	Extract one single input div with label and input tags from result set standing at current row.
protected String	DefaultEditHandler.extractSingleInputDiv(BeetRootHTTPSession session, ResultSet set, Entity entity, String columnName, String guiColName, int sqlType, int idx)	Extract one single input div with label and input tags from result set standing at current row.
protected String	DefaultEditHandler.extractSingleInputDiv(BeetRootHTTPSession session, Map<String,String> data, ResultSetMetaData rsmd, String columnName, String guiColName, int idx)	Extract one single input div with label and input tags from result set standing at current row.
String	DefaultIndexHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)	Extract one single table data field from result set standing at current row.
String	DefaultRESTIndexHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, String guiColumnName, int idx, Entity entity)	Extract one single table data field from result set standing at current row.
String	DefaultViewHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)	Extract one single table data field from result set standing at current row.
String	BaseHandler.formatSingleValueForDB(BeetRootHTTPSession session, String val, String columnname)	Format single value before update / insert into DB.
String	DefaultAddHandler.formatSingleValueForDB(BeetRootHTTPSession session, String val, String columnname)
String	DefaultEditHandler.formatSingleValueForDB(BeetRootHTTPSession session, String val, String columnname)
String	DefaultEditHandler.formatSingleValueForGUI(BeetRootHTTPSession session, Object dbObject, String preformattedValue, String columnName, int sqlType, int dbIdx, Entity entity)	Format value for GUI.
String	BaseHandler.getInsertValues(BeetRootHTTPSession session)	Get SQL insert values.
String	BaseHandler.getPaginator(BeetRootHTTPSession session)	Get HTML paginator code.
String	DefaultIndexHandler.getPaginator(BeetRootHTTPSession session)	Get whole index paginator.
String	DefaultRESTIndexHandler.getPaginator(BeetRootHTTPSession session)	Get whole index paginator.
String	BaseHandler.getTableExport(BeetRootHTTPSession session)	Get HTML table export code.
String	BaseHandler.getText(BeetRootHTTPSession session, int origId)	Process handlers to get the whole HTML page.
String	BaseHandler.getUpdateSetClause(BeetRootHTTPSession session)	Get SQL update set clause.
String	BaseHandler.getUpdateSetClause(BeetRootHTTPSession session, String onOffMapName)	Get SQL update set clause.
void	BaseHandler.initialize(BeetRootHTTPSession session)	Every handler MUST be initialized!
protected boolean	BaseHandler.isCurrentUserUpdate(BeetRootHTTPSession session)	Is the current user being updated?
boolean	BaseHandler.isRetryCall(BeetRootHTTPSession session)	Is it a retry call?
protected void	BaseHandler.parseAssociatedEntities(StringBuilder snippet, List<Model> list, BeetRootHTTPSession session)	Parse associated list.
protected void	BaseHandler.parseUnassociatedEntities(StringBuilder snippet, List<Model> list, BeetRootHTTPSession session)	Parse un-associated list.
void	DefaultEditHandler.prepare(BeetRootHTTPSession session, Entity entity)	Prepare call to to something with the entity bean if necessary.
void	DefaultIndexHandler.prepare(BeetRootHTTPSession session, Entity entity)	Prepare call to to something with the current entity bean processed in the list if necessary.
void	DefaultRESTIndexHandler.prepare(BeetRootHTTPSession session, Entity entity)	Prepare call to to something with the current entity bean processed in the list if necessary.
void	DefaultViewHandler.prepare(BeetRootHTTPSession session, Entity entity)	Prepare call to to something with the entity bean if necessary.
HandlerResponse	BaseHandler.readData(BeetRootHTTPSession session, int id)	Read data from DB that must be filled when the template is parsed.
HandlerResponse	DefaultAddHandler.readData(BeetRootHTTPSession session, int id)
HandlerResponse	DefaultEditHandler.readData(BeetRootHTTPSession session, int id)
HandlerResponse	DefaultIndexHandler.readData(BeetRootHTTPSession session, int id)
HandlerResponse	DefaultRESTIndexHandler.readData(BeetRootHTTPSession session, int id)
HandlerResponse	DefaultViewHandler.readData(BeetRootHTTPSession session, int id)
HandlerResponse	ExampleDownloadHandler.readData(BeetRootHTTPSession session, int id)
HandlerResponse	NoContent204Handler.readData(BeetRootHTTPSession session, int id)
protected final void	BaseHandler.refreshUserRoles(int currentUserId, BeetRootHTTPSession session)	Refresh user roles and permissions for current user.
void	BaseHandler.render(BeetRootHTTPSession session)	Overwrite to set your template variables.
void	Error404Handler.render(BeetRootHTTPSession session)
void	ErrorHandler.render(BeetRootHTTPSession session)
void	ExampleUploadHandler.render(BeetRootHTTPSession session)
void	NotImplementedHandler.render(BeetRootHTTPSession session)
void	BaseHandler.renderAll(BeetRootHTTPSession session)	Overwrite to set your variables for the whole HTML page.
HandlerResponse	BaseHandler.saveData(BeetRootHTTPSession session)	Save data to DB.
HandlerResponse	DefaultAddHandler.saveData(BeetRootHTTPSession session)
HandlerResponse	ExampleUploadHandler.saveData(BeetRootHTTPSession session)
HandlerResponse	BaseHandler.uniqueTest(BeetRootHTTPSession session, String preSql, String operation)	Check if unique fields are unique.
HandlerResponse	BaseHandler.updateData(BeetRootHTTPSession session, int id)	Update data in DB.
HandlerResponse	DefaultEditHandler.updateData(BeetRootHTTPSession session, int id)

Uses of BeetRootHTTPSession in ch.autumo.beetroot.handler.properties

Methods in ch.autumo.beetroot.handler.properties with parameters of type BeetRootHTTPSession

Modifier and Type	Method	Description
HandlerResponse	PropertiesDeleteHandler.deleteData(BeetRootHTTPSession session, int id)
String	PropertiesIndexHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)
String	PropertiesViewHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)

Uses of BeetRootHTTPSession in ch.autumo.beetroot.handler.roles

Methods in ch.autumo.beetroot.handler.roles with parameters of type BeetRootHTTPSession

Modifier and Type	Method	Description
String	RolesIndexHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)
String	RolesViewHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)

Uses of BeetRootHTTPSession in ch.autumo.beetroot.handler.system

Methods in ch.autumo.beetroot.handler.system with parameters of type BeetRootHTTPSession

Modifier and Type	Method	Description
void	LogHandler.render(BeetRootHTTPSession session)	Replaces variables template only.
void	LogHandler.renderAll(BeetRootHTTPSession session)	Replaces variables in the whole page.

Uses of BeetRootHTTPSession in ch.autumo.beetroot.handler.tasks

Methods in ch.autumo.beetroot.handler.tasks with parameters of type BeetRootHTTPSession

Modifier and Type	Method	Description
String	TasksIndexHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)
String	TasksViewHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)

Uses of BeetRootHTTPSession in ch.autumo.beetroot.handler.users

Methods in ch.autumo.beetroot.handler.users with parameters of type BeetRootHTTPSession

Modifier and Type	Method	Description
String	ExtUsersAddHandler.extractCustomSingleInputDiv(BeetRootHTTPSession session, String val, ResultSetMetaData rsmd, String columnName, String guiColName, int idx)
String	ExtUsersEditHandler.extractCustomSingleInputDiv(BeetRootHTTPSession session, String val, ResultSetMetaData rsmd, String columnName, String guiColName, int idx)
String	ExtUsersIndexHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)
String	ExtUsersViewHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)
String	UsersIndexHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)
String	UsersViewHandler.extractSingleTableData(BeetRootHTTPSession session, ResultSet set, String columnName, int idx, Entity entity)
protected String	UsersViewHandler.get2FAQRImage(BeetRootHTTPSession session, User user)	Return the while image tag for the 2FA QR code image
static String	PasswordHelper.getHTMLMessages(org.passay.RuleResult result, BeetRootHTTPSession session)	Get HTML messages.
static List<String>	PasswordHelper.getMessages(org.passay.RuleResult result, BeetRootHTTPSession session)	Get messages for result.
static org.passay.RuleResult	PasswordHelper.isValid(String password, BeetRootHTTPSession session)	Password valid?
HandlerResponse	ChangeHandler.readData(BeetRootHTTPSession session, int id)
HandlerResponse	NewQRCodeHandler.readData(BeetRootHTTPSession session, int id)
HandlerResponse	SettingsHandler.readData(BeetRootHTTPSession session, int id)
void	ChangeHandler.render(BeetRootHTTPSession session)
void	ExtUsersAddHandler.render(BeetRootHTTPSession session)
void	ExtUsersEditHandler.render(BeetRootHTTPSession session)
void	UsersViewHandler.render(BeetRootHTTPSession session)
HandlerResponse	ExtUsersAddHandler.saveData(BeetRootHTTPSession session)
HandlerResponse	UsersAddHandler.saveData(BeetRootHTTPSession session)
HandlerResponse	ChangeHandler.updateData(BeetRootHTTPSession session, int id)
HandlerResponse	ExtUsersEditHandler.updateData(BeetRootHTTPSession session, int id)
HandlerResponse	ResetHandler.updateData(BeetRootHTTPSession session, int id)
HandlerResponse	UsersEditHandler.updateData(BeetRootHTTPSession session, int id)

Uses of BeetRootHTTPSession in ch.autumo.beetroot.mailing

Methods in ch.autumo.beetroot.mailing with parameters of type BeetRootHTTPSession

Modifier and Type	Method	Description
protected String	AbstractMailer.loadTemplate(String templateName, BeetRootHTTPSession session, String extension)	Load mail template.
protected String	AbstractMailer.loadTemplateWithVariables(String templateName, BeetRootHTTPSession session, Map<String,String> variables, String format)	Load language translated templates with variables replaced.
abstract void	AbstractMailer.mail(String[] to, String subject, Map<String,String> variables, String templateName, BeetRootHTTPSession session)	See Mailer.mail(String[], String, Map, String, BeetRootHTTPSession).
void	JakartaMailer.mail(String[] to, String subject, Map<String,String> variables, String templateName, BeetRootHTTPSession session)
void	JavaxMailer.mail(String[] to, String subject, Map<String,String> variables, String templateName, BeetRootHTTPSession session)
void	Mailer.mail(String[] to, String subject, Map<String,String> variables, String templateName, BeetRootHTTPSession session)	Mail.
protected String	AbstractMailer.replaceAllLanguageVariables(String template, BeetRootHTTPSession session, String extension)	Replace language variables in loaded mail template.