Come creare un callout Java

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

Che cos'è un callout Java?

Apigee offre una gamma di criteri che soddisfano i requisiti più comuni di gestione delle API, come come sicurezza, trasformazione dei dati, gestione del traffico e altro.

Tuttavia, in alcuni casi l'API richiede un comportamento personalizzato che non è implementato in un criterio standard. In questi casi, Apigee offre diverse opzioni che consentono di creare script un comportamento personalizzato dell'API. Un approccio consiste nell'implementare il comportamento desiderato in Java.

Le versioni di Java supportate includono: Oracle JDK 11 e OpenJDK 11.

Come faccio a utilizzare il codice Java in un proxy?

Un criterio di callout Java consente di richiamare il codice Java dall'interno di un flusso proxy in esecuzione. Il tuo codice Java il codice deve implementare determinate interfacce Java specifiche di Apigee che gli consentano di interagire con il proxy in esecuzione. Ad esempio, esistono metodi Java per ottenere e impostare intestazioni, parametri, variabili di flusso e altre entità nel contesto di flusso corrente del proxy.

Quando devo utilizzare un callout Java?

Diamo un'occhiata a situazioni in cui i callout Java sono utili e a situazioni in cui prendi in considerazione altri approcci.

Innanzitutto, considera approcci alternativi

Prima di utilizzare un callout Java, tieni presente che potrebbero essere disponibili approcci alternativi . Ad esempio:

  • Per operazioni leggere, come le chiamate API HTTP a servizi remoti, valuta la possibilità di utilizzare ServiceCallout. Consulta le norme relative ai callout di servizio.
  • Per interazioni relativamente semplici con il contenuto dei messaggi, come la modifica o l'estrazione Intestazioni HTTP, parametri o contenuto dei messaggi, puoi utilizzare JavaScript oppure PythonScript.

Cosa puoi fare nel codice Java

Un callout Java supporta le seguenti operazioni di base:

  • Esame o manipolazione dei messaggi di richiesta o di risposta
  • Recupero e impostazione delle variabili di flusso. Puoi utilizzare metodi Java per accedere alle variabili di flusso Apigee. Se vuoi accedere alle informazioni della mappa chiave-valore (KVM), utilizza un criterio KVM, assegnare valori KVM alle variabili di flusso, dopodiché potrai accedere alle variabili di flusso nel callout Java.
  • Chiamata a servizi esterni
  • Aumento dei guasti
  • Manipolazione di messaggi di errore e codici di stato

Cosa non puoi fare in Java codice

La maggior parte delle chiamate di sistema non è consentita. Non è possibile:

  • Consente di eseguire operazioni di lettura o scrittura del file system interno. Ciò significa che non puoi utilizzare pacchetti Java per la lettura/scrittura nei file system interni; tuttavia, puoi rendere disponibili chiamate remote.
  • Ottieni informazioni sul processo attuale, sull'elenco di processi o sull'utilizzo di CPU/memoria su della macchina.
  • Accedi al codice sorgente in expressions-1.0.0.jar e message-flow-1.0.0.jar.

Sebbene alcune chiamate di questo tipo possano funzionare, non sono supportate e potrebbero essere disattivate attivamente in qualsiasi momento. Evita di effettuare chiamate di questo tipo nel codice.

Non utilizzare o fare affidamento sulle librerie Java incluse in Apigee. Queste biblioteche sono solo per le funzionalità del prodotto Apigee e non vi è alcuna garanzia che sia disponibile una libreria dalla release all'uscita. Se usi tali librerie, usale in dimostrazioni non di produzione. .

Ciao callout Java

Vediamo un esempio di callout Java di base Hello World. In questo esempio, creiamo proxy semplice con un callout Java che restituisce "hello world" risposta. Il proxy può restituire uno di due possibili risposte:

  • Se passi in un "nome utente" intestazione con un "nome" , il proxy restituisce:

    Hello, <name>!
  • Se ometti l'intestazione, il proxy restituisce semplicemente:

    "Hello, Guest!"

Scarica il progetto iniziale

Per semplificare le cose, abbiamo preparato un progetto di base su GitHub nella piattaforma Apigee api-platform-samples.

  1. Scarica o clona api-platform-samples nel tuo sistema. Se hai già api-platform-samples sul tuo sistema, esegui un pull per assicurarti hai l'ultima versione.
  2. In un terminale o in un editor di codice a tua scelta, vai alla Progetto api-platform-samples/doc-samples/java-hello.

Scrivi il codice Java

  1. Apri il file di origine Java: java-hello/callout/src/main/java/HelloJava.java. Questo file è una versione scheletro della classe Java principale che implementeremo. Il valore per il codice callout Java di Apigee sono richiesti pacchetti. Questi corsi offrono metodi che ti consentono per accedere al contesto di esecuzione del proxy. Vedremo in dettaglio i passaggi per la compilazione e il deployment questo codice a breve.
    package com.apigeesample;

import com.apigee.flow.execution.ExecutionContext;
import com.apigee.flow.execution.ExecutionResult;
import com.apigee.flow.execution.spi.Execution;
import com.apigee.flow.message.MessageContext;


public class HelloJava implements Execution {

        public ExecutionResult execute(MessageContext messageContext, ExecutionContext executionContext) {

                try {

                        // Your code here.

            return ExecutionResult.SUCCESS;

                } catch (Exception e) {
                        return ExecutionResult.ABORT;
                }
        }

}
  2. Sostituisci la riga commentata // Your code here con il seguente codice:

    String name = messageContext.getMessage().getHeader("username");

if (name != null && name.length()>0) {
        messageContext.getMessage().setContent("Hello, " + name + "!");
        messageContext.getMessage().removeHeader("username");
} else {
        messageContext.getMessage().setContent("Hello, Guest!");
}
  3. Salva il file.


Compila il codice con Maven

  1. Assicurati che Maven sia installato:

    mvn -version
  2. Installa le dipendenze JAR richieste nel repository Maven locale utilizzando uno dei seguenti metodi:
    • Aggiungi il seguente snippet al file pom.xml per scaricare le dipendenze JAR richieste da Artifact Registry: 
      <repositories>
  <repository>
    <id>artifact-registry</id>
    <url>https://us-maven.pkg.dev/apigee-release/apigee-java-callout-dependencies</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>com.apigee.gateway.libraries</groupId>
    <artifactId>message-flow</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
    <type>jar</type>
  </dependency>
  <dependency>
    <groupId>com.apigee.infra.libraries</groupId>
    <artifactId>expressions</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
    <type>jar</type>
  </dependency>
</dependencies>
    • Usa le seguenti chiamate curl per scaricare le dipendenze JAR richieste da Artifact Registry: 
      curl "https://us-maven.pkg.dev/apigee-release/apigee-java-callout-dependencies/com/apigee/gateway/libraries/message-flow/1.0.0/message-flow-1.0.0.jar" -v -L -o message-flow-1.0-0.jar
        
      curl "https://us-maven.pkg.dev/apigee-release/apigee-java-callout-dependencies/com/apigee/infra/libraries/expressions/1.0.0/expressions-1.0.0.jar" -v -L -o expressions-1.0.0.jar
    • Esegui lo script java-hello/buildsetup.sh. Questo script scarica il JAR richiesto dal repository GitHub di Apigee.
  3. cd alla directory java-hello/callout.
  4. Esegui Maven:

    mvn clean package
  5. Se vuoi, verifica che il file JAR edge-custom-policy-java-hello.jar sia stato copiato in java-hello/apiproxy/resources/java. Questa è la posizione obbligatoria per File JAR di cui vuoi eseguire il deployment con un proxy.

Esegui il deployment e chiama il proxy

Per eseguire il deployment e testare il proxy API, segui questi passaggi:

  1. Passa alla directory java-hello.
  2. Comprimi il bundle proxy API: 
    zip apiproxy-bundle.zip -r apiproxy -x \*.\*~
  3. Il modo più semplice per eseguire il deployment del proxy è raggrupparlo in un file ZIP e caricarlo in un ambiente nella tua organizzazione Apigee. Consulta la sezione Creazione di un proxy API. Assicurati di utilizzare l'opzione Carica bundle proxy. Vedi anche Suggerimenti utili per caricare proxy API in un bundle proxy nella community Apigee.
  4. Al termine del deployment del proxy, prova a chiamarlo:
    curl  https://$HOSTNAME/java-hello -H "username:Will"

    che restituisce "Hello, Will!

Informazioni sul proxy

Esaminiamo rapidamente i criteri utilizzati in questo proxy. Fai attenzione a dove si trovano le norme. posizionati nel flusso proxy e perché.

Il criterio Assegna messaggio

Un criterio Assegna messaggio è collegato al flusso di richiesta ProxyEndpoint. it copia l'intestazione del nome utente dalla richiesta e la assegna alla risposta. Questa operazione consente il criterio callout Java, collegato al flusso di risposta, per accedere all'intestazione del nome utente e creare un corpo della risposta personalizzata utilizzando il valore dell'intestazione.

<AssignMessage async="false" continueOnError="false" enabled="true" name="CopyHeader">
    <DisplayName>CopyHeader</DisplayName>
    <Copy source="request">
        <Headers>
          <Header name="username"/>
        </Headers>
    </Copy>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

Norme relative ai callout Java

Il criterio di callout Java è collegato al flusso di risposta. Questo perché il codice Java personalizzato modifica le intestazioni e il messaggio della risposta. La classe ClassName del criterio specifica la classe principale eseguita dal criterio. L'elemento ResourceURL è del file JAR che hai creato e aggiunto alla directory resources/java del proxy.

<JavaCallout name="hello-java">
    <ClassName>com.apigeesample.HelloJava</ClassName>
    <ResourceURL>java://edge-custom-policy-java-hello.jar</ResourceURL>
</JavaCallout>

Cosa devi sapere sul callout Java

Di seguito sono riportati alcuni aspetti importanti da considerare sull'implementazione di un callout Java:

  • Importa classi da com.apigee.flow.execution e com.apigee.flow.message di pacchetti. Questi pacchetti devono essere inclusi nel file JAR pacchettizzato e distribuito. Puoi caricare il JAR Java tramite il proxy dell'interfaccia utente di gestione oppure puoi includerlo nella directory /resources/java nei proxy API che che sviluppi localmente.
  • Implementa l'interfaccia di esecuzione. Qualsiasi codice Java eseguito all'interno di un proxy API deve implementare l'esecuzione.
  • Un criterio callout Java non contiene codice effettivo. Un criterio callout Java fa invece riferimento a un La risorsa Java "resource", che deve essere pacchettizzata in un JAR.
  • Nomi dei pacchetti da evitare: non utilizzare io.apigee o com.apigee come nomi di pacchetto nei callout Java. Questi sono riservati e utilizzati da altri moduli Apigee.
  • Se il callout Java si basa su librerie di terze parti aggiuntive pacchettizzate come JAR indipendenti quindi posiziona i file JAR nella directory /resources/java per per assicurarti che vengano caricati correttamente in fase di runtime.
  • Se esistono più JAR, è sufficiente aggiungerli come risorse aggiuntive. Non è necessario modificare la configurazione dei criteri per fare riferimento a file JAR aggiuntivi. Inserendo /resources/java è sufficiente.
  • Per ulteriori informazioni sul caricamento di JAR Java, consulta File di risorse.