Class ExampleDownloadHandler

java.lang.Object

ch.autumo.beetroot.server.HTTPServer.DefaultStreamHandler

ch.autumo.beetroot.server.HTTPServer.DefaultHandler

ch.autumo.beetroot.handler.BaseHandler

ch.autumo.beetroot.handler.ExampleDownloadHandler

All Implemented Interfaces:

Handler, HTTPServer.UriResponder

public class ExampleDownloadHandler
extends BaseHandler

Default file download handler for 'web/html/files/view.html' templates.

Nested Class Summary

Nested classes/interfaces inherited from class BaseHandler

BaseHandler.IfSectionHandler

Modifier and Type	Class	Description
protected final class	BaseHandler.IfSectionHandler	State handler for role, entity and action "IFs" for the overall, the template and the template sub-resource layer.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	LOG	Logger for this class.

Fields inherited from class BaseHandler

action, columns, emptyBean, entity, htmlData, htmlHead, initialValues, insertServletNameInTemplateRefs, MSG_TYPE_ERR, MSG_TYPE_INFO, MSG_TYPE_WARN, PRECISION_INPUT_TYPES, serverName, servletName, TAG_PREFIX_LANG, transientFields, uniqueFields

Modifier and Type	Field	Description
protected String	action	Current action to process.
protected TreeMap<Integer,String>	columns	Column data map holding the columns.cfg-data of the current processing entity.
protected Entity	emptyBean	Empty bean, used for creating an new entity instance.
protected String	entity	Current entity to process.
protected String	htmlData	HTML table data content.
protected String	htmlHead	HTML head content.
protected Map<String,String>	initialValues	Column data map holding the columns.cfg-data for initial fields used by the add-template.
protected boolean	insertServletNameInTemplateRefs	Insert servlet name inzo template references (links)? Necessary when oparting beetRoot within a servlet container.
static final int	MSG_TYPE_ERR	Message type error.
static final int	MSG_TYPE_INFO	Message type info.
static final int	MSG_TYPE_WARN	Message type warning.
protected static final List<String>	PRECISION_INPUT_TYPES	Precision HTML input types.
protected String	serverName	Server name.
protected String	servletName	Servlet name.
static final String	TAG_PREFIX_LANG	Langiage tag prefix.
protected List<String>	transientFields	Column data list holding the columns.cfg-data for transient fields.
protected String[]	uniqueFields	Column data array holding the columns.cfg-data for unique fields.

Constructor Summary

Constructors

Constructor	Description
ExampleDownloadHandler(String entity)	Creates the handler for the given entity.
ExampleDownloadHandler(String entity, String msg)	Creates the handler for the given entity.

Method Summary

Modifier and Type	Method	Description
String	getResource()	Get web resource file as it lies on the file system relatively to the started server process.
HandlerResponse	readData(BeetRootHTTPSession session, int id)	Read data from DB that must be filled when the template is parsed.

Methods inherited from class BaseHandler

addCheckBox, addErrorMessage, addHtmlDataLine, addHtmlHeadLine, addSuccessMessage, addWarningMessage, columns, columnsSize, deleteData, formatSingleValueForDB, get, getBeanClass, getColumn, getColumnsForSql, getColumnsForSql, getCurrentEntityDbId, getCurrentSession, getCustomizedExceptionInformation, getData, getEmptyBean, getEntity, getHandlerClass, getHtmlData, getHtmlHead, getInsertValues, getLayout, getMessageType, getMimeType, getNewScanner, getNewScanner, getPaginator, getRedirectHandler, getSimpleManagementUserRoles, getStatus, getTableExport, getTemplateEngineErrorMessage, getTemplateEngineErrorTitle, getText, getText, getTitle, getTransientFields, getUpdateSetClause, getUpdateSetClause, hasAccess, hasExternalLinks, hasNoColumnsConfig, initialize, initialValue, initValuesSize, isCurrentUserUpdate, isCustomResponse, isNoContentResponse, isNoContentResponseButRoute, isPrecisionInputType, isRetryCall, loginMarker, parseAssociatedEntities, parseUnassociatedEntities, patchInputValue, readSnippetResource, redirectedMarker, refreshUserRoles, registerDisplayField, registerRoutes, render, renderAll, saveData, setCurrentEntityDbId, setMessageType, setVar, setVarAll, showLangMenu, showMenu, uniqueFields, uniqueTest, updateData

Modifier and Type	Method	Description
protected void	addCheckBox(BeetRootHTTPSession session, String columnName)	Add proper logic for check-boxes.
void	addErrorMessage(String message)	Add an error message to show.
void	addHtmlDataLine(String line)	Get HTML data.
void	addHtmlHeadLine(String line)	Get HTML head if there's any.
void	addSuccessMessage(String message)	Add a success message to show.
void	addWarningMessage(String message)	Add a warning message to show.
SortedMap<Integer,String>	columns()	Get columns map.
int	columnsSize()	Amount of columns,
HandlerResponse	deleteData(BeetRootHTTPSession session, int id)	Delete data from DB.
String	formatSingleValueForDB(BeetRootHTTPSession session, String val, String columnname)	Format single value before update / insert into DB.
final org.nanohttpd.protocols.http.response.Response	get(HTTPServer.UriResource uriResource, Map<String,String> urlParams, org.nanohttpd.protocols.http.IHTTPSession session)	MAIN method for base handler.
Class<?>	getBeanClass()	Get bean entity class that has been generated trough PLANT, overwritten or null.
String[]	getColumn(int idx)	Access column values.
String	getColumnsForSql()	Get SQL fields, e.g.
String	getColumnsForSql(boolean forModification)	Get SQL fields, e.g.
final int	getCurrentEntityDbId()	Get current DB id of entity processed, for 'index.html' pages or other pages not showing an existing entity it is '-1'.
final BeetRootHTTPSession	getCurrentSession()	Get current HTTP session process.
protected String[]	getCustomizedExceptionInformation(Session userSession)	Overwrite this method, if you want to have a customized handler exception title and message.
final InputStream	getData()	Get data input stream.
final Entity	getEmptyBean()	Get an ampty bean of the entity type that is processed in this handler.
String	getEntity()	Get web entity (use plural, e.g.
final Class<?>	getHandlerClass(String handlerName)	Get a handler class by handler name.
String	getHtmlData()	Get HTML data.
String	getHtmlHead()	Get HTML head if there's any.
String	getInsertValues(BeetRootHTTPSession session)	Get SQL insert values.
String	getLayout(Session userSession)	Overwrite if you want to have a special layout for this handler.
int	getMessageType()	Get set message type, default it is info/success type.
String	getMimeType()	MIME type of the streamed data.
protected Scanner	getNewScanner(String resource)	Getting a new scanner for a web resource (HTML template) to parse.
protected Scanner	getNewScanner(String resource, String originalResource)	Getting a new scanner for a web resource (HTML template) to parse.
String	getPaginator(BeetRootHTTPSession session)	Get HTML paginator code.
Class<?>	getRedirectHandler()	Overwrite to get the right re-route/redirect index handler after modifying data.
String[]	getSimpleManagementUserRoles()	Retrieve user roles for simple user role management.
org.nanohttpd.protocols.http.response.IStatus	getStatus()	HTTP status of the response.
String	getTableExport(BeetRootHTTPSession session)	Get HTML table export code.
protected String	getTemplateEngineErrorMessage(Session userSession, String resource)	Get message for general template engine error.
protected String	getTemplateEngineErrorTitle(Session userSession, String resource)	Get title for general template engine error.
final String	getText()	Text or HTML content returned by this handler.
String	getText(BeetRootHTTPSession session, int origId)	Process handlers to get the whole HTML page.
String	getTitle(Session userSession)	Page title show left above the navigation area.
List<String>	getTransientFields()	Get transient fields
String	getUpdateSetClause(BeetRootHTTPSession session)	Get SQL update set clause.
String	getUpdateSetClause(BeetRootHTTPSession session, String onOffMapName)	Get SQL update set clause.
boolean	hasAccess(Session userSession)	Overwrite this method, to specifically extend handler authorization, e.g.
boolean	hasExternalLinks()	Overwrite if this handler serves templates with external links (starting with 'http' or 'https').
protected boolean	hasNoColumnsConfig()	Overwrite this if your handler has no columns config configuration.
void	initialize(BeetRootHTTPSession session)	Every handler MUST be initialized!
protected String	initialValue(String colName)	Holds initial add values from 'columns.cfg'.
protected int	initValuesSize()	Return size of initial value list for add template.
protected boolean	isCurrentUserUpdate(BeetRootHTTPSession session)	Is the current user being updated?
protected boolean	isCustomResponse()	Overwrite this if your handler has a custom response; e.g., a JSON response without any further HTML content.
protected boolean	isNoContentResponse()	Overwrite this if your handler doesn't have an output.
protected String	isNoContentResponseButRoute(Session userSession)	Overwrite this if your handler doesn't have an output.
protected boolean	isPrecisionInputType(String inputType)	Is the given HTML input type a precision input type? They are allowed to have a 'maxLength' attribute.
boolean	isRetryCall(BeetRootHTTPSession session)	Is it a retry call?
protected void	loginMarker(boolean redirectLogin)	Login marker method.
protected void	parseAssociatedEntities(StringBuilder snippet, List<Model> list, BeetRootHTTPSession session)	Parse associated list.
protected void	parseUnassociatedEntities(StringBuilder snippet, List<Model> list, BeetRootHTTPSession session)	Parse un-associated list.
static String	patchInputValue(String text, String id, String newValue)	This replaces a value in a HTML element with a specific ID.
protected StringBuilder	readSnippetResource(String resource, Session userSession)	Read snippet resource; e.g., 'web/html/:lang/users/snippets/roles.html'.
protected void	redirectedMarker(boolean redirected)	Mark this handler as it has been redirected from a data modifying handler.
protected final void	refreshUserRoles(int currentUserId, BeetRootHTTPSession session)	Refresh user roles and permissions for current user.
void	registerDisplayField(String displayNameValue)	Register a display name value to be show where defined in template.
static void	registerRoutes(List<Route> routes)	Routes registration method.
void	render(BeetRootHTTPSession session)	Overwrite to set your template variables.
void	renderAll(BeetRootHTTPSession session)	Overwrite to set your variables for the whole HTML page.
HandlerResponse	saveData(BeetRootHTTPSession session)	Save data to DB.
final void	setCurrentEntityDbId(int origId)	Set current DB id of entity processed, for 'index.html' pages or other pages not showing an existing entity it is '-1'.
void	setMessageType(int messageType)	Set message type.
final void	setVar(String variable, Object replacement)	Set a template variable.
final void	setVarAll(String variable, Object replacement)	Set a global variable.
boolean	showLangMenu(Session userSession)	Show language menu?
boolean	showMenu(Session userSession)	Show template menu?
String[]	uniqueFields()	Get unique fields.
HandlerResponse	uniqueTest(BeetRootHTTPSession session, String preSql, String operation)	Check if unique fields are unique.
HandlerResponse	updateData(BeetRootHTTPSession session, int id)	Update data in DB.

Methods inherited from class HTTPServer.DefaultStreamHandler

delete, other, post, put

Modifier and Type	Method	Description
org.nanohttpd.protocols.http.response.Response	delete(HTTPServer.UriResource uriResource, Map<String,String> urlParams, org.nanohttpd.protocols.http.IHTTPSession session)	Handles an HTTP DELETE request.
org.nanohttpd.protocols.http.response.Response	other(String method, HTTPServer.UriResource uriResource, Map<String,String> urlParams, org.nanohttpd.protocols.http.IHTTPSession session)	Handles any other HTTP method.
org.nanohttpd.protocols.http.response.Response	post(HTTPServer.UriResource uriResource, Map<String,String> urlParams, org.nanohttpd.protocols.http.IHTTPSession session)	Handles an HTTP POST request.
org.nanohttpd.protocols.http.response.Response	put(HTTPServer.UriResource uriResource, Map<String,String> urlParams, org.nanohttpd.protocols.http.IHTTPSession session)	Handles an HTTP PUT request.

Methods inherited from class Object

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

Field Details

LOG

protected static final org.slf4j.Logger LOG

Logger for this class.

Constructor Details

ExampleDownloadHandler

public ExampleDownloadHandler(String entity)

Creates the handler for the given entity.

Parameters:

entity - the entity name

ExampleDownloadHandler

public ExampleDownloadHandler(String entity,
 String msg)

Creates the handler for the given entity.

Parameters:

entity - the entity name

msg - the message

Method Details

readData

public HandlerResponse readData(BeetRootHTTPSession session,
 int id)
                         throws Exception

Description copied from class: BaseHandler

Read data from DB that must be filled when the template is parsed. Used by index and view handlers.

Overrides:

readData in class BaseHandler

Parameters:

session - HTTP session

id - db record id > 0 if a single record should be read otherwise < 0;

Returns:

response or null, null means success, response's status must be checked!

Throws:

Exception - exception

getResource

public String getResource()

Description copied from class: BaseHandler

Get web resource file as it lies on the file system relatively to the started server process.

Specified by:

getResource in interface Handler

Specified by:

getResource in class BaseHandler

Returns:

web resource