خط‌مشی «برنمای جاری‌سازی»

درستی‌سنجی کلید میانای برنامه‌سازی کاربردی در جریان مشترک

در این مثال، از یک جریان مشترک برای انجام وظایف رایج مربوط به امنیت استفاده می‌شود. در اینجا، جریان مشترک کلید میانای برنامه‌سازی کاربردی را اعتبارسنجی می‌کند. کارگزاران نیابتی API و جریان‌های مشترک دیگر می‌توانند از خط‌مشی FlowCallout برای فراخوانی این جریان مشترک استفاده کنند.

تعریف جاری مشترک زیر شامل خط‌مشی Verify-API-Key است که وقتی جاری مشترک از خط‌مشی FlowCallout در پراکسی API فراخوانی می‌شود اجرا می‌شود.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SharedFlow name="default">
    <Step>
        <Name>Verify-API-Key</Name>
    </Step>
</SharedFlow>

خط‌مشی VerifyAPIKey در جریان مشترک قبلی مقدار کلید را بازیابی می‌کند و آن را تأیید می‌کند.

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key">
    <DisplayName>Verify API Key</DisplayName>
    <APIKey ref="request.queryparam.apikey"/>
</VerifyAPIKey>

خط‌مشی FlowCallout زیر که در یک پراکسی API استفاده می‌شود، جریان مشترک قبلی را برای تأیید کلید API فراخوانی می‌کند. بسته جاری مشترک verify-apikey-shared (در اینجا نشان داده نمی‌شود) جاری مشترک را به روشی پیکربندی می‌کند که بسته APIProxy پراکسی را پیکربندی می‌کند.

<FlowCallout async="false" continueOnError="false" enabled="true" name="Auth-Flow-Callout">
    <DisplayName>Auth Flow Callout</DisplayName>
    <SharedFlowBundle>verify-apikey-shared</SharedFlowBundle>
</FlowCallout>

گذراندن پارامترها به یک جریان مشترک

این مثال نشان می‌دهد چگونه پارامترها را از خط‌مشی «دعوت به اقدام جاری» به جاری مشترک منتقل کنید. در اینجا، خط‌مشی FlowCallout به یک جریان هم‌رسانی‌شده که برای انجام توابع رایج دستکاری رشته طراحی شده است فراخوانی می‌کند. جریان مشترک شامل جاوا اسکریپتی است که ورودی‌اش را به‌هم می‌چسباند، ورودی‌اش را به حروف کوچک تبدیل می‌کند، یا هر دو. خط‌مشی FlowCallout پارامترهایی را تعریف می‌کند که ورودی رشته، برونداد، و نحوه استفاده از ورودی را مشخص می‌کند.

1. خط‌مشی String-Handler FlowCallout جریان هم‌رسانی‌شده را فرا می‌خواند، و پارامترهایی را که متغیر را برای ذخیره برونداد جریان هم‌رسانی‌شده، عملیات جریان هم‌رسانی‌شده مورد استفاده، و ورودی مورد استفاده مشخص می‌کنند منتقل می‌کند (در اینجا، یک رشته حرفی، اما می‌تواند متغیر جریان نیز باشد). عناصر Parameter نام‌ها و مقادیر متغیرها را برای ایجاد زمان اجرا مشخص می‌کنند. جریان مشترک می‌تواند این متغیرها را برای استفاده در کد خود بازیابی کند.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler">
     <DisplayName>String Handler</DisplayName>
     <Parameters>
       <Parameter name="input">Gladys Kravitz</Parameter>
       <Parameter name="operations">concatenate tolowercase</Parameter>
       <Parameter name="outputVariable">string.handler.output</Parameter>
     </Parameters>
     <SharedFlowBundle>StringHandler</SharedFlowBundle>
   </FlowCallout>

2. جریان مشترک default زیر شامل خط‌مشی SharedStringFunctions جاوا اسکریپت است که وقتی جریان مشترک از خط‌مشی FlowCallout فراخوانده می‌شود اجرا می‌شود.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <SharedFlow name="default">
     <Step>
       <Name>SharedStringFunctions</Name>
     </Step>
   </SharedFlow>

3. در جاری‌سازی مشترک، SharedStringFunctions خط‌مشی جاوا اسکریپت فایل جاوا اسکریپت SharedStringFunctions.js را با کد اجرایی مشخص می‌کند.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="SharedStringFunctions">
     <DisplayName>SharedStringFunctions</DisplayName> <Properties/>
     <ResourceURL>jsc://SharedStringFunctions.js</ResourceURL>
   </Javascript>

4. ‫JavaScript زیر، SharedStringFunctions.js، از SharedStringFunctions خط‌مشی JavaScript اجرا می‌شود. این نوشتار مقادیر را از متغیرهای ایجادشده از عناصر خط‌مشی FlowCallout Parameter بازیابی می‌کند.

   // Input value from the calling API proxy.
   var handledString = context.getVariable("input");
   // Variable to use for output from this script.
   var outputVariable = context.getVariable("outputVariable");
   // A space-separated list of things to do to the input string.
   // Convert to lower case to handle unintentional capitals in configuration.
   var operation = context.getVariable("operations").toLowerCase();
   
   // If "lowercase" was given as an operation, convert the input to lowercase.
   if (operation.includes("tolowercase")) {
       handledString = handledString.toLowerCase();
   }
   
   // If "concatenate" was given as an operation, concatenate the input.
   if (operation.includes("concatenate")) {
       handledString = handledString.replace(/\s+/g, '');
   }
   // Assign the resulting string to the output variable specified by
   // the calling API proxy.
   context.setVariable(outputVariable, handledString);

5. جریان اجرا از خط‌مشی جاوا اسکریپت به جریان مشترک و سپس به خط‌مشی FlowCallout در پراکسی API مبدأ برمی‌گردد.

نحو

می‌توانید از این عنصر با هریک از شکل‌های دستور زبان زیر استفاده کنید. توجه داشته باشید که در جایی که از مقدار تحت‌اللفظی استفاده می‌کنید، قالب مقداری که مشخص می‌کنید به کدی که آن را مصرف می‌کند بستگی دارد.

<!- A literal value in an attribute. --/>
<Parameter name="parameter-name" value='parameter-value' />
<!- A reference to a variable in an attribute. --/>
<Parameter name="parameter-name" ref='source-variable-name' />
<!- A literal value in the element content. --/>
<Parameter name="parameter-name">parameter-value</Parameter>
<!- An reference to an attribute in the element content. --/>
<Parameter name="parameter-name">{source-variable-name}</Parameter>

مثال

این خط‌مشی String-Handler FlowCallout پارامترهایی را می‌گذراند که مشخص می‌کنند برونداد جاری‌سازی هم‌رسانی‌شده کجا ذخیره شود و از چه ورودی‌ای استفاده شود. عناصر Parameter نام‌ها و مقادیر متغیرها را برای ایجاد زمان اجرا مشخص می‌کنند. جریان مشترک می‌تواند این متغیرها را برای استفاده در کد خود بازیابی کند.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler">
  <DisplayName>String Handler</DisplayName>
  <Parameters>
    <Parameter name="input">Gladys Kravitz</Parameter>
    <Parameter name="outputVariable">string.handler.output</Parameter>
  </Parameters>
  <SharedFlowBundle>StringHandler</SharedFlowBundle>
</FlowCallout>

نحو

<Parameters>
  <Parameter name="parameter-name" value='parameter-value' />
</Parameters>