{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The functions described in this section are used to decode binary encoded Avro messages.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following functions for AVRO Decoding/Encoding described here are:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"1"}},"macroMetadata":{"macroId":{"value":"7cf48fbb-e57c-4a32-a45d-9c6458983ce6"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"53d939a1-a572-4dd7-9c94-b1f1e4ba86b7"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"avroInitialize","type":"text"}]},{"type":"paragraph","content":[{"text":"This function initialises a schema registry provider that is used to obtain schemas used in ","type":"text"},{"text":"avroDeserialize","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"avroSerialize","type":"text","marks":[{"type":"em"}]},{"text":" functions","type":"text"}]},{"type":"codeBlock","content":[{"text":"void avroInitialize(string schemaRegistry, string schemaField)","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"928a2e82-49ea-4c97-9e3c-64c03083697f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"schemaRegistry","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The binary encoded Avro message to decode","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"schemaField","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A DynamicAvro UDR ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"avroDeserialize","type":"text"}]},{"type":"paragraph","content":[{"text":"This function decodes a binary encoded Avro message to a DynamicAvro UDR ","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"DynamicAvro avroDeserialize ( AvroDecoderUDR avroDecoderUDR)","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"3282601e-81b6-436e-89db-0c91c1cd3008"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"avroDecoderUDR","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"AvroDecoderUDR containing a bytearray with a binary encoded Avro message to decode","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A DynamicAvro UDR containing decoded message ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"avroDeserialize function has to be used inside try-catch block if the exception handling is required","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Example - Decoding AVRO binary encoded message","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"import apl.Avro;\n \ninitialize\n{\n string schemaRegistry = \"http://localhost:8081/schemas/ids\";\n string schemaField = \"schema\";\n avroInitialize(schemaRegistry, schemaField);\n}\n \nconsume {\n //This example assumes that the input of an analysis agent is a bytearray\n //representing complete Avro message\n debug(input);\n Avro.AvroDecoderUDR decoder = udrCreate(Avro.AvroDecoderUDR);\n decoder.readerSchemaID = \"5\";\n decoder.writerSchemaID = \"5\";\n decoder.data = input;\n Avro.DynamicAvro decodedAvro = (Avro.DynamicAvro)Avro.avroDeserialize(decoder);\n debug(decodedAvro);\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"avroSerialize","type":"text"}]},{"type":"paragraph","content":[{"text":"This function encodes a schema defined structure using binary Avro encoder","type":"text"}]},{"type":"codeBlock","content":[{"text":"bytearray avroSerialize ( AvroEncoderUDR avroEncoderUDR ) ","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"avroSerialize function has to be used inside try-catch block if the exception handling is required","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c1345d3a-013a-4f24-b389-64bd4e9f385a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"avroEncoderUDR","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"AvroEncoderUDR containing data to encode and specifying selected schemaID (data must match selected schema)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"binary encoded Avro message","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Encoding UDR to AVRO","type":"text"}]},{"type":"paragraph","content":[{"text":" APL:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"import apl.Avro;\n \nstring writerSchemaID = \"5\"; // assumes the correct registered schema is \"5\"\n\ninitialize\n{\n string schemaRegistry = \"http://localhost:8081/schemas/ids\";\n string schemaField = \"schema\";\n avroInitialize(schemaRegistry, schemaField);\n}\n \nconsume {\n Avro.AvroRecordUDR record = create_output();\n Avro.AvroEncoderUDR encode_UDR = udrCreate(Avro.AvroEncoderUDR);\n encode_UDR.data = record;\n encode_UDR.writerSchemaID = writerSchemaID;\n bytearray serializedPayload = Avro.avroSerialize(encode_UDR);\n}\n \n \nAvro.AvroRecordUDR create_output(){\n \n Avro.AvroRecordUDR record = udrCreate(Avro.AvroRecordUDR);\n record.fullname = \"example.avro.User3\";\n map fieldz = mapCreate(string,any);\n \n // name\n Avro.AvroRecordUDR name = udrCreate(Avro.AvroRecordUDR);\n map namefields = mapCreate(string,any);\n mapSet(namefields, \"firstName\", \"\");\n mapSet(namefields, \"lastName\", \"Kula\");\n name.fullname = \"example.avro.FullName2\";\n name.fields = namefields;\n mapSet(fieldz, \"name\", name);\n \n // favorite number\n mapSet(fieldz, \"favorite_number\", (int)1632); \n // colour\n mapSet(fieldz, \"favorite_color\", \"Green\");\n // football team (spelled with one \"o\" in schema)\n Avro.AvroEnumUDR favorite_fotball_team = udrCreate(Avro.AvroEnumUDR);\n favorite_fotball_team.fullname = \"example.avro.teams.teams\";\n favorite_fotball_team.symbol = \"Djurgarden\";\n mapSet(fieldz, \"favorite_fotball_team\", favorite_fotball_team);\n \n // IP address\n list ipAddresslist = listCreate(any);\n Avro.AvroFixedUDR ipv4Address = udrCreate(Avro.AvroFixedUDR);\n ipv4Address.fullname = \"example.avro.ipv4Address\";\n ipv4Address.bytes = baCreateFromHexString(\"00ABCDEF\");\n listAdd(ipAddresslist, ipv4Address);\n Avro.AvroFixedUDR ipv6Address = udrCreate(Avro.AvroFixedUDR);\n ipv6Address.fullname = \"example.avro.ipv6Address\";\n ipv6Address.bytes = baCreateFromHexString(\"00ABCDEFEFEFEFEFEFEFEFEFEFEFEFEF\");\n listAdd(ipAddresslist, ipv6Address);\n mapSet(fieldz, \"ipAddresses\", ipAddresslist);\n \n // favoriteFoodList\n Avro.AvroRecordUDR favoriteFoodList = udrCreate(Avro.AvroRecordUDR);\n Avro.AvroRecordUDR dish1 = udrCreate(Avro.AvroRecordUDR);\n Avro.AvroRecordUDR dish2 = udrCreate(Avro.AvroRecordUDR);\n Avro.AvroRecordUDR dish3 = udrCreate(Avro.AvroRecordUDR);\n map dish3Map = mapCreate(string,any);\n mapSet(dish3Map, \"dish\", \"Brown beans\");\n mapSet(dish3Map, \"next\", null);\n dish3.fields = dish3Map;\n dish3.fullname = \"example.avro.favoriteFood\";\n map dish2Map = mapCreate(string,any);\n mapSet(dish2Map, \"dish\", \"Pannkakor\");\n mapSet(dish2Map, \"next\", dish3);\n dish2.fields = dish2Map;\n dish2.fullname = \"example.avro.favoriteFood\";\n map dish1Map = mapCreate(string,any);\n mapSet(dish1Map, \"dish\", \"Ramen\");\n mapSet(dish1Map, \"next\", dish2);\n dish1.fields = dish1Map;\n dish1.fullname = \"example.avro.favoriteFood\";\n favoriteFoodList.fullname = \"example.avro.favoriteFood\";\n favoriteFoodList.fields = dish1Map;\n mapSet(fieldz, \"favoriteFoodList\", favoriteFoodList);\n \n // salary\n mapSet(fieldz, \"salary\", 347857486343);\n \n // myFixed\n Avro.AvroFixedUDR myFixed = udrCreate(Avro.AvroFixedUDR);\n bytearray myFixed_bytes = baCreateFromHexString(\"DEADBEEF\");\n myFixed.bytes = myFixed_bytes;\n myFixed.fullname = \"example.avro.myfixed\";\n mapSet(fieldz, \"myFixed\", myFixed);\n \n // myFloat\n mapSet(fieldz, \"myFloat\", (float)0.4);\n \n // myDouble\n mapSet(fieldz, \"myDouble\", (double)0.5);\n \n // RootUsers\n map rootUsers = mapCreate(string,any);\n Avro.AvroRecordUDR olleBack = udrCreate(Avro.AvroRecordUDR);\n olleBack.fullname = \"example.avro.RootUsers\";\n map fields1 = mapCreate(string,any);\n mapSet(fields1, \"rootUser\", \"Allan\");\n mapSet(fields1, \"privileges\", (int)3);\n olleBack.fields = fields1;\n \n Avro.AvroRecordUDR nisseHult = udrCreate(Avro.AvroRecordUDR);\n nisseHult.fullname = \"example.avro.RootUsers\";\n map fields2 = mapCreate(string,any);\n mapSet(fields2, \"rootUser\", \"Guran\");\n mapSet(fields2, \"privileges\", (int)2);\n nisseHult.fields = fields2;\n \n mapSet(rootUsers, \"olleBack\", olleBack);\n mapSet(rootUsers, \"nisseHult\", nisseHult);\n mapSet(fieldz, \"rootUsers\", rootUsers);\n \n // array_of_maps\n list array_of_maps = listCreate(any);\n map map1 = mapCreate(string,any);\n Avro.AvroRecordUDR Nyckel = udrCreate(Avro.AvroRecordUDR);\n map nyckelFields = mapCreate(string,any);\n mapSet(nyckelFields,\"favoriteUser\", \"Sture D.Y.\");\n mapSet(nyckelFields,\"favoriteNumber\", (int)10);\n Nyckel.fullname = \"example.avro.some_record\";\n Nyckel.fields = nyckelFields;\n mapSet(map1, \"Nyckel\", Nyckel);\n listAdd(array_of_maps, map1);\n \n map map2 = mapCreate(string,any);\n Avro.AvroRecordUDR Nyckel2 = udrCreate(Avro.AvroRecordUDR);\n map nyckel2Fields = mapCreate(string,any);\n mapSet(nyckel2Fields,\"favoriteUser\", \"Sture D.A.\");\n mapSet(nyckel2Fields,\"favoriteNumber\", (int)12);\n Nyckel2.fullname = \"example.avro.some_record\";\n Nyckel2.fields = nyckel2Fields;\n mapSet(map2, \"Nyckel2\", Nyckel2);\n listAdd(array_of_maps, map2);\n mapSet(fieldz, \"array_of_maps\", array_of_maps);\n \n // debug(\"--------------- fields ------------------\");\n // debug(fieldz);\n // debug(\"--------------- fields ------------------\");\n \n record.fields = fieldz;\n debug(\"-------------- record -------------------\");\n debug(record);\n debug(\"-------------- record -------------------\");\n \n return record;\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported