de.xima.fc.servlet.handler

Class AbstractServletHandler<T extends ITransferableEntity>

java.lang.Object

de.xima.fc.servlet.handler.AbstractServletHandler<T>

All Implemented Interfaces:

IBasisServletAction

Direct Known Subclasses:

GeneralServletHandler

public abstract class AbstractServletHandler<T extends ITransferableEntity>
extends Object
implements IBasisServletAction

Field Summary

Fields

Modifier and Type	Field and Description
protected T	entity
protected Class<T>	entityClass
protected Locale	locale
protected static org.slf4j.Logger	LOG Allgemeiner Handler-Logger.
protected UserContext	uc

Constructor Summary

Constructors

Constructor and Description
AbstractServletHandler()

Method Summary

Modifier and Type	Method and Description
protected List<de.xima.cmn.criteria.FilterCriterion>	appendMandantFilter(List<de.xima.cmn.criteria.FilterCriterion> filterCriterias, javax.servlet.http.HttpSession sess) Die Filter Kriterien werden um den Mandanten-Filter erweitert, sobald die Entität mandantenabhängig ist.
Benutzer	getCurrBenutzer(javax.servlet.http.HttpSession sess) Liest den aktuellen Benutzer aus XfcSession.currentBenutzer().
Mandant	getCurrMandant(javax.servlet.http.HttpSession sess) Liest den aktuellen Mandanten aus XfcSession.currentMandant().
T	getEntity()
protected String	handleCreate(javax.servlet.http.HttpServletRequest req) Aktualisieren der Entität ausführen und Client-Response zusammenbauen.
protected String	handleDelete(javax.servlet.http.HttpServletRequest req) Löschen von Entitäten ausführen und Client-Reponse zusammenbauen.
protected String	handleReadById(javax.servlet.http.HttpServletRequest req) Auslesen von Daten anhand der ID und Client-Response zusammenbauen
protected String	handleReadList(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Auslesen der Liste von Entitäten, hierbei werden die Filter-, Pagination und Sortierungsparametern vom Client berücksichtigt.
protected String	handleReadList(javax.servlet.http.HttpServletRequest req, List<T> entityList, HashMap<String,String> returnValues) Auslesen der Liste von Entitäten welche übergeben wird und Client-Response zusammenbauen
protected String	handleUpdate(javax.servlet.http.HttpServletRequest req) Aktualiseren der Entität ausführen und Client-Response zusammenbauen.
void	init(Class<T> entityClass, javax.servlet.http.HttpServletRequest req) Initialsierung der Handler übernimmt das Setzen der Instanzvariablen: Klasse der Entität und Entität mit entsprechenden Daten
protected String	response(javax.servlet.http.HttpSession session, HashMap<String,String> returnValues) Entität in eine Liste packen, Weiterleitung an Methode AbstractServletHandler#responseList(List, String).

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.servlet.handler.interfaces.IBasisServletAction

delete, error, get, post, put

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Allgemeiner Handler-Logger.

uc

protected final UserContext uc

entityClass

protected Class<T extends ITransferableEntity> entityClass

entity

protected T extends ITransferableEntity entity

locale

protected Locale locale

Constructor Detail

AbstractServletHandler

public AbstractServletHandler()

Method Detail

init

public void init(Class<T> entityClass,
                 javax.servlet.http.HttpServletRequest req)
          throws HandledServletException

Initialsierung der Handler übernimmt das Setzen der Instanzvariablen: Klasse der Entität und Entität mit entsprechenden Daten

Parameters:

entityClass - - Klasse zur Entität

req - - HttpServletRequest

Throws:

HandledServletException - zur Fehlerbehandlung

getEntity

public final T getEntity()

handleReadById

protected final String handleReadById(javax.servlet.http.HttpServletRequest req)

Auslesen von Daten anhand der ID und Client-Response zusammenbauen

Parameters:

req - HttpServletRequest

Returns:

Client-Response

handleReadList

protected final String handleReadList(javax.servlet.http.HttpServletRequest req,
                                      List<T> entityList,
                                      HashMap<String,String> returnValues)

Auslesen der Liste von Entitäten welche übergeben wird und Client-Response zusammenbauen

Parameters:

req - HttpServletRequest

entityList - Liste von Entitäten

returnValues - Zuätzliche Parameter, die dem JSON-Response hinzugefügt werden sollen. Kann null sein.

Returns:

Client-Response

handleReadList

protected final String handleReadList(javax.servlet.http.HttpServletRequest req,
                                      javax.servlet.http.HttpServletResponse resp)

Auslesen der Liste von Entitäten, hierbei werden die Filter-, Pagination und Sortierungsparametern vom Client berücksichtigt. Anschließend wird der Client-Response zusammengebaut.

Parameters:

req - HttpServletRequest

resp - HttpServletResponse

Returns:

Client-Response

handleUpdate

protected final String handleUpdate(javax.servlet.http.HttpServletRequest req)

Aktualiseren der Entität ausführen und Client-Response zusammenbauen. Im Fehlerfall wird eine entsprechende Meldung zurückgegeben.

Parameters:

req - HttpServletRequest

Returns:

Client-Response

handleCreate

protected final String handleCreate(javax.servlet.http.HttpServletRequest req)

Aktualisieren der Entität ausführen und Client-Response zusammenbauen. Im Fehlerfall wird eine entsprechende Meldung zurückgegeben.

Parameters:

req - HttpServletRequest

Returns:

Client-Response

handleDelete

protected final String handleDelete(javax.servlet.http.HttpServletRequest req)

Löschen von Entitäten ausführen und Client-Reponse zusammenbauen. Im Fehlerfall wird eine entsprechende Meldung zurückgegeben.

Parameters:

req - HttpServletRequest

Returns:

Client-Response

getCurrBenutzer

public final Benutzer getCurrBenutzer(javax.servlet.http.HttpSession sess)

Liest den aktuellen Benutzer aus XfcSession.currentBenutzer().

Parameters:

sess - HttpSession

Returns:

aktuellen Benutzer (Kontextinformation)

getCurrMandant

public final Mandant getCurrMandant(javax.servlet.http.HttpSession sess)

Liest den aktuellen Mandanten aus XfcSession.currentMandant().

Parameters:

sess - HttpSession

Returns:

aktuellen Mandanten (Kontextinformation)

response

protected final String response(javax.servlet.http.HttpSession session,
                                HashMap<String,String> returnValues)
                         throws HandledServletException

Entität in eine Liste packen, Weiterleitung an Methode AbstractServletHandler#responseList(List, String).

Parameters:

sessionId - Session-ID

returnValues - Zuätzliche Parameter, die dem JSON-Response hinzugefügt werden sollen. Kann null sein.

Returns:

Client-Response

Throws:

HandledServletException

appendMandantFilter

protected final List<de.xima.cmn.criteria.FilterCriterion> appendMandantFilter(List<de.xima.cmn.criteria.FilterCriterion> filterCriterias,
                                                                               javax.servlet.http.HttpSession sess)

Die Filter Kriterien werden um den Mandanten-Filter erweitert, sobald die Entität mandantenabhängig ist.

Parameters:

filterCriterias - Fitler Kriterien

sess - HttpSession

Returns:

erweiterte Liste mit Filter Kriterien