מודל אובייקט JavaScript

אתה צופה בתיעוד של Apigee Edge.
הצג תיעוד של Apigee X.

הנושא הזה עוסק במודל אובייקט JavaScript של Apigee Edge. חשוב להבין את המודל הזה אם בכוונתך להשתמש במדיניות JavaScript כדי להוסיף JavaScript מותאם אישית לשרת proxy ל-API.

מידע על מודל האובייקט של Edge ב-JavaScript

מודל האובייקט של JavaScript של Apigee Edge מגדיר אובייקטים עם מאפיינים משויכים שזמינים להפעלת קוד JavaScript לביצוע בתהליך Proxy של Apigee Edge. המדיניות של JavaScript מאפשרת לצרף את הקוד המותאם אישית הזה לתהליך של שרת proxy ב-API.

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

• הקשר:אובייקט שמספק גישה להקשר של ההודעה
• בקשה:קיצור דרך שמאפשר גישה לאובייקט הבקשה
• תגובה:קיצור דרך שמאפשר גישה לאובייקט הבקשה
• קריפטו: מספק פונקציות גיבוב (hash) שונות
• print: פונקציה שפולטת פלט
• נכסים: מאפשרים גישת קריאה למאפייני התצורה במדיניות

אובייקט ההקשר

לאובייקט context יש היקף גלובלי. היא זמינה בכל מקום בתהליך ה-proxy של ה-API. הוא כולל ארבעה אובייקטים צאצאים: proxyRequest, proxyResponse, targetRequest, targetResponse. האובייקטים הצאצאים הם בהיקף של הבקשה הסביבתית והתגובה, של בקשה ותגובה לשרת proxy או של הבקשה והתגובה. לדוגמה, אם המדיניות של JavaScript מופעלת בחלק של נקודת הקצה של שרת ה-proxy, התהליך כולל את האובייקטים context.proxyRequest ו-context.proxyResponse. אם ה-JavaScript פועל בתהליך יעד, האובייקטים context.targetRequest ו-context.targetResponse נכללים בהיקף.

לאובייקט context יש גם מאפיינים ושיטות שמתוארים בפירוט בנושא הזה. לדוגמה, קוד ה-JavaScript בדוגמה הבאה משתמש במאפיין context.flow וקורא לשיטות get/setVariable() ב-context.

if (context.flow=="PROXY_REQ_FLOW") {
     var username = context.getVariable("request.formparam.user");
     context.setVariable("USER.name", username);
}

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

פרטים נוספים ודוגמאות מפורטים בחומר העזר בנושא אובייקטים.

אובייקט הקריפטו

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

האובייקטים של הבקשה והתגובה

האובייקטים request ו-response הם קצרים, הם הבקשות והתגובה לסביבה, לבקשת ה-proxy ולתגובה או לבקשת היעד ולתגובה. האובייקטים שהמשתנים האלה מפנים אליהם תלויים בהקשר שבו המדיניות של JavaScript מופעלת. אם JavaScript פועל בזרימה של נקודת קצה (proxy) של נקודת קצה, המשמעות היא שמשתני הבקשה והתגובה מתייחסים ל-context.proxyRequest ול-context.proxyResponse. אם JavaScript פועל בזרימת היעד, המשתנים מתייחסים ל-context.targetRequest ול-context.targetResponse.

הפונקציה Print()

מודל האובייקט של JavaScript כולל פונקציית print() שניתן להשתמש בה כדי ליצור פלט של נתוני ניפוי באגים אל הכלי Edge Trace. מידע נוסף זמין במאמר ניפוי באגים באמצעות הצהרות ב-JavaScript הדפסה().

האובייקט של המאפיין

כשמשתמשים ברכיב בתצורת המדיניות, קוד JavaScript יכול לגשת לערכים של הנכסים האלה באמצעות המשתנה properties.

לדוגמה, אם תצורת ה-JavaScript כוללת:

<Javascript name='JS-1' >
  <Properties>
    <Property name="number">8675309</Property>
    <Property name="firstname">Jenny</Property>
  </Properties>
  <ResourceURL>jsc://my-code.js</ResourceURL>
</Javascript>

לאחר מכן בmy-code.js אפשר:

  print(properties.firstname);  // prints Jenny
  print(properties.number);  // 8675309

באופן מעשי, ההגדרה יכולה לאפשר לקוד להתנהג באופן שונה כשמריצים בסביבות שונות, ברגעים שונים או מכל סיבה שהיא.

לדוגמה, הרשימה הבאה מציינת את 'שם המשתנה' ואת סגנון הפלט שעליו JavaScript ישדר מידע:

<Javascript name='JS-2' >
  <Properties>
    <Property name="output">my_output_variable</Property>
    <Property name="prettyPrint">true</Property>
  </Properties>
  <ResourceURL>jsc://emit-results.js</ResourceURL>
</Javascript>

var result = { prop1: "something", prop2 : "something else" } ;
if (properties.prettyPrint == "true") {
  context.setVariable(properties.output, JSON.stringify(result, null, 2));
}
else {
  context.setVariable(properties.output, JSON.stringify(result));
}

הפניה לאובייקט קריפטו

אובייקט הקריפטו מאפשר לבצע פונקציות גיבוב (hash) קריפטוגרפיות בסיסיות ב-JavaScript.

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

• SHA-1
• SHA256
• SHA512
• MD5

עבודה עם אובייקטים מסוג SHA-1

אפשר ליצור אובייקטים מסוג SHA-1, לעדכן אותם ולהמיר אותם לערכים הקסדצימליים ובסיסיים.

יצירת אובייקט SHA-1 חדש

var _sha1 = crypto.getSHA1();

עדכון אובייקט SHA-1

תחביר

_sha1.update(value);

פרמטרים

• value – (מחרוזת) כל ערך מחרוזת.

דוגמה

עדכון אובייקט SHA-1:

_sha1.update("salt_value");

_sha1.update("some text");

החזרת אובייקט SHA-1 כמחרוזת הקסדצימלית

var _hashed_token = _sha1.digest();

החזרת אובייקט SHA-1 כמחרוזת base64

var _hashed_token = _sha1.digest64();

עבודה עם אובייקטים מסוג SHA-256

ניתן ליצור אובייקטים SHA-256, לעדכן אותם ולהמיר אותם לערכי hex ו-base64.

יצירת אובייקט SHA-256 חדש

var _sha256 = crypto.getSHA256();

עדכון של אובייקט SHA-256

תחביר

_sha256.update(value);

פרמטרים

• value – (מחרוזת) כל ערך מחרוזת.

דוגמה

עדכון אובייקט SHA-256:

_sha256.update("salt_value");

_sha256.update("some text");

החזרת אובייקט SHA-256 כמחרוזת הקסדצימלית

var _hashed_token = _sha256.digest();

החזרת אובייקט SHA-256 כמחרוזת Base64

var _hashed_token = _sha256.digest64();

עבודה עם אובייקטים מסוג SHA-512

ניתן ליצור אובייקטים SHA-512, לעדכן אותם ולהמיר אותם לערכי hex ו-base64.

יצירת אובייקט SHA-512 חדש

var _sha512 = crypto.getSHA512();

עדכון של אובייקט SHA-512

תחביר

_sha512.update(value);

פרמטרים

• value – (מחרוזת) כל ערך מחרוזת.

דוגמה

עדכון אובייקט SHA-512:

_sha512.update("salt_value");

_sha512.update("some text");

החזרת אובייקט SHA-512 כמחרוזת הקסדצימלית

var _hashed_token = _sha512.digest();

החזרת אובייקט SHA-512 כמחרוזת base64

var _hashed_token = _sha512.digest64();

עבודה עם אובייקטים של MD5

ניתן ליצור אובייקטים של MD5, לעדכן אותם ולהמיר אותם לערכים הקסדצימליים ו-base64.

יצירת אובייקט MD5 חדש

var _md5 = crypto.getMD5();

עדכון של אובייקט MD5

תחביר

_md5.update(value);

פרמטרים

• value – (מחרוזת) כל ערך מחרוזת.

דוגמה

עדכון אובייקט MD5:

_md5.update("salt_value");

_md5.update("some text");

החזרת אובייקט MD5 כמחרוזת הקסדצימלית

var _hashed_token = _md5.digest();

החזרת אובייקט MD5 כמחרוזת base64

var _hashed_token = _md5.digest64();

תמיכה בתאריך/שעה בהצפנה

אובייקט הקריפטו תומך בדפוסי פורמט של תאריך/שעה.

crypto.dateFormat()

מחזירה תאריך בפורמט מחרוזת.

תחביר

crypto.dateFormat(format, [timezone], [time])

פרמטרים

• format – (מחרוזת) ההטמעה הבסיסית של הפרמטר הזה היא java.text.SimpleDateFormat. לדוגמה: 'yyyy-MM-DD HH:mm:ss.SSS'
• timezone – (מחרוזת, אופציונלי) ההטמעה הבסיסית של הפרמטר הזה היא java.util.TimeZone. פרמטר זה זהה לברירת המחדל: UTC
• time – (מספר, אופציונלי) ערך לחותמת זמן בפורמט Unix. ברירת מחדל: השעה הנוכחית

דוגמאות

הצגת השעה הנוכחית עד לאלפיות שנייה:

var _now = crypto.dateFormat('yyyy-MM-DD HH:mm:ss.SSS');

קבלת השעה הנוכחית עבור אזור הזמן של האוקיינוס השקט:

var _pst = crypto.dateFormat('yyyy-MM-DD HH:mm:ss.SSS','PST');

קבל את הערך של עשר שניות מעכשיו:

var _timeNow = Number(context.getVariable('system.timestamp'));
var ten_seconds = crypto.dateFormat('yyyy-MM-DD HH:mm:ss.SSS','PST', _timeNow + 10 * 1000);

דוגמאות נוספות. אפשר גם לעיין במסמכי התיעוד של java.text.SimpleDateFormat.

var _pst = crypto.dateFormat('M');

var _pst = crypto.dateFormat('EEE, d MMM yyyy HH:mm:ss Z');

var _pst = crypto.dateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");

שימוש ב-getHash() כדי לקבל כל אחד מאובייקטי הגיבוב הנתמכים

דוגמאות

var _hash1 = crypto.getHash('MD5');

var _hash2 = crypto.getHash('SHA-1');

var _hash3 = crypto.getHash('SHA-256');

var _hash4 = crypto.getHash('SHA-512');

דוגמה עם קריפטו

try {
    //get values to use with hash functions
    var salt = context.getVariable("salt") || 'SomeHardCodedSalt';
    var host = context.getVariable("request.header.Host");
    var unhashed_token = "";

    var _timeNow = Number(context.getVariable('system.timestamp'));
    var now = crypto.dateFormat('yyyy-MM-DD HH:mm:ss.SSS','PST', _timeNow);
    unhashed_token = "|" + now + "|" + host

    //generate a hash with the unhashedToken:
    var sha512 = crypto.getSHA512();
    sha512.update(salt);
    sha512.update(unhashed_token);

    //convert to base64
    var base64_token = sha512.digest64();

    // set headers
    context.setVariable("request.header.now", now);
    context.setVariable("request.header.token", base64_token);

} catch(e) {
    throw 'Error in Javascript';
}

הפניה לאובייקט הקשר

• סיכום אובייקט הקשר
• שיטות של אובייקט הקשר
• מאפיינים של אובייקטי הקשר
• אובייקט הקשר לילדים

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

משתנים מגדירים מאפיינים הספציפיים לעסקה. השעה ביום, הלוקאל של הלקוח המבקש, סוכן המשתמש של הלקוח ששולח את הבקשה וכתובת ה-URL של שירות היעד הם דוגמאות למשתנים הזמינים ב-context. לכן, כדאי להשתמש ב-context לפיתוח לוגיקה שמסתמכת על הנכסים האלה כדי לבצע התנהגות מותאמת אישית.

למידע נוסף, ראו הפניות של משתני זרימה ומדיניות בנושא משתני משתנה.

סיכום אובייקט

בטבלה הזו מתואר בקצרה אובייקט ההקשר וצאצאים שלו, ומפורטים המאפיינים שמקושרים לכל אחד מהם.

שיטות האובייקט

context.getVariable()

מאחזרת את הערך של משתנה מוגדר מראש או מותאם אישית.

תחביר

context.getVariable("variable-name");

דוגמה

כדי לקבל את הערך של השנה הנוכחית:

var year = context.getVariable('system.time.year');

context.setVariable()

מגדיר את הערך של משתנה מותאם אישית או של משתנים מוגדרים מראש הניתן לכתיבה.

context.setVariable("variable-name", value);

context.setVariable("target.url", "http://mocktarget.apigee.net/user?user="+context.getVariable("USER.name"));

context.removeVariable('variable-name');

if (context.flow=="TARGET_REQ_FLOW") {
     context.targetRequest.headers['TARGET-HEADER-X']='foo';
}

if (context.flow=="PROXY_RESP_FLOW") {
     context.proxyResponse.content='bar';
}

context.session['key']  = 123;

var value = context.session['key']; // 123

context.targetRequest.url = 'http://www.example.com/path?q1=1'
context.targetRequest.protocol ='https';

POST /v1/blogs HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z

context.proxyRequest.headers['Content-Type'];
context.proxyRequest.headers['Authorization'];

application/json
Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z

"?city=PaloAlto&city=NewYork"

context.proxyRequest.queryParams['city'];  // == 'PaloAlto'
context.proxyRequest.queryParams['city'][0]     // == 'PaloAlto'
context.proxyRequest.queryParams['city'][1];    // == 'NewYork'
context.proxyRequest.queryParams['city'].length(); // == 2

POST /v1/blogs HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z

context.proxyRequest.method;

POST

<customer number='1'>
<name>Fred<name/>
<customer/>

var name = context.targetRequest.body.asXML.name;

var number = context.targetRequest.body.asXML.@number;

{
"a":  1 ,
"b" : "2"
}

var a = context.proxyRequest.body.asJSON.a;    // == 1
var b = context.proxyRequest.body.asJSON.b;    // == 2

"vehicle=Car&vehicle=Truck"

v0 = context.proxyRequest.body.asForm['vehicle'][0];
v1 = context.proxyRequest.body.asForm['vehicle'][1];

var cookie = context.targetResponse.headers['Set-Cookie'];

var status = context.targetResponse.status.code;   // 200
var msg = context.targetResponse.status.message;   // "OK"

context.targetResponse.content.asXML;
context.targetResponse.content.asJSON;

<?xml version="1.0" encoding="UTF-8"?>
<yahoo:error xmlns:yahoo="http://yahooapis.com/v1/base.rng" xml:lang="en-US">
   <yahoo:description>Please provide valid credentials. OAuth oauth_problem="unable_to_determine_oauth_type", realm="yahooapis.com"
   </yahoo:description>
</yahoo:error>
<!-- mg023.mail.gq1.yahoo.com uncompressed/chunked Sat Dec 14 01:23:35 UTC 2013 -->

<?xml version="1.0" encoding="UTF-8"?>
<yahoo:error xmlns:yahoo="http://yahooapis.com/v1/base.rng" xml:lang="en-US">
   <yahoo:description>Please provide valid credentials. OAuth oauth_problem="unable_to_determine_oauth_type", realm="yahooapis.com"
   </yahoo:description>
</yahoo:error>

if (context.flow=="PROXY_REQ_FLOW") {
     print("In proxy request flow");
     var username = context.getVariable("request.queryparam.user");
     print("Got query param: " + username);
     context.setVariable("USER.name", username);
     print("Set query param: " + context.getVariable("USER.name"));
}


if (context.flow=="TARGET_REQ_FLOW") {
     print("In target request flow");
     var username = context.getVariable("USER.name");
     var url = "http://mocktarget.apigee.net/user?"
     context.setVariable("target.url", url + "user=" + username);
     print("callout to URL: ", context.getVariable("target.url"));
}

var myRequest = new Request();
myRequest.url = "http://www.example.com";
var exchangeObj = httpClient.send(myRequest);

var exchangeObj = httpClient.get(url);

// Add the required the headers for making a specific API request
var headers = {'X-SOME-HEADER' : 'some value' };
// Make a GET API request along with headers
var myRequest = new Request("http://www.example.com","GET",headers);

// Define the callback function and process the response from the GET API request
function onComplete(response,error) {
 // Check if the HTTP request was successful
    if (response) {
      context.setVariable('example.status', response.status);
     } else {
      context.setVariable('example.error', 'Woops: ' + error);
     }
}

// Specify the callback Function as an argument
httpClient.get(myRequest, onComplete);