{"id":10201,"date":"2025-01-21T21:36:38","date_gmt":"2025-01-21T19:36:38","guid":{"rendered":"https:\/\/u-labs.de\/portal\/?p=10201"},"modified":"2025-01-21T21:36:38","modified_gmt":"2025-01-21T19:36:38","slug":"hcl-cnx-eigener-java-code-spi-events","status":"publish","type":"post","link":"https:\/\/u-labs.de\/portal\/hcl-cnx-eigener-java-code-spi-events\/","title":{"rendered":"Eigenen Java-Code bei HCL Connections Ereignissen ausf\u00fchren mit SPI-Events"},"content":{"rendered":"

HCL Connections l\u00e4sst sich bereits umfangreich konfigurieren und anpassen, etwa \u00fcber die XML-Dateien. Noch weiter geht die SPI-Schnittstelle: Sie erm\u00f6glicht es, Java-Code bei bestimmten Ereignissen auszuf\u00fchren – beispielsweise dem Hochladen einer Datei, wenn neue Mitglieder zu einer Community hinzugef\u00fcgt werden, usw. Damit hat man nahezu grenzenlose Freiheiten, um CNX in andere Systeme zu integrieren.<\/p>\n

So funktionierten SPI-Ereignisse<\/h2>\n

Am Anfang steht eine eigene Java-Klasse, welche die Schnittstelle com.ibm.connections.spi.events.EventHandler<\/code> implementiert. Sie stellt eine Methode handleEvent<\/code> zur Verf\u00fcgung – diese wird beim Eintreten eines Ereignisses zusammen mit einem Event<\/code> Objekt aufgerufen. F\u00fcr den Verweis auf die EventHandler<\/code>-Schnittstelle muss lc.events.spi.jar<\/code> im Java ClassPath liegen. <\/p>\n

In der events-config.xml<\/code> definiert ein Event-Handler, welche Ereignisse eure Anwendung empfangen soll. Au\u00dferdem die Art der Ausf\u00fchrung: Pre-Events k\u00f6nnen Daten ver\u00e4ndern, Post-Events durch ihre asynchrone Ausf\u00fchrung nach dem Ereignis nicht. Aus eurem Code und dem Interface muss eine Jar erzeugt und als gemeinsame Bibliothek in WebSphere hinterlegt werden. Schlussendlich ist es erforderlich, diese in der News-Anwendung zu aktivieren. Nach dessen Neustart l\u00e4uft euer Code.<\/p>\n

Die Ereignisse werden von der News-Anwendung abgearbeitet. S\u00e4mtliche Log-Eintr\u00e4ge aus dem eigenen Code landen daher im InfraCluster (SystemOut.log<\/code>).<\/p>\n

Erzeugen eines Jar-Archives mit eigenem Java-Code<\/h2>\n

Zur Demonstration habe ich eine simple Klasse AuditHandler<\/code> (Paket classes<\/code>) als Post-EventHandler entwickelt. Sie reagiert auf neu hochgeladene Dateien (Ereignis files.file.created<\/code>) und schreibt uns dazu Informationen (Nutzername, ID von Datei\/Bibliothek, Dateiname, Pfad im Dateisystem, Mime-Type) in das Log des InfraCluster. Wenn man nur auf bestimmte Ereignisse reagieren m\u00f6chte, k\u00f6nnen diese in der events-config.xml<\/code> angegeben werden. Die Filterung hier dient als Beispiel zur Demonstration, da man ggf. mehrere abonniert und im Code differenzieren muss.<\/p>\n

package classes;\n\nimport com.ibm.connections.spi.events.EventHandler;\nimport com.ibm.connections.spi.events.EventHandlerException;\nimport com.ibm.connections.spi.events.EventHandlerInitException;\nimport com.ibm.connections.spi.events.object.Attachment;\nimport com.ibm.connections.spi.events.object.Event;\nimport java.io.IOException;\nimport java.io.Serializable;\n\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\npublic class AuditHandler implements EventHandler, Serializable {\n  private static Logger log = Logger.getLogger("AuditHandler");\n\n  public void destroy() {\n    log.info("Destroy MailFileHandler");\n  }\n  \n  public void init() throws EventHandlerInitException {\n    log.info("START init with java " + System.getProperty("java.version"));\n  }\n  \n  public void handleEvent(Event event) throws EventHandlerException {\n    String fileId = event.getItem().getID();\n    String libraryId = event.getContainer().getID();\n    String appName = event.getSource().getName();\n    Object eventType = event.getType(); \/\/ CREATE\n    String actorUserId = event.getActor().getExtID();\n    String actorDisplayName = event.getActor().getDisplayName();\n\n    if(event.getName().equals("files.file.created")) {\n        log.info("Handling SPI event: " + event.getName() + " from app " + appName);\n        System.out.println("  Actor Id: " + actorUserId);\n        System.out.println("  DisplayName: " + actorDisplayName);\n        System.out.println("  FileId: " + fileId);\n        System.out.println("  FileLibId: " + libraryId);\n\n        if (event.getAttachmentData() == null || event.getAttachmentData().getAdded().isEmpty()) {\n          log.warning("No attachment data available for the event. Cannot retrieve old filename or file system location.");\n          return;\n        }\n\n        Attachment attachment = event.getAttachmentData().getAdded().iterator().next();\n        System.out.println("Attachment object");\n        System.out.println(attachment.getFileName());\n        System.out.println(attachment.getFileSystemLocation());\n        System.out.println(attachment.getContentType());\n      }else {\n        System.out.println("Skipping SPI-Event: " + event.getName());\n      }\n  }\n}<\/code><\/pre>\n
Damit aus diesem Code eine Jar-Datei gebaut werden kann, ist die anfangs erw\u00e4hnte lc.events.spi.jar<\/code> Bibliothek notwendig. Ihr findet sie im entpackten Ear-Ordner jeder CNX-Anwendung: Blogs, Wikis, Dateien, usw.1<\/a><\/sup> Es spielt keine Rolle, aus welcher die Jar kopiert wird.<\/p>\n
find \/opt -name lc.events.spi.jar\n\/opt\/IBM\/WebSphere\/AppServer\/profiles\/CnxNode01\/installedApps\/CnxCell\/Blogs.ear\/lc.events.spi.jar\n\/opt\/IBM\/WebSphere\/AppServer\/profiles\/CnxNode01\/installedApps\/CnxCell\/Activities.ear\/lc.events.spi.jar\n\/opt\/IBM\/WebSphere\/AppServer\/profiles\/CnxNode01\/installedApps\/CnxCell\/Files.ear\/lc.events.spi.jar\n...<\/code><\/pre>\n
Java ben\u00f6tigt eine MANIFEST.MF Datei f\u00fcr Jars mit Angabe des Einstiegspunktes sowie der externen Bibliothek, damit diese im ClassPath verf\u00fcgbar ist:<\/p>\n
Manifest-Version: 1.0\nClass-Path: lc.events.spi.jar\nMain-Class: classes.AuditHandler\n<\/code><\/pre>\n
Zum bauen wird ein JDK ben\u00f6tigt, und zwar ein altes JDK 8. Das verwenden CNX\/WAS – diese k\u00f6nnen euren Code nicht laden, wenn dessen Jar mit einer neueren Version gebaut wurde. OpenJDK jdk8u362-b09 hat in meinem Test funktioniert. Folgender Aufruf geht davon aus, dass AuditHandler.java<\/code> im Ordner classes<\/code> liegt, lc.events.spi.jar <\/code>auf der aktuellen Ebene.<\/p>\n
jar cfm AuditHandler.jar MANIFEST.MF "classes\/*.class"\njar uf AuditHandler.jar lc.events.spi.jar<\/code><\/pre>\n
Es macht Sinn, dies f\u00fcr die Entwicklung in einem Skript durchzuf\u00fchren. Insbesondere, wenn das verwendete JDK nicht global in $PATH<\/code> liegt. Dort k\u00f6nnen auch die erzeugten Class-Dateien bereinigt werden – so liegt bei jeder Ausf\u00fchrung ein sauberer Build vor.<\/p>\n
#!\/bin\/bash\nrm "classes\/*.class"\n\nset -e \nset -o pipefail\nPATH=$PATH:~\/jdk8u362-b09\/bin\n\njavac -cp .\/FILES_lc.events.spi.jar "classes\/*.java"\nrm AuditHandler.jar\njar cfm AuditHandler.jar MANIFEST.MF "classes\/*.class"\njar uf AuditHandler.jar lc.events.spi.jar<\/code><\/pre>\n
Anlegen des Event-Handlers in CNX<\/h2>\n
In events-config.xml<\/code> im Knoten <postHandlers><\/code> eure Klasse registrieren:<\/p>\n
<postHandler class="classes.AuditHandler" enabled="true" invoke="ASYNC" name="AuditHandler">\n    <subscriptions>\n       <subscription eventName="*" source="FILES" type="*"\/>\n    <\/subscriptions>\n<\/postHandler><\/code><\/pre>\n
Dieses Beispiel registriert sich f\u00fcr alle Ereignisse der Files-Anwendung. Beides l\u00e4sst sich filtern bzw. erweitern, eine Liste aller unterst\u00fctzten Anwendungen & Ereignisse ist in der API Dokumentation zu finden.2<\/a><\/sup> Nach dem \u00c4ndern der Datei auf dem Deployment-Manager muss in der ISC ein sync durchgef\u00fchrt und CNX neu gestartet werden.<\/p>\n
Registrieren der Jar in WebSphere<\/h2>\n
Legt einen neuen Ordner an, der f\u00fcr alle WAS-Nodes verf\u00fcgbar ist – z.B. im shared directory. Der Pfad ist frei w\u00e4hlbar, so lange der WAS-Node darauf zugreifen kann (oder eben die Nodes). In diesen Ordner wird die erzeugte AuditHandler.jar<\/code> kopiert.<\/p>\n
In der ISC unter Environment > Shared libraries<\/strong> einen neuen Eintrag mit dem Scope cells an, bei dem dieser Pfad zur Jar-Datei eingef\u00fcgt wird. Im Falle von Abh\u00e4ngigkeiten muss deren Pfad in eine neue Zeile. Hierf\u00fcr kann eine WAS-Variable (Environment > WebSphere variables<\/strong>) angelegt und im Classpath-Feld im Format ${Varname}<\/code> verwendet werden. <\/p>\n
\n
\"\"<\/a><\/figure>\n<\/div>\n
EventHandler in der News-Anwendung aktivieren<\/h2>\n
Damit die Jar aufgerufen wird, muss sie in der ISC unter Applications > Application Types > WebSphere enterprise applications<\/strong> in der News<\/strong> Anwendung bei Shared library references<\/strong> aktiviert werden.<\/p>\n
\n
\"\"<\/a><\/figure>\n<\/div>\n
Hat die vorherige Registrierung funktioniert (Neustart), taucht in der Liste Available<\/em> nun der AuditHandler<\/strong> auf. Durch anklicken und Pfeil nach Rechts wird er aktiviert. <\/p>\n
\n
\"\"<\/a><\/figure>\n<\/div>\n
Nach dem Neustart der News<\/strong> Anwendung sieht man in SystemOut.log die Informationen, welche \u00fcber das Ereigniss \u00fcbermittelt werden:<\/p>\n
\n
\"\"<\/a><\/figure>\n<\/div>\n
Es stehen weitere zur Verf\u00fcgung. Die Events Reference<\/em> Dokumentation listet diese ausf\u00fchrlich auf.3<\/a><\/sup><\/p>\n
\n
\"\"<\/a><\/figure>\n<\/div>\n
Weitere Informationen<\/h2>\n
\u00dcber Properties ist es anscheinend m\u00f6glich, dem Event Parameter mitzugeben. Ich habe das als Codeschnipsel wo kopiert, eine M\u00f6glichkeit zum Auslesen im Java-Code fehlt. Ist eventuell ein n\u00fctzlicher Ansatz, falls man das braucht. <\/p>\n
<postHandler class="classes.AuditHandler" enabled="true" invoke="ASYNC" name="AuditHandler">\n    <subscriptions>\n       <subscription eventName="*" source="FILES" type="*"\/>\n    <\/subscriptions>\n    <properties>\n       <property name="foo">bar<\/property>\n    <\/properties>\n<\/postHandler><\/code><\/pre>\n
Quellen\/Dokumentation<\/h2>\n
    \n
  1. https:\/\/ds_infolib.hcltechsw.com\/ldd\/lcwiki.nsf\/xpAPIViewer.xsp?lookupName=HCL+Connections+7.0+API+Documentation#action=openDocument&res_title=Programming_an_event_handler_70&content=apicontent \u21a9\ufe0e<\/a><\/li>\n
  2. https:\/\/ds_infolib.hcltechsw.com\/ldd\/lcwiki.nsf\/xpAPIViewer.xsp?lookupName=HCL+Connections+7.0+API+Documentation#action=openDocument&res_title=Deploying_an_event_handler_70&content=apicontent \u21a9\ufe0e<\/a><\/li>\n
  3. https:\/\/ds_infolib.hcltechsw.com\/ldd\/lcwiki.nsf\/xpAPIViewer.xsp?lookupName=HCL+Connections+7.0+API+Documentation#action=openDocument&res_title=HCL_Connections_Event_Reference_-_Files_70&content=apicontent \u21a9\ufe0e<\/a><\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    HCL Connections l\u00e4sst sich bereits umfangreich konfigurieren und anpassen, etwa \u00fcber die XML-Dateien. Noch weiter geht die SPI-Schnittstelle: Sie erm\u00f6glicht es, Java-Code bei bestimmten Ereignissen auszuf\u00fchren – beispielsweise dem Hochladen einer Datei, wenn neue Mitglieder zu einer Community hinzugef\u00fcgt werden, usw. Damit hat man nahezu grenzenlose Freiheiten, um CNX in andere Systeme zu integrieren. So …<\/p>\n","protected":false},"author":5,"featured_media":14505,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":"[{\"content\":\"https:\/\/ds_infolib.hcltechsw.com\/ldd\/lcwiki.nsf\/xpAPIViewer.xsp?lookupName=HCL+Connections+7.0+API+Documentation#action=openDocument&res_title=Programming_an_event_handler_70&content=apicontent\",\"id\":\"bcb2c51c-e47e-4a71-923e-e99b61982384\"},{\"content\":\"https:\/\/ds_infolib.hcltechsw.com\/ldd\/lcwiki.nsf\/xpAPIViewer.xsp?lookupName=HCL+Connections+7.0+API+Documentation#action=openDocument&res_title=Deploying_an_event_handler_70&content=apicontent\",\"id\":\"0e6224ba-54be-4eec-ba6f-f3cd29ecf425\"},{\"content\":\"https:\/\/ds_infolib.hcltechsw.com\/ldd\/lcwiki.nsf\/xpAPIViewer.xsp?lookupName=HCL+Connections+7.0+API+Documentation#action=openDocument&res_title=HCL_Connections_Event_Reference_-_Files_70&content=apicontent\",\"id\":\"f8429c83-9525-4883-a4a8-2542618999d0\"}]"},"categories":[765],"tags":[760],"class_list":["post-10201","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-hcl-connections","tag-hcl-connections"],"_links":{"self":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/10201","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/comments?post=10201"}],"version-history":[{"count":24,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/10201\/revisions"}],"predecessor-version":[{"id":14507,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/10201\/revisions\/14507"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/media\/14505"}],"wp:attachment":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/media?parent=10201"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/categories?post=10201"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/tags?post=10201"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}