המדיניות בנושא יתרונות מרכזיים של זרימה

אימות מפתח API בתהליך משותף

בדוגמה הזו נעשה שימוש בתהליך משותף לביצוע משימות נפוצות הקשורות לאבטחה. בתהליך הזה, התהליך המשותף מאמת מפתח API. שרתי proxy של API ותהליכי עבודה משותפים אחרים יכולים להשתמש במדיניות של הסבר על הזרימה כדי לבצע קריאות לתהליך המשותף הזה.

ההגדרה הבאה של תהליך משותף כוללת מדיניות Verify-API-Key שמופעלת כשהתהליך המשותף מופעל ממדיניות של הסבר על זרימה בשרת proxy של 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>

במדיניות הבאה של הסבר על תהליך הזרימה, המשמשת בשרת proxy של API, מתבצעת קריאה לתהליך המשותף הקודם כדי לאמת את מפתח ה-API. חבילת הזרימה המשותפת של verify-apikey-shared (לא מוצגת כאן) מגדירה את התהליך המשותף באופן שבו חבילת APIProxy מגדירה שרת proxy.

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

העברת פרמטרים לתהליך משותף

הדוגמה הזו ממחישה איך להעביר פרמטרים ממדיניות 'יתרונות מרכזיים של זרימה' לתהליך משותף. כאן, המדיניות של הסבר על תהליך הזרימה מפעילה תהליך משותף המיועד לבצע פונקציות נפוצות של טיפול במחרוזות. בתהליך המשותף יש קוד JavaScript שמשורשר את הקלט שלו, מצמצם את הקלט שלו באותיות קטנות, או את שניהם. המדיניות הזו מגדירה פרמטרים שמציינים את הקלט והפלט של המחרוזת, ומה לעשות עם הקלט.

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 כולל מדיניות JavaScript של SharedStringFunctions שמופעלת כשהתהליך המשותף מופעל ממדיניות של הסבר על זרימה.

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

3. בתהליך המשותף, מדיניות ה-JavaScript הבאה 'SharedStringFunctions' מציינת את קובץ ה-JavaScript של 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. הסקריפט מאחזר ערכים ממשתנים שנוצרו מרכיבי 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. הביצוע עובר חזרה ממדיניות JavaScript, אל התהליך המשותף ולאחר מכן אל המדיניות 'הסבר על הזרימה' בשרת ה-proxy המקורי.

תחביר

ניתן להשתמש ברכיב זה עם כל אחד מטופסי התחביר הבאים. הערה: כשמשתמשים בערך מילולי, הפורמט של הערך שמגדירים משתנה בהתאם לקוד שבו הוא צורף.

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