ফ্লোকলআউট নীতি

শেয়ার্ড ফ্লোতে এপিআই কী যাচাই করুন

এই উদাহরণে, সাধারণ নিরাপত্তা-সম্পর্কিত কাজগুলো সম্পাদন করার জন্য একটি শেয়ার্ড ফ্লো ব্যবহার করা হয়েছে। এখানে শেয়ার্ড ফ্লোটি একটি এপিআই কী (API key) যাচাই করে। এপিআই প্রক্সি এবং অন্যান্য শেয়ার্ড ফ্লো এই শেয়ার্ড ফ্লো-তে কল করার জন্য ফ্লোকলআউট (FlowCallout) পলিসি ব্যবহার করতে পারে।

নিম্নলিখিত শেয়ার্ড ফ্লো ডেফিনিশনটিতে একটি Verify-API-Key পলিসি অন্তর্ভুক্ত রয়েছে, যা একটি এপিআই প্রক্সিতে থাকা FlowCallout পলিসি থেকে শেয়ার্ড ফ্লো-টি কল করা হলে কার্যকর হয়।

<?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>

এপিআই প্রক্সিতে ব্যবহৃত নিম্নলিখিত ফ্লোকলআউট পলিসিটি এপিআই কী যাচাই করার জন্য পূর্ববর্তী শেয়ার্ড ফ্লো-কে কল করে। verify-apikey-shared শেয়ার্ড ফ্লো বান্ডেলটি (এখানে দেখানো হয়নি) একটি এপিআইপ্রক্সি বান্ডেল যেভাবে প্রক্সি কনফিগার করে, সেভাবেই শেয়ার্ড ফ্লো-টিকে কনফিগার করে।

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

একটি শেয়ার্ড ফ্লোতে প্যারামিটার পাস করুন

এই উদাহরণটি দেখায় কিভাবে একটি ফ্লোকলআউট পলিসি থেকে একটি শেয়ার্ড ফ্লো-তে প্যারামিটার পাস করতে হয়। এখানে, একটি ফ্লোকলআউট পলিসি এমন একটি শেয়ার্ড ফ্লো-কে কল করে যা সাধারণ স্ট্রিং হ্যান্ডলিং ফাংশনগুলো সম্পাদন করার জন্য ডিজাইন করা হয়েছে। শেয়ার্ড ফ্লো-টিতে জাভাস্ক্রিপ্ট অন্তর্ভুক্ত রয়েছে যা এর ইনপুটকে সংযুক্ত করে, ইনপুটকে লোয়ার-কেস করে, অথবা উভয়ই করে। ফ্লোকলআউট পলিসিটি এমন প্যারামিটার নির্ধারণ করে যা স্ট্রিং ইনপুট, আউটপুট এবং ইনপুটটি নিয়ে কী করতে হবে তা নির্দিষ্ট করে।

1. String-Handler ফ্লোকলআউট পলিসিটি শেয়ার্ড ফ্লো-কে কল করে এবং প্যারামিটার পাস করে, যা নির্দিষ্ট করে দেয় শেয়ার্ড ফ্লো-এর আউটপুট সংরক্ষণের জন্য ভ্যারিয়েবল, কোন শেয়ার্ড ফ্লো অপারেশন ব্যবহার করতে হবে এবং কোন ইনপুট ব্যবহার করতে হবে (এখানে, একটি স্ট্রিং লিটারেল, তবে এটি একটি ফ্লো ভ্যারিয়েবলও হতে পারে)। 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. নিম্নলিখিত জাভাস্ক্রিপ্ট, SharedStringFunctions.js, SharedStringFunctions জাভাস্ক্রিপ্ট পলিসি থেকে এক্সিকিউট হয়। এই স্ক্রিপ্টটি 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. এক্সিকিউশন প্রবাহ জাভাস্ক্রিপ্ট পলিসি থেকে শেয়ার্ড ফ্লো-তে, এবং তারপর মূল এপিআই প্রক্সিতে থাকা ফ্লোকলআউট পলিসিতে ফিরে আসে।

সিনট্যাক্স

আপনি নিম্নলিখিত যেকোনো সিনট্যাক্স ফর্মের সাথে এই এলিমেন্টটি ব্যবহার করতে পারেন। মনে রাখবেন যে, যেখানে আপনি একটি লিটারেল ভ্যালু ব্যবহার করবেন, সেখানে আপনার নির্দিষ্ট করা ভ্যালুটির ফরম্যাট নির্ভর করবে সেই কোডের উপর যা এটিকে গ্রহণ করবে।

<!- 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 ফ্লোকলআউট পলিসিটি এমন প্যারামিটার পাস করে, যা নির্দিষ্ট করে দেয় শেয়ার্ড ফ্লো-এর আউটপুট কোথায় সংরক্ষণ করতে হবে এবং কোন ইনপুট ব্যবহার করতে হবে। 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>