Questo argomento si applica solo alla configurazione IBM Business Automation Workflow Advanced.

Creazione di gestori eventi API per Business Process Choreographer

Modifica in linea

Un evento API si verifica quando un metodo API modifica un'attività umana. Utilizzare la SPI (service provider interface) del plug-in del gestore eventi API per creare plug-in per gestire gli eventi di attività inviati dall'API o gli eventi interni che hanno eventi API equivalenti.

Informazioni su questa attività

Completa la seguente procedura per creare un gestore eventi API.

Procedura

  1. Scrivere una classe che implementa la classe di implementazione APIEventHandlerPlugin5 o estende la classe di implementazione APIEventHandler .
    Questa classe può richiamare i metodi di altre classi.
    • Se si utilizza l'interfaccia APIEventHandlerPlugin5, occorre implementare tutti i metodi dell'interfaccia APIEventHandlerPlugin5 e dell'interfaccia APIEventHandlerPlugin.
    • Se si estende la classe di implementazione APIEventHandler , sovrascrivere i metodi necessari.

    Questa classe viene eseguita nel contesto di un'applicazione enterprise Java™ Platform, Enterprise Edition (Java EE). Assicurarsi che questa classe e le relative classi helper seguano la specifica EJB.

    Nota: se si desidera chiamare l'interfaccia HumanTaskManagerService da questa classe, non chiamare un metodo che aggiorna l'attività che ha prodotto l'evento. Questa azione potrebbe risultare in dati di attività incongruenti nel database.
  2. Assemblare la classe del plug-in e le relative classi helper in un file JAR
    È possibile rendere il file JAR disponibile in uno dei seguenti modi:
    • Come file JAR di utilità nel file EAR dell'applicazione.
    • Come una libreria condivisa installata con il file EAR dell'applicazione.
    • Come libreria condivisa installata con l'applicazione TaskContainer . In questo caso, il plugin è disponibile per tutte le attività.
  3. Creare un file di configurazione del provider del servizio per il plug-in nella directory META-INF/services/ del file JAR.

    Il file di configurazione fornisce il meccanismo per identificare e caricare il plugin. Questo file è conforme alla specifica dell'interfaccia del fornitore di servizi Java EE .

    1. Creare un file con il nome com.ibm.task.spi.plug-in_nameAPIEventHandlerPlugin, dove nome_plug - in è il nome del plug - in.

      Ad esempio, se il plug-in viene chiamato Customer e implementa l'interfaccia com.ibm.task.spi.APIEventHandlerPlugin5 , il nome del file di configurazione è com.ibm.task.spi.CustomerAPIEventHandlerPlugin.

    2. Nella prima riga del file che non è né una riga di commento (una riga che inizia con un cancelletto (#)) né una riga vuota, specificare il nome completo della classe plug-in creata nel passo 1.

      Ad esempio, se la classe del plugin è denominata MyAPIEventHandler e si trova nel package com.customer.plugins , la prima riga del file di configurazione deve contenere la seguente voce: com.customer.plugins.MyAPIEventHandler.

Risultati

Si dispone di un file JAR installabili che contiene un plug - in che gestisce gli eventi API e un file di configurazione del fornitore di servizio che può essere utilizzato per caricare il plug - in.
Note: È disponibile una sola proprietà eventHandlerName per registrare sia i gestori di eventi API che i gestori di eventi di notifica. Se si desidera utilizzare sia un gestore eventi API che un gestore eventi di notifica, le implementazioni del plug-in devono avere lo stesso nome, ad esempio, Customer come nome del gestore eventi per l'implementazione SPI.

È possibile implementare entrambi i plug-in utilizzando una singola classe o due classi separate. In entrambi i casi, è necessario creare due file nella directory META-INF/services/ del file JAR, ad esempio com.ibm.task.spi.CustomerNotificationEventHandlerPlugin e com.ibm.task.spi.CustomerAPIEventHandlerPlugin.

Comprimere l'implementazione del plug-in e le classi helper in un singolo file JAR.

Per rendere effettiva una modifica ad un'implementazione, sostituire il file JAR nella libreria condivisa e riavviare il server. Se il plug-in fa parte del file EAR dell'applicazione, è sufficiente reinstallare l'applicazione aggiornata.

Cosa fare successivamente

Ora è necessario installare e registrare il plug-in in modo che sia disponibile per il contenitore di attività umane in fase di runtime. È possibile registrare i gestori eventi API con un'istanza di attività, un modello di attività o un componente dell'applicazione.