Преобразуйте ответ в верхний регистр с помощью вызова Java

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Если вы впервые используете вызовы функций Java, мы рекомендуем начать с руководства «Как создать вызов функции Java» .

В этом примере из руководства показано, как создать простую политику JavaCallout , которая выполняет пользовательский код Java в контексте прокси-потока.

Что делает приведенный пример кода?

В этом примере API-прокси вызывает целевой сервис, который возвращает простой JSON-ответ. Политика Java Callout применяется к потоку ответа целевого сервиса. Java-код преобразует заголовки и содержимое ответа в верхний регистр. Это простой пример, однако он иллюстрирует, как заставить работать пользовательский Java-код в контексте API-прокси на Edge.

Попробуйте образец

Скачать проект

Для упрощения процесса вы можете загрузить этот проект из репозитория Apigee api-platform-samples на GitHub.

  1. Загрузите или клонируйте репозиторий api-platform-samples на свой компьютер.
  2. В терминале или любом другом редакторе кода перейдите в проект api-platform-samples/doc-samples/java-cookbook .

Компилируйте свой код с помощью Maven.

Проект настроен таким образом, что вы можете скомпилировать его с помощью Maven. Если вы хотите использовать javac , мы также включим пример, следующий за примером Maven.

  1. Убедитесь, что у вас установлен Maven: 
    mvn -version
  2. Выполните скрипт java-cookbook/buildsetup.sh . Этот скрипт устанавливает необходимые JAR-зависимости в ваш локальный репозиторий Maven.
  3. Перейдите в каталог java-cookbool/callout .
  4. Выполнить Maven: 
    mvn clean package
  5. При желании убедитесь, что JAR-файл edge-custom-policy-java-cookbook.jar был скопирован в java-cookbook/apiproxy/resources/java . Это обязательное местоположение для JAR-файлов, которые вы хотите развернуть с помощью прокси.

Компилируйте с помощью javac

Если вы хотите использовать javac для компиляции кода, вы можете сделать что-то подобное следующему (из каталога java-cookbook ). Необходимые JAR-файлы находятся в каталоге java-cookbook/lib .

  1. Перейдите в каталог api-platform-samples/doc-samples/java-cookbook .
  2. Убедитесь, что javac добавлен в переменную PATH. 

    javac -version
  3. Выполните следующую команду javac: 

    javac -d . -classpath ./lib/expressions-1.0.0.jar:./lib/message-flow-1.0.0.jar:. callout/src/main/java/ResponseUppercase.java
  4. Скопируйте JAR-файл в каталог apiproxy/resources/java. Это обязательное место для размещения JAR-файлов, которые вы хотите развернуть с помощью прокси-сервера. 

    cp com/apigeesample/ResponseUppercase.class apiproxy/resources/java

Разверните и вызовите прокси-сервер.

Скрипт развертывания находится в каталоге ./java-cookbook . Но перед его запуском необходимо выполнить быструю настройку.

  1. Перейдите в каталог api-platform-samples/doc-samples/java-cookbook
  2. Если вы еще этого не сделали, откройте файл ../../setup/setenv.sh и отредактируйте его, указав информацию о вашей учетной записи Apigee: ваше имя пользователя (адрес электронной почты, связанный с вашей учетной записью), название вашей организации и домен, который вы используете для выполнения вызовов управления API. Например, для облака Edge домен — https://api.enterprise.apigee.com ; однако ваш домен может отличаться, если вы используете частное облако Edge.
  3. Сохраните файл setenv.sh .
  4. Выполните скрипт развертывания: 
    ./deploy.sh
  5. Если развертывание пройдет успешно, выполните скрипт вызова:
    ./invoke.sh

    Скрипт invoke вызывает команду cURL, которая выглядит следующим образом:

    curl  http://$org-$env.$api_domain/java-cookbook/json

Ответ выглядит примерно так:

< HTTP/1.1 200 OK
< Date: Tue, 09 May 2017 20:31:08 GMT
< Content-Type: APPLICATION/JSON; CHARSET=UTF-8
< Content-Length: 68
< Connection: keep-alive
< Access-Control-Allow-Origin: *
< ETag: W/"44-RA5ERT/MMLIK54NVBWBSZG"
< X-Powered-By: APIGEE
< Server: Apigee Router
<
* Curl_http_done: called premature == 0
* Connection #0 to host willwitman-test.apigee.net left intact
{"FIRSTNAME":"JOHN","LASTNAME":"DOE","CITY":"SAN JOSE","STATE":"CA"}

Прокси-поток

Это снимок экрана инструмента трассировки, показывающий поток данных через прокси-сервер:

Прокси-структура

Это структура прокси. Обратите внимание, что она включает JAR-файл в каталоге apiproxy/resources/java . JAR-файл необходим. Мы предоставляем его для примера, но если вы занимаетесь собственной разработкой, вам нужно собрать его самостоятельно и скопировать в это место. Инструкции по компиляции и развертыванию Java-запроса см. в разделе «Как создать Java-запрос» . 

java-cookbook

    apiproxy
        java-cookbook.xml
    policies
        responseUppercase.xml
    proxies
        default.xml
    resources
        java
            ResponseUppercase.jar
    targets
        default.xml

О коде на Java

Политика Java Callout выполняет следующий Java-код, который преобразует заголовки ответа и тело ответа в верхний регистр. Обратите внимание, что программа использует пакеты, специфичные для Apigee. Эти пакеты предоставляют объекты и методы, которые можно использовать для прямого взаимодействия с потоком прокси. Существуют методы, позволяющие получать и устанавливать переменные потока, заголовки, содержимое сообщений и многое другое. 

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;

import java.util.Set; 

public class ResponseUppercase implements Execution{
    public ExecutionResult execute(MessageContext messageContext, ExecutionContext executionContext) {
        try {
            Set headers = messageContext.getMessage().getHeaderNames();
            for (String header : headers) {
                String h = messageContext.getMessage().getHeader(header).toUpperCase();
                messageContext.getMessage().setHeader(header, h);
            }
            String content = messageContext.getMessage().getContent();
            messageContext.getMessage().setContent(content.toUpperCase());
            return ExecutionResult.SUCCESS;
        } catch (Exception e) {
                return ExecutionResult.ABORT;
        }
    }
}

Изучите примерный прокси-сервер.

Мы оставляем вам возможность открыть прокси-сервер и изучить файлы. Вот политика вызова Java. Обратите внимание, как она ссылается на класс, который выполняет вызов, и на JAR-файл. Все политики вызова Java следуют этому шаблону. См. также политику вызова Java . 

<JavaCallout name="responseUppercase">         
    <ClassName>com.apigeesample.ResponseUppercase</ClassName>         
    <ResourceURL>java://ResponseUppercase.jar</ResourceURL> 
</JavaCallout>