de.xima.fc.web.common.fd2.model

Class DefaultFD2MetaDataWrapper

java.lang.Object

de.xima.designer.abstracts.AMetaDataWrapper

de.xima.fc.web.common.fd2.model.DefaultFD2MetaDataWrapper

All Implemented Interfaces:

Serializable

public class DefaultFD2MetaDataWrapper
extends AMetaDataWrapper

Diese Klasse kapselt ein Script-Objekt welches als Node im einem HTML-Generierungsprozess eingebunden werden kann. Primär zielt diese Klasse darauf ab Meta-Informationen zum aktuellen Benutzer, BenutzerGruppen, Vorgang sowie URL-Parameter und Plugins in ein Formular einzubinden, wenn dieses über das Form-Servlet aufgerufen wird. Ist der FormRequestContext null, so werden die JSONObjecte welche den Kontext benötigen nicht angefügt. Gleiches gilt die Maps, die als Grundlage für die JSONObject-Generierung dienen

Author:

xima media GmbH, Dresden - mgu - 11.12.2013, xima media GmbH, Dresden - Michael Kohlsche - 19.03.2014

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultFD2MetaDataWrapper(FD2RenderContext fd2Ctx) Konstruktor mit allen benötigten Objekten um den vollen Funktionsumfang der Klasse zu gewährleisten.
DefaultFD2MetaDataWrapper(String scriptName, FD2RenderContext fd2Ctx) Konstruktor mit allen benötigten Objekten um den vollen Funktionsumfang der Klasse zu gewährleisten.

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,List<String[]>>	buildDataMap(FD2RenderContext fd2Ctx) Diese Methode liefert eine Map als Vereinigungsmenge aus #valuesMap und #urlParams.
protected String	buildInnerJSONString(FD2RenderContext fd2Ctx) Diese Methode fügt die Basiselemente als JSONObject dem FormMetaData-Objekt hinzu.
protected org.json.JSONArray	createAttachmentsData(FD2RenderContext fd2Ctx) Hinzufügen der Daten der Attachments
protected org.json.JSONObject	createCurrentMandant(FD2RenderContext fd2Ctx)
protected org.json.JSONObject	createCurrentProjekt(FD2RenderContext fd2Ctx) Diese Methode erzeugt das JSONObject für den aktuell im FormRequestContext befindlichen Projekt
protected org.json.JSONObject	createCurrentUser(FD2RenderContext fd2Ctx) Diese Methode erzeugt das JSONObject für den aktuell im FormRequestContext befindlichen Benutzer
protected org.json.JSONObject	createCurrentVorgang(FD2RenderContext fd2Ctx) Diese Methode erzeugt das JSONObject für den aktuell im FormRequestContext befindlichen Vorgang
protected org.json.JSONObject	createPluginResults(FD2RenderContext fd2Ctx) Diese Methode erzeugt ein JSONObject welches die Plugin-Informationen als JSONObject beinhaltet.
protected org.json.JSONObject	createUrlParams(FD2RenderContext fd2Ctx) Diese Methode erzeugt ein JSONObject aus URL-Parametern.
protected org.json.JSONObject	createURLs(FD2RenderContext fd2Ctx)
protected org.json.JSONArray	createUserGroupsArray(Benutzer user) Diese Methode erzeugt das JSONArray mit BenutzerGruppen-Zuordnungen zu dem übergebenen Benutzer
protected org.json.JSONObject	determineLdapUserProperties(FD2RenderContext fd2Ctx) Diese Methode erzeugt ein JSONObject welche LDAP-Eigenschaften zu einem Nutzer enthält.
Map<String,List<String[]>>	getDataMap()
String	getInnerJSONString()
AMetaDataWrapper	rebuild(FD2RenderContext fd2Ctx)

Methods inherited from class de.xima.designer.abstracts.AMetaDataWrapper

getScriptMetaData

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFD2MetaDataWrapper

public DefaultFD2MetaDataWrapper(FD2RenderContext fd2Ctx)

Konstruktor mit allen benötigten Objekten um den vollen Funktionsumfang der Klasse zu gewährleisten. Alle Parameter können als null übergeben werden. Die Teile, welche dann auf ein solches Element zu greifen prüfen dies und erzeugen ggf. keine Daten. Die JSON-Objekte würde dann nicht hinzugefügt werden.

Parameters:

fd2Ctx - der FD2RenderContext der mit dem Abfragen eines Formulars erzeugt wird und entsprechende Sitzungsdaten beinhaltet

DefaultFD2MetaDataWrapper

public DefaultFD2MetaDataWrapper(String scriptName,
                         FD2RenderContext fd2Ctx)

Konstruktor mit allen benötigten Objekten um den vollen Funktionsumfang der Klasse zu gewährleisten. Alle Parameter können als null übergeben werden. Die Teile, welche dann auf ein solches Element zu greifen prüfen dies und erzeugen ggf. keine Daten. Die JSON-Objekte würde dann nicht hinzugefügt werden.

Parameters:

scriptName - Name unter dem der Knoten referenzierbar ist

fd2Ctx - der FD2RenderContext der mit dem Abfragen eines Formulars erzeugt wird und entsprechende Sitzungsdaten beinhaltet

Method Detail

buildInnerJSONString

protected String buildInnerJSONString(FD2RenderContext fd2Ctx)

Diese Methode fügt die Basiselemente als JSONObject dem FormMetaData-Objekt hinzu. Sollen zusätzliche Elemente hinzugefügt werden, so kann diese Methode überschieben bzw. erweitert werden.

rebuild

public AMetaDataWrapper rebuild(FD2RenderContext fd2Ctx)

createURLs

protected org.json.JSONObject createURLs(FD2RenderContext fd2Ctx)

createCurrentMandant

protected org.json.JSONObject createCurrentMandant(FD2RenderContext fd2Ctx)

createCurrentUser

protected org.json.JSONObject createCurrentUser(FD2RenderContext fd2Ctx)

Diese Methode erzeugt das JSONObject für den aktuell im FormRequestContext befindlichen Benutzer

Returns:

JSONObject mit Daten des Benutzers (inklusive zugeordneten BenutzerGruppen als JSONArray) oder null wenn Benutzer im Kontext nicht vorhanden oder eine JSONException auftritt

createUserGroupsArray

protected org.json.JSONArray createUserGroupsArray(Benutzer user)

Diese Methode erzeugt das JSONArray mit BenutzerGruppen-Zuordnungen zu dem übergebenen Benutzer

Returns:

JSONArray mit BenutzerGruppe.getName() oder null wenn Exception auftritt

createCurrentVorgang

protected org.json.JSONObject createCurrentVorgang(FD2RenderContext fd2Ctx)

Diese Methode erzeugt das JSONObject für den aktuell im FormRequestContext befindlichen Vorgang

Returns:

JSONObject mit Daten des Vorgangs oder null wenn Vorgang im Kontext nicht vorhanden oder eine JSONException auftritt

createAttachmentsData

protected org.json.JSONArray createAttachmentsData(FD2RenderContext fd2Ctx)

Hinzufügen der Daten der Attachments

Returns:

createCurrentProjekt

protected org.json.JSONObject createCurrentProjekt(FD2RenderContext fd2Ctx)

Diese Methode erzeugt das JSONObject für den aktuell im FormRequestContext befindlichen Projekt

Returns:

JSONObject mit Daten des Projekts oder null wenn Projekt im Kontext nicht vorhanden oder eine JSONException auftritt

createUrlParams

protected org.json.JSONObject createUrlParams(FD2RenderContext fd2Ctx)

Diese Methode erzeugt ein JSONObject aus URL-Parametern. Es wird hierbei ein einziges JSONObject erzeugt welches die URL-Parameter als Key-Value-Paar beinhaltet. Ergibt sich der Value aus einem Array, so wird das erste Element des Arrays als Value genutzt. Ist kein Value vorhanden oder besteht der Value aus einem Leerstring, so wird der Parameter dem JSONObject nicht hinzugefügt

Returns:

JSONObject mit URL-Parametern als Key-Value-Paar. null wenn eine JSONException auftritt oder die Map der URL-Paramter null bzw. leer ist.

createPluginResults

protected org.json.JSONObject createPluginResults(FD2RenderContext fd2Ctx)

Diese Methode erzeugt ein JSONObject welches die Plugin-Informationen als JSONObject beinhaltet. Das umschließende JSONObject kann mehrere andere JSONObjecte beinhalten, welche wiederum mir Key-Value-Paaren befüllt sind.

Returns:

JSONObject mit Plugin-Informationen oder null wenn ein JSONException auftritt bzw. die Map mit den Plugin-Informationen leer bzw. null ist.

buildDataMap

protected Map<String,List<String[]>> buildDataMap(FD2RenderContext fd2Ctx)

Diese Methode liefert eine Map als Vereinigungsmenge aus #valuesMap und #urlParams. Hierbei wird eine neue Map erzeugt und zurückgeliefert.

Returns:

eine Map bestehend aus valuesMap und urlParams oder eine leere Map wenn keine Daten vorhanden.

determineLdapUserProperties

protected org.json.JSONObject determineLdapUserProperties(FD2RenderContext fd2Ctx)

Diese Methode erzeugt ein JSONObject welche LDAP-Eigenschaften zu einem Nutzer enthält. Diese Eigenschaften werden ebenfalls als JSONObject-Struktur abgelegt.

Returns:

JSONObject mit LDAP-Nutzereigenschaften oder leeres JSONObject wenn keine LDAP-Nutzerinformationen gefunden wurden.

getDataMap

public Map<String,List<String[]>> getDataMap()

Specified by:

getDataMap in class AMetaDataWrapper

getInnerJSONString

public String getInnerJSONString()

Specified by:

getInnerJSONString in class AMetaDataWrapper