Configurazione uscite API

Un'uscita API è un modulo di codice, un file .dll, che viene fornito dall'utente e viene eseguito immediatamente prima o dopo le chiamate MQI.

Informazioni su questa attività

Quando IBM® MQ riceve una chiamata da un programma a uno dei suoi punti di ingresso API, IBM MQ richiama l'uscita API. L'uscita API viene eseguita prima o dopo l'esecuzione di MQI, in base a come è stata configurata l'uscita.

È possibile configurare una o più uscite (o anche nessuna) da richiamare ed è possibile configurare anche la sequenza in cui verranno richiamate. Su Windows e Linux® (piattaforme x86 e x86-64), è possibile configurare le uscite API utilizzando IBM MQ Explorer. I dettagli di configurazione vengono memorizzati nei file .ini.

  1. Configurare un'uscita API in IBM MQ Explorer.
  2. Sovrascrivere un'uscita API comune con un'uscita API locale.
Esistono tre tipi di definizioni di uscite API:
Comune (ApiExitCommon)
Una serie di definizioni per computer. Quando viene avviato il gestore code, le uscite API definite, se presenti, vengono lette e applicate al gestore code. Configurare le uscite API comuni nella finestra di dialogo delle proprietà di IBM MQ. Le uscite comuni sono visualizzate nella tabella Uscite API locali nella finestra delle proprietà di ciascun gestore code locale.
Modello (ApiExitTemplate)
Una serie di definizioni per computer. Quando viene creato un gestore code, le uscite API definite, se presenti, vengono copiate sul gestore code appena creato come uscite locali. Configurare le uscite API modello nella finestra di dialogo delle proprietà di IBM MQ.
Locali (ApiExitLocal)
Una serie di definizioni per gestore code. Quando viene avviato il gestore code, le eventuali uscite API definite sovrascrivono le uscite comuni se gli attributi Nome sono gli stessi e se è stata specificata l'opzione di sovrascrittura. Quando un'uscita API comune viene sovrascritta, nessuno dei campi nella definizione comune viene salvato, anche se all'attributo facoltativo Dati è stato assegnato un valore. Configurare le uscite API locali nella finestra delle proprietà del gestore code.
Quando si configurano le uscite API nelle finestre di dialogo delle proprietà IBM MQ e del gestore code, i valori degli attributi vengono aggiunti alle stanze ApiExitCommon, ApiExitTemplate e ApiExitLocal nei file di configurazione o nel registro Windows.
Tabella 1. Attributi delle uscite API
Attributo Significato Chiave stanza
Nome Specifica il nome descrittivo dell'uscita API inviato all'uscita API nel campo ExitInfoName della struttura MQAXP. Questo nome deve essere univoco, ha una lunghezza massima di 48 caratteri e deve contenere solo i caratteri validi per il nome degli oggetti IBM MQ, quali i nomi coda. Nome
Tipo Specifica il tipo di uscita: common, template, local o override. (Non una chiave della stanza separata)
Sequenza Questo attributo è un valore numerico non formato che definisce la sequenza con cui questa uscita API è chiamata a confronto con le altre uscite API. Un'uscita API con un numero di sequenza basso viene richiamata prima di un'uscita con un numero di sequenza maggiore. L'ordine in cui le diverse uscite API con lo stesso numero di sequenza vengono richiamate non è definito. Questo è il valore perfetto per cui esistono dei divari nei numero di sequenza delle uscite API definite per un gestore code. Sequenza
Modulo Specifica il modulo che contiene il codice per l'uscita API. Se questo campo contiene il percorso completo del modulo, questo verrà visualizzato così come è. Se questo campo contiene solo il nome del modulo, il modulo viene individuato utilizzando lo stesso metodo delle uscite dei canali, ovvero utilizzando il valore nel campo Percorso predefinito uscita nella pagina Uscite della finestra delle proprietà del gestore code. Modulo
Funzione Specifica il punto di ingresso della funzione nel modulo che contiene il codice per l'uscita API. Questo punto di ingresso è la funzione MQ_INIT_EXIT. La lunghezza di questo campo è limitata a MQ_EXIT_NAME_LENGTH. Funzione
Dati Se viene specificato questo attributo, gli spazi all'inizio e alla fine della riga vengono rimossi, la stringa rimanente viene troncata a 32 caratteri e il risultato viene inviato all'uscita nel campo ExitData della struttura MQAXP. Se invece l'attributo non viene specificato, il valore predefinito di 32 caratteri viene inviato all'uscita nel campo ExitData della struttura MQAXP. Dati

Procedura

  • [ OPZIONE 1] Configurare un'uscita API in IBM MQ Explorer.
    1. Aprire la finestra delle proprietà:
    2. Nella pagina Uscite , fare clic su Aggiungi .... Viene aperta la finestra Inserisci uscita API.
    3. Immettere le informazioni richieste nei campi della finestra di dialogo Aggiungi uscita API .
    4. Fare clic su OK per creare l'uscita e chiudere la finestra di dialogo Aggiungi uscita API .
    Le proprietà della nuova uscita API vengono visualizzate nella tabella nella pagina Uscite.
  • [OPZIONE 2] Sovrascrivere un'uscita comune API con un'uscita API locale.

    Quando una uscita API locale viene definita su un gestore code con lo stesso nome di una uscita comune, l'uscita comune viene sovrascritta. In altre parole, l'uscita comune non viene richiamata e viene richiamata l'uscita locale. Per evitare una sovrascrittura accidentale, l'interfaccia utente consente di intraprendere determinate azioni per configurare una sovrascrittura; ad esempio, non è possibile aggiungere una nuova uscita che ha lo stesso nome di un'uscita esistente e non è possibile modificare il nome di un'uscita cambiandone il nome e specificando il nome di un'uscita esistente. Tuttavia, è possibile aggiungere un'uscita API locale a un gestore code in modo che non venga utilizzata l'uscita API comune, bensì l'uscita API locale. In questo caso, è necessario sovrascrivere l'uscita API comune con l'uscita API locale.

    1. Aprire la pagina Uscite della finestra delle proprietà del gestore code.
    2. Fare clic sull'uscita comune che si desidera sovrascrivere nella tabella Uscite API locali .
    3. Fare clic su Sovrascrivi.
      Si aprirà la finestra Modifica uscita API, nella quale verrà visualizzato il nome dell'uscita API comune.
    4. Immettere i dettagli dell'uscita API locale nella finestra di dialogo Modifica uscita API e fare clic su OK per salvare le modifiche.
    La nuova uscita locale sovrascriverà l'uscita comune che ha lo stesso nome.