nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

As we transition to the new Hyland Community, some post links may be temporarily disrupted as we finalize redirects. We apologize for the inconvenience and are working to resolve this as quickly as possible. Details.

Java-backed Web Scripts interface utilisateur

michel

Bonjour,

Je suis en trains de voir comment fonctionne les Java-backed Web Scripts et j'ai une petite question:

Comment peut-on renvoyer des données au client (web en général) autrement que via:

res.getWriter().write("les données");
‍‍‍

est-il possible d'utiliser une JSP ou quelque chose d'autre pour la présentation (style comme en FTL/javascript)?

Je passe via le java pour une question de performance…

Merci d'avance.

Michel.

Find more posts tagged with

Comments

thomasb

Bonjour,

Je suis en trains de voir comment fonctionne les Java-backed Web Scripts et j'ai une petite question:

Comment peut-on renvoyer des données au client (web en général) autrement que via:
res.getWriter().write("les données");
‍‍‍
est-il possible d'utiliser une JSP ou quelque chose d'autre pour la présentation (style comme en FTL/javascript)?

Si FreeMarker convient, il suffit de dériver de DeclarativeWebScript au lieu de AbstractWebScript. Sinon, il faudra appeler le renderer (JSP ou autre) directement; je ne connais pas les APIs JSP mais c'est très probablement possible.

Je passe via le java pour une question de performance…

Je ne suis pas sûr que ce soit une raison suffisante pour choisir Java plutôt que JavaScript. Il n'y a qu'à voir comment Alfresco Share utilise du "declarative WebScript" de partout: pour une page affichée, il y a au minimum (je dis ça à la louche) 3 WebScripts appelés côté Share, sans compter les WebScripts côté "repository" pour obtenir les données à afficher.

À mon avis, le choix de Java pour les webscripts doit être fait plus en cas de nécessité, si après benchmarks il s'avère que le pendant javascript présente effectivement des difficultés (et je ne parle pas de mesures comparatives, mais de "performance jugée acceptable" ou non); ou bien pour absence de fonctionnalités en JavaScript. Pour Share par exemple, l'invitation d'utilisateurs nécessite un "run as system", qui n'est pas dispo en JavaScript (j'ai fait une ScriptProcessExtension pour ça dans un projet, Alfresco a préféré coder le webscript entièrement en Java).

michel

Un grand merci pour ta réponse.

En ce qui concerne le choix de java au lieu de javascript pour les webscripts, il s'agit justement d'un cas de nécessité. En effet, le webscript existe déjà en javascript mais son exécution est trop lente lorsqu'il doit afficher énormément de données (documents/espaces); il met plus de 2 minutes.

Je teste ça de suite.

michel

Bonjour,

Voici un petit feedback à propos des "Java-backed Web Scripts".

Pour créer un Java-backed end Web Scripts, il faut :

1) Étendre la classe : org.alfresco.web.scripts.DeclarativeWebScript
2) Overridé la méthode protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
3) Construire son modèle dans une Map comme suit: Clef Valeur/objet
4) Créer l'intégration spring dans un fichier XML du bean Java-backed end Web Scripts
5) Créer la description/intégration XML du web-script. (attention il faut être authentifier pour pouvoir avoir accès au compagy_home)
6) Créer le ficher ftl.

pour plus ample information, veuillez-vous référer au wiki à l'adresse suivante: http://wiki.alfresco.com/wiki/Java-backed_Web_Scripts_Samples

bertrandf

Bonjour,

J'ai suivi les étapes que vous avez décrites mais je ne parviens pas à récupèrer ce que j'ai mis dans mon modèle avec mon fichier freemarker.

Par exemple, si je mets dans mon modèle ceci :

Map<String, Object> model = new HashMap<String, Object>();
model.put("Var", "Hello World");

return model;
‍‍‍‍‍‍

Comment faut-il faire pour récupèrer les données dans son fichier ftl?

J'ai essayé avec :

${model.Var}‍

${Var}‍

mais ca ne marche pas.

Est-ce que qqn pourrait m'expliquer svp, car je suis ne suis pas très à l'aise avec freemarker.
Merci d'avance.

thomasb

Normalement ${Var}.

Sans en savoir plus sur le "ça ne marche pas", je dirais que peut-être le bean n'est pas correctement déclaré côté Spring, donc le code pas exécuté (et comme un webscript peut n'être composé que d'un couple desc.xml + ftl…)

bertrandf

Merci pour la réponse.

Quand je dis ca ne marche pas, c'est qu'en fait il ne connait pas la variable :

Wrapped Exception (with status template): Error during processing of the template 'Expression Var is undefined on line 7, column 21 in org/alfresco/audit/simple.get.html.ftl.'.‍

Je vais regarder coté Spring.

Merci, je pensais que j'utilisais mal freemarker.

michel

Bonjour,

Normalement c'est bien

${Var}‍

pour accéder à la variable

Mais peux-tu montrer l'erreur que tu obtiens en ftl ou dans les log d'alfresco?

bertrandf

Voici l'erreur que j'obtiens :

Exception:   freemarker.core.InvalidReferenceException - Expression Var is undefined on line 6, column 19 in org/alfresco/audit/simple.get.html.ftl.
    
   freemarker.core.TemplateObject.assertNonNull(TemplateObject.java:124)
   freemarker.core.Expression.getStringValue(Expression.java:118)
   freemarker.core.Expression.getStringValue(Expression.java:93)
   freemarker.core.DollarVariable.accept(DollarVariable.java:76)
   freemarker.core.Environment.visit(Environment.java:208)
   freemarker.core.MixedContent.accept(MixedContent.java:92)
   freemarker.core.Environment.visit(Environment.java:208)
   freemarker.core.Environment.process(Environment.java:188)
   freemarker.template.Template.process(Template.java:237)
   org.alfresco.repo.template.FreeMarkerProcessor.process(FreeMarkerProcessor.java:201)
   org.alfresco.web.scripts.AbstractWebScript.renderTemplate(AbstractWebScript.java:505)
   org.alfresco.web.scripts.DeclarativeWebScript.renderFormatTemplate(DeclarativeWebScript.java:241)
   org.alfresco.web.scripts.DeclarativeWebScript.execute(DeclarativeWebScript.java:147)
   org.alfresco.repo.web.scripts.RepositoryContainer$2.execute(RepositoryContainer.java:319)
   org.alfresco.repo.transaction.RetryingTransactionHelper.doInTransaction(RetryingTransactionHelper.java:320)
   org.alfresco.repo.transaction.RetryingTransactionHelper.doInTransaction(RetryingTransactionHelper.java:227)
   org.alfresco.repo.web.scripts.RepositoryContainer.transactionedExecute(RepositoryContainer.java:368)
   org.alfresco.repo.web.scripts.RepositoryContainer.transactionedExecuteAs(RepositoryContainer.java:390)
   org.alfresco.repo.web.scripts.RepositoryContainer.executeScript(RepositoryContainer.java:273)
   org.alfresco.web.scripts.AbstractRuntime.executeScript(AbstractRuntime.java:261)
   org.alfresco.web.scripts.AbstractRuntime.executeScript(AbstractRuntime.java:139)
   org.alfresco.web.scripts.servlet.WebScriptServlet.service(WebScriptServlet.java:116)
   javax.servlet.http.HttpServlet.service(HttpServlet.java:717)
   org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:290)
   org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
   org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:233)
   org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:191)
   org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:128)
   org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:102)
   org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109)
   org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:286)
   org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:845)
   org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.process(Http11Protocol.java:583)
   org.apache.tomcat.util.net.JIoEndpoint$Worker.run(JIoEndpoint.java:447)
   java.lang.Thread.run(Thread.java:619)
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Merci.

bertrandf

je dirais que peut-être le bean n'est pas correctement déclaré côté Spring

En fait j'ai repris l'exemple du wiki et quand je créé mon WebScript avec AbstractWebScript, il fonctionne bien.

Mais je n'arrive pas à le faire fonctionner avec DeclarativeWebscript, pourtant:
- j'etends bien la classe : org.alfresco.web.scripts.DeclarativeWebScript
- j'ai overridé la méthode protected Map<String, Object> executeImpl(WebScriptRequest req, Status status)
- et j'ai construis son modèle dans une Map ( Clef Valeur/objet)

En ce qui concerne l'intégration spring dans un fichier XML du bean et la description/intégration XML du web-script, je fais la même chose que l'exemple du wiki.

L'intégration spring dans un fichier XML du bean est bien la même que j'etende la classe AbstractWebScript ou la classe DeclarativeWebscript ?

En ce qui concerne le fichier template, je l'ai nommé : nomWS.get.html.ftl et je l'ai placé au même endroit que la description du WS (nomWS.get.desc.xml), c'est bien ce qu'il faut faire?
Y-a-t-il qqch à préciser quelque part pour indiquer qu'il faut utiliser mon fichier ftl (dans la classe java ou dans la déclaration du WS) ou cela se fait implicitement vu le nom du template?

Je vous remercie par avance.

thomasb

je dirais que peut-être le bean n'est pas correctement déclaré côté Spring

En fait j'ai repris l'exemple du wiki et quand je créé mon WebScript avec AbstractWebScript, il fonctionne bien.

Mais je n'arrive pas à le faire fonctionner avec DeclarativeWebscript, pourtant:
- j'etends bien la classe : org.alfresco.web.scripts.DeclarativeWebScript
- j'ai overridé la méthode protected Map<String, Object> executeImpl(WebScriptRequest req, Status status)
- et j'ai construis son modèle dans une Map ( Clef Valeur/objet)

En ce qui concerne l'intégration spring dans un fichier XML du bean et la description/intégration XML du web-script, je fais la même chose que l'exemple du wiki.

Donc, si je me fie aux messages ci-dessus:

<bean id="webscript.org.alfresco.audit.simple.get" 
      class="package.et.nom.de.la.ClasseDuWebScript"
      parent="webscript">
</bean>
‍‍‍‍‍‍

L'intégration spring dans un fichier XML du bean est bien la même que j'etende la classe AbstractWebScript ou la classe DeclarativeWebscript ?

Oui (mises à part les dépendances).

En ce qui concerne le fichier template, je l'ai nommé : nomWS.get.html.ftl et je l'ai placé au même endroit que la description du WS (nomWS.get.desc.xml), c'est bien ce qu'il faut faire?
Y-a-t-il qqch à préciser quelque part pour indiquer qu'il faut utiliser mon fichier ftl (dans la classe java ou dans la déclaration du WS) ou cela se fait implicitement vu le nom du template?

Non non, la simplicité du "web script framework" tient entre autres de cette démarche de convention de nommage.

Éventuellement, peut-on voir le code complet de la classe Java ? (et la déclaration Spring, tant qu'à faire)

bertrandf

En fait il n'y a pas grand chose dans ma classe Java :

package org.alfresco.module.auditscript;

import java.util.HashMap;
import java.util.Map;

import org.alfresco.web.scripts.DeclarativeWebScript;
import org.alfresco.web.scripts.WebScriptException;
import org.alfresco.web.scripts.WebScriptRequest;
import org.alfresco.web.scripts.Status;

public class SimpleWebScript extends DeclarativeWebScript
{
    @Override
    protected Map<String, Object> executeImpl(WebScriptRequest req, Status status) 
    {
        try
        {
            Map<String, Object> model = new HashMap<String, Object>();
            model.put("Var", "Hello World");   
            return model;   
        }
        catch(Exception e)
        {
            throw new WebScriptException("Erreur");
        }   
    }   
}
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

<bean id="webscript.org.alfresco.audit.simple.get" class="org.alfresco.module.auditscript.SimpleWebScript" parent="webscript">
</bean>
‍‍‍‍

michel

Tu sais poster aussi le FTL et le fichier desc.xml (avec leur nom de fichier)?

Ainsi on peut voir les quelques petites subtilités qui existe dans le nommage du bean et aussi à quel endroit tu les mets sur le fileSystem.

thomasb

Ouaip, à mon avis, déclaration Spring mal placée et donc pas lue par Spring…

michel

Perso, j'aime pas trop ceci:

En ce qui concerne le fichier template, je l'ai nommé : nomWS.get.html.ftl et je l'ai placé au même endroit que la description du WS (nomWS.get.desc.xml), c'est bien ce qu'il faut faire?

et surtout:

<bean id="webscript.org.alfresco.audit.simple.get" class="org.alfresco.module.auditscript.SimpleWebScript" parent="webscript">
</bean>

J'ai toujours utilisé les même noms…

ex:
pour le bean:

<bean id="webscript.be.etnic.alfresco.webscript.selector.get" class="be.etnic.alfresco.webscript.Selector" parent="webscript">
‍‍‍

et pour le ftl et le fichier desc.xml

selector.get.html.ftl
‍‍‍

selector.get.desc.xml
‍‍‍

les 2 se trouvant dans:
%TOMCAT%\webapps\alfresco\WEB-INF\classes\alfresco\extension\templates\webscripts\be\etnic\alfresco\webscript

thomasb

Perso, j'aime pas trop ceci:

En ce qui concerne le fichier template, je l'ai nommé : nomWS.get.html.ftl et je l'ai placé au même endroit que la description du WS (nomWS.get.desc.xml), c'est bien ce qu'il faut faire?

et surtout:

<bean id="webscript.org.alfresco.audit.simple.get" class="org.alfresco.module.auditscript.SimpleWebScript" parent="webscript">
</bean>

J'ai toujours utilisé les même noms…

eh eh, bien joué !

Qu'est-ce que je disais: mauvaise déclaration Spring: comme dit et répété (pour chaque exemple) sur la page de wiki dont le lien a déjà donné:

The naming convention of the Spring bean declaration is important.
The prefix “webscript” is picked up by the Web Script engine. In this way, it knows that the bean you are declaring is a web script implementation.
The ending “get” is picked up by the Web Script engine. It tells the Web Script engine which HTTP method to handle. In this case, an HTTP GET.
The rest is then assumed to be the package and name of the Web Script.

Donc effectivement, si le webscript s'appelle "nomWS.get", et placé disons dans org/alfresco/audit, le nom du bean doit être "webscript.org.alfresco.audit.nomWS.get".

bertrandf

Merci pour vos réponses.

Mes noms de fichiers sont les suivants : simple.get.desc.xml et simple.get.html.ftl donc je ne pense pas que l'erreur soit ici.

Contenu de mon simple.get.desc.xml :

<webscript>
  <shortname>The Simplest AUDIT Webscript</shortname>
  <description>WS de test</description>
  <url>/audit/simple</url>
  <authentication>admin</authentication>
  <format default="">argument</format>
</webscript>‍‍‍‍‍‍‍

Contenu de mon simple.get.html.ftl :

<html>
   <head>
   </head>
   
   <body>
      ${Var}
   </body>
</html>‍‍‍‍‍‍‍‍

Par contre mes fichiers se trouve dans :
%TOMCAT%\webapps\alfresco\WEB-INF\classes\alfresco\templates\webscripts\org\alfresco\audit

J'utilise un AMP pour déployer mon WebScript et je ne sais pas si les différents fichiers sont mis au bon endroit.

thomasb

Mes noms de fichiers sont les suivants : simple.get.desc.xml et simple.get.html.ftl donc je ne pense pas que l'erreur soit ici.

OK, très bien.

Par contre mes fichiers se trouve dans :
%TOMCAT%\webapps\alfresco\WEB-INF\classes\alfresco\templates\webscripts\org\alfresco\audit

Ok, donc le nom du bean doit bien être "webscript.org.alfresco.audit.simple.get".

J'utilise un AMP pour déployer mon WebScript et je ne sais pas si les différents fichiers sont mis au bon endroit.

Donc je continue de penser que la déclaration Spring n'est pas lue.
Un moyen simple de tester: mettre une erreur dans le XML (virer un "<" ou ">" quelconque), si Alfresco démarre, c'est qu'il ne lit pas le fichier.
…pourtant avec un AMP, c'est plutôt simple: un "module-context.xml" dans config/alfresco/module/<nom-de-mon-module>/, où <nom-de-mon-module> est le nom indiqué dans "module.id" dans le "module.properties" (c'est une erreur dans le BlankProject.zip qu'on trouve sur share.alfresco.com / community.alfresco.com, module.id indique sdk_blank_project au lieu de blank_project), cf. la doc ici et là

bertrandf

Ok, merci.

Je vais regarder ca et vérifier si mon AMP est bien construit, j'avais pas vu la doc sur le wiki.

Encore merci.

bertrandf

Bon alors quand je modifie le module-content.xml en y enlevant un "<" par exemple, l'alfresco ne se lance pas et il y a plein d'erreurs ce qui signifirait que la déclaration Spring est bien lue.

J'ai revu la structure de mon build.xml en me basant sur le BlankProject et j'obtenais une nouvelle erreur lors de l'appel du WS :

Exception:   org.alfresco.web.scripts.WebScriptException - Web Script format '' is not registered‍

J'ai solutionné mon problème en retirant la ligne :

  <format default="">argument</format>‍

de mon fichier simple.get.desc.xml.

Je vous remercie pour votre aide, mon Hello World marche enfin.
Je vais pouvoir passer au choses sérieuses.

Encore merci à vous 2.

viscere

Bonjour à tous,

Je viens de m'inscrire sur ce forum à l'instant je m'appelle laurent et je découvre alfresco depuis 1 mois à peine. J'ai quelques peines à implémenter mes premiers webscripts alfresco surtout les java backed web scripts.

Pour résumer j'ai le même problème que BertrandF ci dessus sauf que je n'ai pas la ligne <format default="">argument</format> dans mon descripteur xml.

Donc j'ai un fichier compas.post.desc.xml :

<webscript>
   <shortname>POST compas bean</shortname>
   <description>Permet de creer une demande</description>
   <url>/ui/compas/bean/compas</url>
   <authentication>guest</authentication>
    <transaction>requiresnew</transaction>
</webscript>‍‍‍‍‍‍‍

J'ai un retour compas.post.html.ftl tout simple :

<html>
   <body>
   ${mess}
   </body>
</html>‍‍‍‍‍

J'ai ma classe java Compas.java qui implémente la classe DeclarativeWebScript :

public class Compas extends DeclarativeWebScript {



    private ServiceRegistry serviceRegistry;

    @Override
    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status) {
        
        Map<String, Object> model = new HashMap<String, Object>();
        model.put("mess", "Traitement java Compas…");
        return model;

    }

    public void setServiceRegistry(ServiceRegistry serviceRegistry) {
        this.serviceRegistry =serviceRegistry;
    }

}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Je suis sur que ma déclaration spring est correcte puisque je rentre dans le code de la fonction "setServiceRegistry".

Malgré tout ca, l'exécution du webscript ne rentre pas dans la fonction executeImpl puisque j'ai une erreur freemarker.core.InvalidReferenceException: Expression mess is undefined.

Merci d'avance pour votre aide.

Laurent

bertrandf

Bonjour,

Je suis sur que ma déclaration spring est correcte puisque je rentre dans le code de la fonction "setRenodocServiceRegistry".

Ce n'est pas par ce que l'injection du service se fait correctement que votre déclaration est correcte, il est possible que "l'association" de votre classe Java avec les fichiers de votre webscript (desc.xml, .ftl, …) ne se fasse pas correctement et ce car la nomination de l'identifiant de votre bean spring est primordiale.

Serait-il possible que vous nous montriez votre déclaration spring ainsi que le lieu où se trouve votre webscript (l'arborescence dans alfresco) ?

Cordialement.

viscere

Merci pour la réponse.

Alors ma déclaration Spring se trouve dans le fichier compas-scripts-context.xml :

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>

<beans>
   <!– Add aspect custom action –>

   <bean id="webscript.alfresco.extension.templates.webscripts.compas.bean.compas.post" class="fr.service.Compas" parent="webscript">
      <property name="serviceRegistry">
         <ref bean="ServiceRegistry" />
      </property>
   </bean>
</beans>‍‍‍‍‍‍‍‍‍‍‍‍

Pour résumer le webscript se trouve dans le répertoire alfresco/extension/templates/webscripts/compas/bean
Le descripteur ci dessus dans le répertoire alfresco/extension
Ma classe java dans le package fr.service

bertrandf

Pour résumer le webscript se trouve dans le répertoire alfresco/extension/templates/webscripts/compas/bean

Je pense que l'identifiant de votre bean est erroné, essayez avec : webscript.compas.bean.compas.post

<bean id="webscript.compas.bean.compas.post" class="fr.service.Compas" parent="webscript">
…
</bean>
‍‍‍‍

Cordialement.

viscere

Je te remercie cela venait bien de ca!

Merci encore je vais enfin pouvoir rentrer dans le vif du sujet!

A bientôt!

Laurent