درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
این بخش اطلاعات مرجعی درباره عناصر XML که برای تعریف جریانهای پراکسی API استفاده میکنید ارائه میدهد.
سلسلهمراتب و نحو
مثالهای زیر سلسلهمراتب عنصر و نحو عناصر پیکربندی جریان را نشان میدهد:
سلسلهمراتب عنصر
مثال زیر سلسلهمراتب عناصر پیکربندی جریان را در
<ProxyEndpoint> و <TargetEndpoint> عناصر نشان میدهد:
<ProxyEndpoint | TargetEndpoint>
<PreFlow>
<Request>
<Step>
<Condition>
<Name>
<Response>
<Step>
<Condition>
<Name>
<Description>
<Flows>
<Flow>
<Description>
<Condition>
<Request>
<Step>
<Response>
<Step>
<Description>
<PostFlow>
<Request>
<Step>
<Response>
<Step>
<Description>
<PostClientFlow> (<ProxyEndpoint> only)
<Response>
<Description>
// Additional configuration elements
</ProxyEndpoint | TargetEndpoint>نحو
مثال زیر دستورگان عناصر پیکربندی جریان را نشان میدهد. هریک از این عناصر در بخشهای زیر بهطور مفصل شرح داده شده است:
<!-- ProxyEndpoint flow configuration file -->
<ProxyEndpoint ... >
...
<PreFlow name="flow_name">
<Description>flow_description</Description>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</PreFlow>
<Flows name="flow_name">
<Flow name="conditional_flow_name">
<Description>flow_description</Description>
<Condition>property operator "value"</Condition>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</Flow>
</Flows>
<PostFlow name="flow_name">
<Description>flow_description</Description>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</PostFlow>
<PostClientFlow name="flow_name">
<Description>flow_description</Description>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</PostClientFlow>
...
</ProxyEndpoint>
<!-- TargetEndpoint flow configuration file -->
<TargetEndpoint ... >
...
<PreFlow name="flow_name">
<Description>flow_description</Description>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</PreFlow>
<Flows name="flow_name">
<Flow name="conditional_flow_name">
<Description>flow_description</Description>
<Condition>property operator "value"</Condition>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</Flow>
...
</Flows>
<PostFlow name="flow_name">
<Description>flow_description</Description>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</PostFlow>
...
</TargetEndpoint>از این عناصر برای تعریف اجرای PreFlow، Conditional Flow، PostFlow، و PostClientFlow استفاده میکنید.
<Condition>
بیانیهای را تعریف میکند که در زمان اجرا پردازش میشود. اگر عبارت به درست ارزیابی شود، آنگاه مرحله یا جاریسازی مرتبط با شرط اجرا میشود. اگر عبارت به نادرست ارزیابی شود، مرحله یا جریان نادیده گرفته میشود.
| تایپ کردن | رشته |
| عنصر(های) والد | <Flow><Step> |
| عنصر(های) فرزند | خالی |
بسته به اینکه عنصر را در عنصر <Flow> یا <Step> قرار دهید، میتوانید شرطی را برای مرحلهای خاص یا برای کل جریان اعمال کنید:
// Condition can apply to just one step: // Or to the flow:<Flows><Flows><Flow><Flow><Step><Condition><Condition><Step><Name><Name>... ... ... ... ... ... </Flows> </Flows>
اگر شرطی در <Step> به درست ارزیابی شود، Edge آن مرحله را اجرا میکند. اگر شرط به نادرست ارزیابی شود، Edge از این مرحله رد میشود.
اگر شرایطی در <Flow> به درست ارزیابی شود، Edge همه مراحل جریان را پردازش میکند. اگر
شرط به نادرست ارزیابی شود، Edge از کل جریان میگذرد.
نحو
عنصر <Condition> از نحو زیر استفاده میکند:
<Condition>property operator "value"</Condition>
مکان:
- property
- دارایی متغیر جاریسازی که میخواهید در
شرطتان استفاده کنید. برای مثال، متغیر جریان
requestدارای ویژگیهایی به نامpathوcontentاست. برای استفاده از آنها در یک شرط، flow_variable[نقطه]property_name را مشخص میکنید:request.path request.content
برای مشاهده فهرست کامل متغیرهای جاری و ویژگیهای آنها، به مرجع متغیرهای جاری مراجعه کنید.
- operator
- ساختاری که نحوه ارزیابی وضعیت شما را تعریف میکند. اپراتورهای
رایج عبارتاند از:
> greater than <= less than or equal to < less than >= greater than or equal to = equals && and != not equals || or ~~ JavaRegex ~ Matches /~ MatchesPath
برای مشاهده فهرست کامل، به اپراتورها در مرجع «شرایط» مراجعه کنید.
- «value»
- مقدار براساس آن دارایی متغیر جاری ارزیابی میشود. این معمولاً یک نوع پایه مانند عدد صحیح یا رشته است. برای مثال، ۲۰۰ یا «/cat». مقدار میتواند شامل نویسههای عام باشد، مثل ستاره و نویسههای دیگر برای مطابقت الگو، همانطور که در مطابقت الگو با شرطها توضیح داده شده است.
مثال ۱
مثال زیر بررسی میکند که آیا دارایی request متغیر جریان verb
«درخواست» «دریافت» است یا نه:
<!-- api-platform/reference/examples/flow-segments/condition-1.xml --> <ProxyEndpoint name="default"> <PreFlow name="my-preFlows"> <Description>My first PreFlow</Description> <Request> <Step> <Condition>request.verb = "GET"</Condition> <Name>Log-Request-OK</Name> </Step> </Request> </PreFlow> ... </ProxyEndpoint>
اگر درخواست «GET» باشد، این مثال خطمشی «Log-Request-OK» را اجرا میکند.
مثال ۲
مثال زیر کد پاسخ را بررسی میکند:
<!-- api-platform/reference/examples/flow-segments/condition-2.xml --> <ProxyEndpoint name="default"> <PreFlow name="my-preFlows"> <Description>My first PreFlow</Description> <Response> <Step> <Condition>response.status.code LesserThanOrEquals 300</Condition> <Name>Log-Response-OK</Name> </Step> <Step> <Condition>response.status.code GreaterThan 300</Condition> <Name>Log-Response-NOT-OK</Name> </Step> </Response> </PreFlow> ... </ProxyEndpoint>
بسته به مقدار کد، خطمشی متفاوتی اجرا میشود.
مشخصهها
عنصر <Condition> هیچ مشخصهای ندارد.
عناصر فرزند
عنصر <Condition> هیچ عنصر فرزندی ندارد.
<Description>
جریان را با عبارات قابلخواندن برای انسان توصیف میکند. از این عنصر برای ارائه اطلاعات درباره جریان به خودتان یا توسعهدهندگان دیگر استفاده کنید. شرح بهصورت خارجی قابلمشاهده نیست.
| تایپ کردن | رشته |
| عنصر(های) والد | <Flow><PreFlow><PostFlow> |
| عنصر(های) فرزند | خالی |
نحو
عنصر <Description> از نحو زیر استفاده میکند:
<Description>flow_description</Description>
مثال
مثال زیر عنصر <Description> را نشان میدهد که هدف یک
جریان را مشخص میکند:
<!-- api-platform/reference/examples/flow-segments/description-1.xml --> <ProxyEndpoint name="default"> <Flows name="my-conditional-flows"> <Flow name="reports"> <Request> <Description>Based on the path suffix, determine which flow to use</Description> <Step> <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition> <Name>XML-to-JSON-1</Name> </Step> <Step> <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition> <Name>XML-to-JSON-1</Name> </Step> </Request> </Flow> </Flows> ... </ProxyEndpoint>
مشخصهها
عنصر <Description> هیچ مشخصهای ندارد.
عناصر فرزند
عنصر <Description> هیچ عنصر فرزندی ندارد.
<Flow>
مجموعه سفارشی از مراحلی را که Edge اجرا میکند تعریف میکند.
| تایپ کردن | شیء پیچیده |
| عنصر(های) والد | <Flows> |
| عنصر(های) فرزند | <Condition><Description><Request><Response> |
میتوانید بهصورت اختیاری <Condition> را در <Flow> مشخص کنید. در این حالت، Edge فقط درصورتی مراحل جریان را اجرا میکند که شرط درست ارزیابی شود. درغیراینصورت، Edge از کل جریان
رد میشود.
عنصر <Flows> میتواند شامل چندین عنصر <Flow> باشد که هرکدام شرایط و مراحل خاص خود را دارند. وقتی چندین عنصر <Flow> وجود داشته باشد، Edge فقط اولین عنصری را اجرا میکند که
شرط ندارد یا شرط آن به درست ارزیابی میشود.
میتوانید جاریسازی پیشفرضی تعریف کنید که همیشه اجرا شود (اگر هیچیک از جاریسازیهای شرطی دیگر اجرا نشود). بسته به نحوه پیکربندی پراکسی API، این میتواند ابزاری مفید در محافظت دربرابر حملات مخرب باشد.
نحو
عنصر <Flow> از نحو زیر استفاده میکند:
<Flow name="conditional_flow_name">
<Description>flow_description</Description>
<Condition>property operator "value"</Condition>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</Flow>همه عناصر فرزند <Flow> اختیاری هستند.
مثال ۱
مثال زیر <Flow> سادهای را نشان میدهد که همیشه خطمشی «Log-Message-OK»
را اجرا میکند:
<!-- api-platform/reference/examples/flow-segments/flow-1.xml --> <ProxyEndpoint name="default"> <Flows name="my-flow"> <Flow> <Request> <Step> <Name>Log-Message-OK</Name> </Step> </Request> </Flow> </Flows> ... </ProxyEndpoint>
مثال ۲
مثال زیر <Flow> با چند مرحله را نشان میدهد که هرکدام شرط خاص خود را دارند:
شرط:
<!-- api-platform/reference/examples/flow-segments/flow-2.xml --> <ProxyEndpoint name="default"> <Flows name="my-conditional-flows"> <Flow name="reports"> <Request> <Description>Based on the path suffix, determine which flow to use</Description> <Step> <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition> <Name>XML-to-JSON-1</Name> </Step> <Step> <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition> <Name>Verify-Auth-1</Name> </Step> </Request> </Flow> </Flows> ... </ProxyEndpoint>
مثال ۳
مثال زیر چندین جریان را در «جریان شرطی» نشان میدهد:
<!-- api-platform/reference/examples/flow-segments/flows-2.xml --> <ProxyEndpoint name="default"> <Flows> <Flow name="my-flow-1"> <Response> <Step> <Condition>response.status.code = 200</Condition> <Name>Assign-Message-1</Name> </Step> </Response> </Flow> <Flow name="my-flow-2"> <Response> <Step> <Condition>response.status.code >= 400</Condition> <Name>Assign-Message-2</Name> </Step> </Response> </Flow> <Flow name="my-flow-3"> <Response> <Step> <Condition>response.status.code >= 300</Condition> <Name>Assign-Message-3</Name> </Step> </Response> </Flow> </Flows> ... </ProxyEndpoint>
Edge فقط یک جریان را در یک بخش اجرا میکند؛ اولین جریانی را اجرا میکند که شرط ندارد یا شرط آن به درست حلوفصل میشود.
مشخصهها
جدول زیر مشخصههای عنصر <Flow> را شرح میدهد:
| مشخصه | نوع | شرح |
|---|---|---|
name |
رشته | (الزامی) شناسه یکتای جریان. برای مثال، «My-Conditional-Flow-1». نام نمیتواند حاوی فاصله یا نویسههای خاص دیگر باشد. |
عناصر فرزند
جدول زیر عناصر فرزند <Flow> را شرح میدهد:
| عنصر فرزند | نوع | شرح |
|---|---|---|
<Condition> |
رشته | بیانیه شرطی را تعریف میکند که در زمان اجرا پردازش میشود. اگر عبارت به درست ارزیابی شود، جریان (و همه مراحل آن) اجرا میشود. اگر عبارت به نادرست ارزیابی شود، جریان (و همه مراحل آن) نادیده گرفته میشود. |
<Description> |
رشته | شرح مختصری از جریان ارائه میدهد. این شرح بهصورت خارجی قابلمشاهده نیست. |
<Request> |
شیء پیچیده | مراحل و شرایط بخش درخواست را مشخص میکند. |
<Response> |
شیء پیچیده | مراحل و شرایط را برای بخش پاسخ مشخص میکند. |
<Flows>
شامل صفر یا چند عنصر <Flow> است.
| تایپ کردن | شیء پیچیده |
| عنصر(های) والد | <ProxyEndpoint><TargetEndpoint> |
| عنصر(های) فرزند | <Flow> |
اگر چندین عنصر <Flow> در <Flows> وجود داشته باشد، فقط یک <Flow> اجرا خواهد شد. این
اولین جریانی خواهد بود که یا <Condition> ندارد یا وضعیت آن
به درست تبدیل میشود.
میتوانید یک جریان پیشفرض تعریف کنید که همیشه اجرا شود (اگر هیچیک از جریانهای دیگر اجرا نشود). بسته به نحوه پیکربندی پراکسی API، این میتواند ابزاری مفید در محافظت دربرابر حملات مخرب باشد.
نحو
عنصر <Flows> از نحو زیر استفاده میکند:
<Flows name="flow_name">
<Flow name="conditional_flow_name">
<Description>flow_description</Description>
<Condition>property operator "value"</Condition>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</Flow>
</Flows>همه عناصر فرزند <Flows> اختیاری هستند.
مثال ۱
مثال زیر عنصر ساده <Flows> با یک <Flow> را نشان میدهد:
<!-- api-platform/reference/examples/flow-segments/flows-1.xml --> <ProxyEndpoint name="default"> <Flows name="my-conditional-flows"> <Flow name="reports"> <Request> <Description>Based on the path suffix, determine which flow to use</Description> <Step> <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition> <Name>XML-to-JSON-1</Name> </Step> <Step> <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition> <Name>Verify-Auth-1</Name> </Step> </Request> </Flow> </Flows> ... </ProxyEndpoint>
Edge یکی از این خطمشیها را براساس پسوند مسیری که از متغیر جاری proxy جمعآوری میکند اجرا میکند. اگر پسوند مسیر با هیچیک از این شرایط مطابقت نداشته باشد،
Edge این جریان را اجرا نمیکند.
مثال ۲
مثال زیر چندین عنصر <Flow> را در <Flows> نشان میدهد که هرکدام
<Condition> خود را دارند:
<!-- api-platform/reference/examples/flow-segments/flows-2.xml --> <ProxyEndpoint name="default"> <Flows> <Flow name="my-flow-1"> <Response> <Step> <Condition>response.status.code = 200</Condition> <Name>Assign-Message-1</Name> </Step> </Response> </Flow> <Flow name="my-flow-2"> <Response> <Step> <Condition>response.status.code >= 400</Condition> <Name>Assign-Message-2</Name> </Step> </Response> </Flow> <Flow name="my-flow-3"> <Response> <Step> <Condition>response.status.code >= 300</Condition> <Name>Assign-Message-3</Name> </Step> </Response> </Flow> </Flows> ... </ProxyEndpoint>
Edge فقط اولین جاریسازی را در بخشی که شرط آن به درست ارزیابی میشود اجرا میکند. پساز آن، Edge از جریانهای باقیمانده در بخش میگذرد.
مثال ۳
مثال زیر <Flow> «پیشفرض» را نشان میدهد:
<!-- api-platform/reference/examples/flow-segments/flows-3.xml --> <ProxyEndpoint name="default"> <Flows> <Flow name="my-conditional-flow-1"> <Response> <Step> <Condition>response.status.code = 200</Condition> <Name>Assign-Message-1</Name> </Step> </Response> </Flow> <Flow name="my-conditional-flow-2"> <Response> <Step> <Condition>response.header.someheader = "42"</Condition> <Name>Assign-Message-2</Name> </Step> </Response> </Flow> <Flow name="my-default-flow"> <Response> <Step> <Name>Assign-Message-3</Name> </Step> </Response> </Flow> </Flows> ... </ProxyEndpoint>
Edge فقط اولین جاریسازی را در بخشی که شرط آن به درست ارزیابی میشود اجرا میکند. اگر جریان شرطی اجرا نشود، جریان سوم در این مثال (بدون شرط) اجرا میشود.
جریان پیشفرض میتواند ابزاری مفید در محافظت دربرابر حملههای مخرب باشد.
مشخصهها
عنصر <Flows> هیچ مشخصهای ندارد.
عناصر فرزند
عنصر <Flows> عناصر فرزند زیر را دارد:
| عنصر فرزند | نوع | شرح |
|---|---|---|
<Flow> |
شیء پیچیده | جریانی که یک مجموعه ممکن از مراحل را در «جریان شرطی» تعریف میکند. |
<Name>
شناسه خطمشی را برای اجرا در <Flow> مشخص میکند.
| تایپ کردن | رشته |
| عنصر(های) والد | <Step> |
| عنصر(های) فرزند | خالی |
نحو
عنصر <Name> از نحو زیر استفاده میکند:
<Name>policy_name</Name>
مثال
مثال زیر دو خطمشی را نشان میدهد که براساس نامشان به جاریسازیها اضافه شدهاند:
<!-- api-platform/reference/examples/flow-segments/name-1.xml --> <ProxyEndpoint name="default"> <Flows name="my-conditional-flows"> <Flow name="reports"> <Request> <Description>Based on the path suffix, determine which flow to use</Description> <Step> <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition> <Name>XML-to-JSON-1</Name> </Step> <Step> <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition> <Name>Verify-Auth-1</Name> </Step> </Request> </Flow> </Flows> ... </ProxyEndpoint>
مشخصهها
عنصر <Name> هیچ مشخصهای ندارد.
عناصر فرزند
عنصر <Name> هیچ عنصر فرزندی ندارد.
<PostFlow>
مراحل انجام در «جریان پس از درخواست» و پاسخ را تعریف میکند.
| تایپ کردن | شیء پیچیده |
| عنصر(های) والد | <ProxyEndpoint><TargetEndpoint> |
| عنصر(های) فرزند | <Description><Request><Response> |
عنصر <PostFlow> از نحو زیر استفاده میکند:
نحو
<PostFlow name="flow_name">
<Description>flow_description</Description>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</PostFlow>مثال
مثال زیر PostFlow را با مراحلی برای درخواست و پاسخ تعریفشده نشان میدهد: :
<!-- api-platform/reference/examples/flow-segments/postflow-1.xml --> <ProxyEndpoint name="default"> <PostFlow name="my-postflows"> <Description>My first PostFlow</Description> <Request> <Step> <Condition>request.verb = "GET"</Condition> <Name>Log-Request-OK</Name> </Step> </Request> <Response> <Step> <Name>Set-Response-Headers</Name> </Step> </Response> </PostFlow> ... </ProxyEndpoint>
مشخصهها
جدول زیر مشخصههای عنصر <PostFlow> را شرح میدهد:
| مشخصه | نوع | شرح |
|---|---|---|
name |
رشته | شناسه یکتای جریان (درون نقطه پایانی یکتا است). برای مثال، «My-PostFlow-1». مقدار نمیتواند شامل فاصله یا نویسههای خاص دیگر باشد. |
عناصر فرزند
جدول زیر عناصر فرزند <PostFlow> را شرح میدهد:
| عنصر فرزند | نوع | شرح |
|---|---|---|
<Description> |
رشته | شرح مختصری از جریان ارائه میدهد. |
<Request> |
شیء پیچیده | خطمشیهایی را که باید درطول «جریان پساز درخواست» اجرا شوند تعریف میکند. |
<Response> |
شیء پیچیده | خطمشیهایی را که باید درطول «جریان پس از پاسخ» اجرا شوند تعریف میکند. |
<PostClientFlow>
خطمشیهایی را در ProxyEndpoint تعریف میکند که فقط پساز اینکه پاسخی به کاربر برگردانده شد اجرا میشوند. این خطمشیها معمولاً پیامهای مربوط به پاسخ را ثبت میکنند.
| تایپ کردن | شیء پیچیده |
| عنصر(های) والد | <ProxyEndpoint> |
| عنصر(های) فرزند | <Description><Response> |
نحو
عنصر <PostClientFlow> از نحو زیر استفاده میکند:
<PostClientFlow name="flow_name">
<Description>flow_description</Description>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</PostClientFlow>همه عناصر فرزند <PostClientFlow> اختیاری هستند.
مثال
مثال زیر یک PostClientFlow ساده را نشان میدهد که یک خطمشی واحد را اجرا میکند:
<!-- api-platform/reference/examples/flow-segments/postclientflow-1.xml --> <ProxyEndpoint name="default"> <PostClientFlow name="my-postclientflows"> <Description>My first PostClientFlow. Processed after the response is sent back to the client.</Description> <Response> <Step> <Name>Message-Logging-OK</Name> </Step> </Response> </PostClientFlow> ... </ProxyEndpoint>
مشخصهها
جدول زیر مشخصههای عنصر <PostClientFlow> را شرح میدهد:
| مشخصه | نوع | شرح |
|---|---|---|
name |
رشته | شناسه یکتای جریان. نام نمیتواند شامل فاصله یا نویسههای خاص دیگر باشد. برای مثال، «My-PostClientFlow-1». |
عناصر فرزند
جدول زیر عناصر فرزند <PostClientFlow> را شرح میدهد:
| عنصر فرزند | نوع | شرح |
|---|---|---|
<Description> |
رشته | شرح مختصری از جریان ارائه میدهد. |
<Response> |
شیء پیچیده | خطمشیهایی را که باید درطول «جریان پس از پاسخ» اجرا شوند تعریف میکند. |
<PreFlow>
خطمشیهای اجرا در «جریان پیشاز» درخواست و پاسخ را تعریف میکند.
| تایپ کردن | شیء پیچیده |
| عنصر(های) والد | <ProxyEndpoint><TargetEndpoint> |
| عنصر(های) فرزند | <Description><Request><Response> |
نحو
عنصر <PreFlow> از نحو زیر استفاده میکند:
<PreFlow name="flow_name">
<Description>flow_description</Description>
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>
</PreFlow>همه عناصر فرزند <PreFlow> اختیاری هستند.
مثال
نمونه زیر یک «جریان پیشازجریان» را با جریان درخواست و جریان پاسخ تعریفشده نشان میدهد:
<!-- api-platform/reference/examples/flow-segments/preflow-1.xml --> <ProxyEndpoint name="default"> <PreFlow name="my-preFlows"> <Description>My first PreFlow</Description> <Request> <Step> <Condition>request.verb = "GET"</Condition> <Name>Log-Request-OK</Name> </Step> </Request> <Response> <Step> <Condition>response.status.code LesserThanOrEquals 300</Condition> <Name>Log-Response-OK</Name> </Step> <Step> <Condition>response.status.code GreaterThan 300</Condition> <Name>Log-Response-NOT-OK</Name> </Step> </Response> </PreFlow> ... </ProxyEndpoint>
مشخصهها
جدول زیر مشخصههای عنصر <PreFlow> را شرح میدهد:
| مشخصه | نوع | شرح |
|---|---|---|
name |
رشته | شناسه یکتای جریان. نام نمیتواند شامل فاصله یا نویسههای خاص دیگر باشد. برای مثال، «My-PreFlow-1». |
عناصر فرزند
جدول زیر عناصر فرزند <PreFlow> را شرح میدهد:
| عنصر فرزند | نوع | شرح |
|---|---|---|
<Description> |
رشته | شرح مختصری از جریان ارائه میدهد. |
<Request> |
شیء پیچیده | خطمشیهایی را که باید درطول «جریان پیشاز درخواست» اجرا شوند تعریف میکند. |
<Response> |
شیء پیچیده | خطمشیهایی را که باید درطول «جریان پیشاز پاسخ» اجرا شوند تعریف میکند. |
<Request>
خطمشیهایی را که باید درطول بخش درخواست جریان اجرا شوند تعریف میکند.
| تایپ کردن | شیء پیچیده |
| عنصر(های) والد | <Flow><PreFlow><PostFlow> |
| عنصر(های) فرزند | <Condition><Step> |
نحو
عنصر <Request> از نحو زیر استفاده میکند:
<Request>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Request>همه عناصر فرزند <Request> اختیاری هستند.
مثال
مثال زیر جریانهای تعریفشده برای درخواست را هم در PreFlow و هم در PostFlow نشان میدهد:
<!-- api-platform/reference/examples/flow-segments/request-1.xml --> <ProxyEndpoint name="default"> <PreFlow name="my-preFlows"> <Description>My first PreFlow</Description> <Request> <Step> <Condition>request.verb = "GET"</Condition> <Name>Log-Request-OK</Name> </Step> </Request> </PreFlow> <PostFlow name="my-postflows"> <Description>My first PostFlow</Description> <Request> <Step> <Condition>request.verb = "GET"</Condition> <Name>Log-Request-OK</Name> </Step> </Request> </PostFlow> ... </ProxyEndpoint>
مشخصهها
عنصر <Request> هیچ مشخصهای ندارد.
عناصر فرزند
جدول زیر عناصر فرزند <Request> را شرح میدهد:
| عنصر فرزند | نوع | شرح |
|---|---|---|
<Condition> |
شیء پیچیده | تعیین میکند که آیا مراحل درون بخش درخواست اجرا شود یا نه. |
<Step> |
رشته | خطمشیای را برای اجرا در بخش درخواست مشخص میکند. |
<Response>
خطمشیهای اجرا درطول بخش پاسخ جریان را تعریف میکند.
| تایپ کردن | شیء پیچیده |
| عنصر(های) والد | <Flow><PreFlow><PostClientFlow><PostFlow> |
| عنصر(های) فرزند | <Condition><Step> |
نحو
عنصر <Response> از نحو زیر استفاده میکند:
<Response>
<Step>
<Condition>property operator "value"</Condition>
<Name>policy_name</Name>
</Step>
...
</Response>همه عناصر فرزند <Response> اختیاری هستند.
مثال
مثال زیر جریانهایی را نشان میدهد که برای پاسخ تعریف شدهاند، هم در PreFlow و هم در PostFlow:
<!-- api-platform/reference/examples/flow-segments/response-1.xml --> <ProxyEndpoint name="default"> <PreFlow name="my-preFlows"> <Description>My first PreFlow</Description> <Response> <Step> <Condition>response.status.code LesserThanOrEquals 300</Condition> <Name>Log-Response-OK</Name> </Step> <Step> <Condition>response.status.code GreaterThan 300</Condition> <Name>Log-Response-NOT-OK</Name> </Step> </Response> </PreFlow> <PostFlow name="my-postflows"> <Description>My first PostFlow</Description> <Response> <Step> <Name>Set-Response-Headers</Name> </Step> </Response> </PostFlow> ... </ProxyEndpoint>
مشخصهها
عنصر <Response> هیچ مشخصهای ندارد.
عناصر فرزند
جدول زیر عناصر فرزند <Response> را شرح میدهد:
| عنصر فرزند | نوع | شرح |
|---|---|---|
<Condition> |
رشته | تعیین میکند که آیا مراحل درون بخش پاسخ اجرا شوند یا نه. |
<Step> |
رشته | خطمشیای را برای اجرا در بخش پاسخ مشخص میکند. |
<Step>
خطمشیای را برای اجرا و (اختیاری) شرطی را که تعیین میکند آیا آن خطمشی اجرا شود یا نه مشخص میکند.
| تایپ کردن | شیء پیچیده |
| عنصر(های) والد | <Request><Response> |
| عنصر(های) فرزند | <Condition><Name> |
در <Flow> میتوان بیشاز یک مرحله تعریف کرد و مراحل به ترتیبی که در XML جریان تعریف شدهاند اجرا میشوند.
مراحل بدون شرط همیشه اجرا میشوند. مراحل دارای شرط فقط درصورتی اجرا میشوند که شرط بهدرستی ارزیابی شود. اگر شرط به نادرست ارزیابی شود، Edge از این مرحله رد میشود.
نحو
عنصر <Step> از نحو زیر استفاده میکند:
<Step> <Condition>property operator "value"</Condition> <Name>policy_name</Name> </Step>
فقط یک <Condition> و یک <Name> در هر <Step> میتواند وجود داشته باشد، اما در <Flow> میتواند
چندین مرحله وجود داشته باشد.
همه عناصر فرزند <Step> اختیاری هستند.
مثال ۱
مثال زیر یک مرحله با شرط و یک مرحله بدون شرط را نشان میدهد:
<!-- api-platform/reference/examples/flow-segments/step-1.xml --> <ProxyEndpoint name="default"> <PostFlow name="my-postflows"> <Description>My first PostFlow</Description> <Request> <Step> <Condition>request.verb = "GET"</Condition> <Name>Log-Request-OK</Name> </Step> </Request> <Response> <Step> <Name>Set-Response-Headers</Name> </Step> </Response> </PostFlow> ... </ProxyEndpoint>
مرحله بدون شرط هر بار درطول بخش درخواست اجرا خواهد شد. این مرحله با شرط فقط زمانی اجرا میشود که درخواست درطول بخش پاسخ «دریافت» باشد.
مثال ۲
مثال زیر چند مرحله را در یک بخش نشان میدهد:
<!-- api-platform/reference/examples/flow-segments/step-2.xml --> <ProxyEndpoint name="default"> <PostFlow name="PostFlow"> <Response> <Step> <Name>Assign-Message-1</Name> </Step> <Step> <Name>Assign-Message-2</Name> </Step> </Response> </PostFlow> ... </ProxyEndpoint>
مراحل بدون شرط همیشه اجرا میشوند.
مشخصهها
عنصر <Step> هیچ مشخصهای ندارد.
عناصر فرزند
جدول زیر عناصر فرزند <Step> را شرح میدهد:
| عنصر فرزند | نوع | شرح |
|---|---|---|
<Condition> |
رشته | بیانیه شرطی را برای مرحلهای که در زمان اجرا پردازش میشود تعریف میکند. اگر عبارت به درست ارزیابی شود، Edge مرحله را اجرا میکند. اگر عبارت به نادرست ارزیابی شود، Edge از این مرحله رد میشود. |
<Name> |
رشته | شناسه خطمشی را برای اجرا در جریان فعلی مشخص میکند. |