Changes for page Multipart form-data
Last modified by Erik Bakker on 2024/06/17 11:39
From version 18.1
edited by Erik Bakker
on 2022/08/05 14:24
on 2022/08/05 14:24
Change comment:
There is no comment for this version
To version 10.1
edited by Erik Bakker
on 2022/07/26 13:17
on 2022/07/26 13:17
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Multipartform-data1 +expert-securing-data-traffic-api-gw-security-external-idp - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - Sometimeswhenyoucall an externalRESTendpoint,theyrequire youtosendmeta information and one or more "attachments"in one calltotheRESTendpoint.To makethis possible,youneedtondtheinformationwiththecontentTypealledmultipart/form-data. In this microlearning, we will discusshowyoucanconfigureavalidmessagewithinthe eMagizplatformthat allows youtosendoutmessageswith thiscontentType andhave themacceptedby theendpointinquestion.2 +In the crash course on the API Gateway we discussed the various options available to [[secure>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-security.WebHome||target="blank"]] your API Gateway properly. In this microlearning, we will expand our knowledge on that topic by looking at a special case of securing your API Gateway. That case is special as you use an external identity provider (IDP) to govern the roles and users that have rights on your API Gateway. 3 3 4 4 Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 5 5 ... ... @@ -9,65 +9,55 @@ 9 9 10 10 == 2. Key concepts == 11 11 12 -This microlearning focuses on configuring amultipart/form-data message within eMagiz toensureit is sentcorrectly toan endpoint.12 +This microlearning focuses on performing image transformations in eMagiz. 13 13 14 - Key aspects are:14 +By image transformation, we mean transforming the raw data that represents an image into another image format. 15 15 16 -* Definingtheboundary that separatesthe partsofthemessage17 -* Definingthecontenttypesofeachpartofthemessage18 -* Constructionofthecompletemessageaccording to thespecification16 +* Read the help text of the component to understand which formats are supported 17 +* Ensure the input image is supplied in the correct format 18 +* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream 19 19 20 -== 3. Multipartform-data==20 +== 3. Image Transformation == 21 21 22 - Sometimeswhenyoucall an externalRESTendpoint, theyrequire youtosend metainformationandone or more"attachments"inonecall to theRESTendpoint.To makehispossible,you needtosendtheinformationwith thecontentType calledmultipart/form-data. In this microlearning,we will discuss howyou can configurea validmessagewithintheeMagizplatformthatallowsyoutosendout messageswiththis contentTypeand have themacceptedbytheendpoint inquestion.22 +In most cases, you will transform XML messages to other XML messages, or you will transform JSON or EDI messages in another of these formats. However, sometimes you want to perform an image transformation. With this image transformation, you can convert images in specific formats to another format (i.e., png). This can come in handy when you want to standardize the image format before using it further downstream in your business application(s). 23 23 24 - Keyaspectsare:24 +Before we dive into the specifics of how to configure this, let us first consider the following: 25 25 26 -* Definingtheboundary that separatesthe partsofthemessage27 -* Definingthecontenttypesofeachpartofthemessage28 -* Constructionofthecompletemessageaccording to thespecification26 +* Read the help text of the component to understand which formats are supported 27 +* Ensure the input image is supplied in the correct format 28 +* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream 29 29 30 - Toactually construct the message there a several stepsneeded to makeit work. Luckily, most of the stepsneededhave to do with conceptswe have already discussed in previousmicrolearnings.As youcan imaginebasedon whatmulipart/form-dataentailsweneeda wayto bothstorethemetainformationand the file(s)wewant to sendto theexternalparty. Todosoit isadvisabletoput themetadatainone(or multiple)header(s)andusetheilecontentas payload. Thisyoucanachievewith a headerenricher and standard transformer.30 +{{warning}} This microlearning focuses on the image transformer component. Ensuring that the input is valid and the output fits the remainder of the process is highly dependent on the use case and will therefore not be discussed in this microlearning{{/warning}} 31 31 32 - Once thefilecontentisyourpayloadyouneed tomakesurethat thedata is "raw"in nature.Sowhenyou haveabase64encodedstringyoushoulddecode thestringbefore sendingitto theendpoint.32 +When turning to the Create phase of eMagiz, we need to open the flow and enter "Start Editing" mode to add the necessary component. For example, in the left panel, you can search for "Image." This will yield the following result. 33 33 34 - On top of that weed todefinetheType headerllows.34 +[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.png]] 35 35 36 - Mostuserswouldthinkthatcommunicationvia queuestoconnecttwoseparateeMagizmodelsisa brightidea. However,this is somethingthat we donot encourage. We discouragethisfor several practical and technicalreasons alike.36 +After dragging the component onto the canvas, you must define the channels first. 37 37 38 - When lookingat thepractical side of things getting itconfigured correctly is time-consumingand anerror-pronection (as isevident bythe question). Furthermore, it canlead to unexpectedsituations where youmake atypo to listen toa queue onwhich nomessages are provided. This queue will, however, be registered on the JMS level (when youactivate the flow inquestion with the custom configuration), which can lead to confusingqueue statistics and even more troublesome false-positive alerting basedonmissing queue metricsormissing consumers.38 +[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-help.png]] 39 39 40 - On top of that, whenyouallow onemodelowriteandread from queuesregistered inanothermodel,maintainingboth modelswillbecomevery complex.This holdsfortheonesworking on the projectatthemomentbutalsoforthoseworking on it at alater stageand doesthatneedto provide(incidental) supporton thenvironments.40 +Secondly, we must select the desired image format we want to transform. Finally, the field indicates all valid values you can choose. Please note that 'PNG' is the default selection. 41 41 42 - Another practical reason fornot wantingthis is that wedonotactivelysupportthis use casefromeMagiz. Thiseans that when we update ourtechnical infrastructure, we will not considerthis scenario. Thiscould leadto additional work inthefuture and reduced stabilityof your solution.42 +[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-image-options.png]] 43 43 44 - From the technicalpointofview,the consequenceofthisconstruction is thatbothmodelsneed to know each othercertificates andcredentials,which arenot consideredsecure. On top of that,becauseyou,theoretically, canexchange dataromanyqueue toany queue, you could createa situationin which updatesin onemodel trigger changesintheothermodel (i.e., when using thesamedatamodel)that areunexpected (andfrankly unwanted).44 +Once you have done this, the component configuration is finished, and you can transform your input image to a desired output image format. 45 45 46 -We advise using functionality that makes it explicit that both models function independently of each other. From eMagiz, we consider two valid alternatives for this: 47 -- Using a web service as a communication layer between the two models. This web service can be REST or SOAP and has been implemented before 48 -- Using the Event Streaming functionality of eMagiz to write and read from topics. 49 - 50 -Both alternatives have the benefit that the security can be tight and explicit (i.e., only model A can write/post data to model B). Furthermore, managing the solution becomes much easier as it uses the standard functionality within the platform. Therefore, we have no plans to support this approach in the product. 51 - 52 52 == 4. Assignment == 53 53 54 -C onsiderwhatyour criteriaare whencommunicatingbetweenmodelsand compare themtoourcriteria.55 -This assignment can be completed with the help of the(Academy) project you created/used in the previous assignment.48 +Check whether the solution we discussed today can be found within your project. 49 +This assignment can be completed within the (Academy) project you created/used in the previous assignment. 56 56 57 57 == 5. Key takeaways == 58 58 59 -* Consider the following when communication between two models 60 -** Security 61 -** Loose coupling 62 -** Maintainability 63 -** Clarity 53 +* Read the help text of the component to understand which formats are supported 54 +* Ensure the input image is supplied in the correct format 55 +* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream 64 64 65 65 == 6. Suggested Additional Readings == 66 66 67 -If you are interested in this topic please read the helptext sin theplatform andreadthefollowinglink:59 +If you are interested in this topic and want more information, please read the help text provided by eMagiz. 68 68 69 -* https://www.sobyte.net/post/2021-12/learn-about-http-multipart-form-data/ 70 - 71 71 == 7. Silent demonstration video == 72 72 73 73 As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}