Änderungen von Dokument FORMCYCLE-Deploy-Plugin-Plugin

Von Version < 1.19 >

bearbeitet von awa
am 12.03.2020, 13:29

Auf Version < 1.15 >

bearbeitet von awa
am 12.03.2020, 12:00

< >

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

@@ -18,40
          +18,15 @@
  == Plugin-Konfiguration ==
--Am Plugin selber kann konfiguriert werden, ob das Deploy-Servlet durch ein Passwort geschützt werden soll. Dieses Passwort muss dann im Klartext beim HTTP-POST-Request mit angegeben werden.
++Am Plugin selber kann konfiguriert werden, ob das Deploy-Servlet durch ein Passwort geschützt werden soll. Dazu gibt es die eine Plugin-Eigenschaft //token//, diese hat das folgende Format
--Zur Konfiguration des Passworts gibt es die eine Plugin-Eigenschaft //token//, diese hat das folgende Format
++> hash_method:hashed_value
--{{code language="none"}}
--hash_method:hashed_value
--{{/code}}
--
  Folgende Hash-Methoden stehen zur Verfügung:
  ; plain
--: Identitätsfunktion, das Passwort im Klartext angegeben.
--; sha256
--: SHA-256-Algorithmus.
--; sha384
--: SHA-384-Algorithmus.
--; sha512
--: SHA-512-Algorithmus.
++: asd
--Um das Passwort im Klartext beispielsweise auf //admin// festzulegen, wird der folgende Wert für die Plugin-Eigenschaft //token// eingegeben:
--
--{{code language="none"}}
--plain:admin
--{{/code}}
--
--Um das Passwort mit SHA-256 beispielsweise auf //admin// festzulegen, wird der folgende Wert für die Plugin-Eigenschaft //token// eingegeben:
--
--{{code language="none"}}
--sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7
--{{/code}}
--
--Der Hash ist gesalzen. Ein gültiger Hash für ein bestimmtes Passwort kann mit dem //create-token//-Servlet erzeugt werden, siehe unten.
--
--
  == Deploy-Servlet ==
  Im Folgenden wird der Aufbau des HTTP-Requests beschrieben, um ein Plugin zu installieren, zu aktualisieren oder zu löschen.
@@ -58,9
          +58,7 @@
  Es muss immer ein HTTP-Post-Request verwendet werden und [[sich an folgende URL richten>>doc:Formcycle.PluginDevelopment.Types.IPluginServletAction]] (Namen des FORMCYCLE-Servers entsprechend anpassen):
--{{code language="none"}}
--POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
--{{/code}}
++> POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
  Die //client-id// muss nicht angegeben werden, wenn das Plugin als System-Plugin installiert ist.
@@ -188,7
          +188,7 @@
  {{/code}}
  )))
--=== Response ===
++== Response ==
  Das Deploy-Plugin liefert einen Statuscode und ein JSON-Objekt mit den Details zurück. Der Status-Code ist 2xx, falls das Deploy-Plugin erfolgreich ausgeführt wurde.
@@ -341,92
          +341,5 @@
  {{/code}}
--== Create-Token-Servlet ==
++== Beispiel für Maven ==
--Mit diesem Servlet kann ein Hash für ein bestimmtes Klartextpasswort erzeugt werden, welcher dann in der Plugin-Eigenschaft //token// hinterlegt werden kann. Es muss hierbei ein HTTP-GET-Request verwendet werden (Pfad auf den FORMCYCLE-Servet und die Mandant-ID entsprechend ersetzen):
--
--{{code language="none"}}
--http://localhost:8080/formcycle/plugin?client-id=1&name=create-token&token=<PASSWORT>&method=<METHOD>
--{{/code}}
--
--; token
--: Der Klartext des Passwort, zu dem ein Hash ermittelt werden soll.
--; method
--: Methode zum Berechnen des Hashes. Erlaubte Werte sind //plain//, //sha256//, //sha384// und //sha512//. Optional, Standardwert ist //sha256//.
--
--Als Antwort wird ein JSON zurückgeliefert, welches das gleiche Format wie die Antwort des Deploy-Plugins hat. Beispiel für eine Antwort:
--
--{{code language="json"}}
--{
--	"success": true,
--	"requestParameters": {
--		"name": ["create-token"],
--		"client-id": ["1"],
--		"token": ["admin"]
--	},
--	"details": {
--		"method": "sha256",
--		"token": "sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7"
--	},
--	"message": "Hash token created successfully",
--	"statusCode": 200
--}
--{{/code}}
--
--== Maven-Deploy-Plugin ==
--
--Um ein Plugin nach dem Bauen über Maven in FORMCYCLE hochzuladen, gibt es auch ein Maven-Plugin, welches das Deploy-Servlet anspricht. Dieses ist über die Artifactory von XIMA erhältlich, falls man die entsprechenden Rechte hierfür hat:
--
--{{code language="xml"}}
--<plugin>
--    <groupId>de.xima.fc.maven.plugin</groupId>
--    <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
--    <version>1.1.0</version>
--    <configuration>
--        <url>http://localhost:8080/formcycle</url>
--        <pluginName>deploy-plugin</pluginName>
--        <clientId>52</clientId>
--        <token>admin</token>
--        <deployAction>save</deployAction>
--        <pluginIdent>name</manifest>
--        <pluginIdentifier>my-plugin.jar</pluginIdentifier>
--        <jarFile></jarFile>
--        <disallowInstall>false</disallowInstall>
--        <locale>en</locale>
--        <clearProperties>true</clearProperties>
--        <properties>
--            <property1>value1</property1>
--            <property2>value2</property2>
--        <properties>
--   </configuration>
--</plugin>
--{{/code}}
--
--Das Plugin hat die folgenden Optionen zur Konfiguration:
--
--; url [Standardwert: //${fcDeployUrl}//]
--: URL mit Kontextpfad zum FORMCYCLE-Server, etwa //http://localhost:8080/formcycle//
--; pluginName [Standardwert: //deploy-plugin//]
--: Der Name des Deploy-Plugins für den URL-Parameter //name//. In der Regel muss diese Option nicht gesetzt werden, der Standardwert ist ausreichend.
--; clientId [Standardwert: //${fcDeployClientId}//]
--: ID des Mandanten, für den das Plugin installiert, aktualisiert oder gelöscht werden soll. Entspricht dem Parameter //client-id// des Deploy-Plugins, siehe oben.
--; clientUuid
--: UUID des Mandanten, für den das Plugin installiert, aktualisiert oder gelöscht werden soll. Entspricht dem Parameter //client-uuid// des Deploy-Plugins, siehe oben.
--; token [Standardwert: ${fcDeployToken}]
--: Passwort für das Servlet-Plugin, falls in der Konfiguration des Deploy-Plugins ein Passwort gesetzt wurde.
--; deployAction [Standardwert: //save//]
--: Aktion, welche mit dem Plugin durchgeführt werden soll. Erlaubte Werte sind //save//, //update-properties//, //activate//, //deactivate// und //delete//. Entspricht dem Parameter //deploy-action// des Deploy-Plugins, siehe oben.
--; pluginIdent [Standardwert: //manifest//]
--: Die Art, wie nach einem vorhandenen Plugin gesucht wird. Entspricht dem Parameter //plugin-ident// des Deploy-Plugins, siehe oben.
--; pluginIdentifier [Standardwert: //Implementation-Title=${project.groupId}:${project.artifactId}//]
--: Identifikator des Plugins, welches aktualisiert oder gelöscht werden soll. Entspricht dem Parameter //plugin-identifier// des Deploy-Plugins, siehe oben.
--; jarFile [Standartwert: Haupt-Build-Artifakt des Maven-Projekts]
--: Pfad zur JAR-Datei, die hochgeladen werden soll, relativ zum Basisverzeichnis des Maven-Projekts.
--; disallowInstall [Standardwert: //false//]
--: Wenn //true// und das Plugin noch nicht existiert, wird abgebrochen und ein Fehler zurückgegeben. Entspricht dem Parameter //disallow-install// des Deploy-Plugins, siehe oben.
--; locale [Standardwert: //en//]
--: Sprache, die für die Installation, Aktualisierung oder Löschung des Plugins genutzt wird. Entspricht dem Parameter //locale// des Deploy-Plugins, siehe oben.
--; clearProperties [Standardwert: //false//]
--: Löscht die Werte aller Plugin-Eigenschaften. Entspricht dem Parameter //clear-properties// des Deploy-Plugins, siehe oben.
--; properties
--: Key-Value-Paare mit Eigenschaften, die an dem Plugin gesetzt werden sollen. Entspricht dem Parameter //clear-properties// des Deploy-Plugins, siehe oben.

Änderungen von Dokument FORMCYCLE-Deploy-Plugin-Plugin

Zusammenfassung

Details

Navigation