PageRenderTime 52ms CodeModel.GetById 27ms RepoModel.GetById 0ms app.codeStats 0ms

/sdk/aot/azure-aot-graalvm-support-netty/README.md

http://github.com/WindowsAzure/azure-sdk-for-java
Markdown | 82 lines | 64 code | 18 blank | 0 comment | 0 complexity | 44d1d853964c23f0615919bea6f7b59a MD5 | raw file
Possible License(s): MIT
  1. # Azure GraalVM Netty Support client library for Java
  2. The Azure GraalVM Netty Support client library provides support for applications using
  3. [Azure client libraries](https://azure.github.io/azure-sdk/releases/latest/java.html) that take a dependency on
  4. [azure-core-http-netty](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/core/azure-core-http-netty) to be
  5. built as [GraalVM native images](https://www.graalvm.org/22.0/reference-manual/native-image/). The library contains all the necessary
  6. [configuration files](https://www.graalvm.org/22.0/reference-manual/native-image/BuildConfiguration/) and [GraalVM
  7. features](https://www.graalvm.org/sdk/javadoc/index.html?org/graalvm/nativeimage/hosted/Feature.html) required to build
  8. a native image of an application that uses Azure client libraries.
  9. **NOTE:**: This library is a preview and is intended to enable applications using Azure client libraries to quickly
  10. build and validate native images. However, this is not a stable, GA version and is not officially supported to use in production
  11. environments.
  12. ## Getting started
  13. ### Prerequisites
  14. - A [Java Development Kit (JDK)][jdk_link], version 8 or later.
  15. - [Azure Subscription][azure_subscription]
  16. - [GraalVM](https://www.graalvm.org/downloads/) version 22 or later.
  17. - [GraalVM Native Image](https://www.graalvm.org/22.0/reference-manual/native-image/)
  18. ### Include the package
  19. Include both the packages below:
  20. [//]: # ({x-version-update-start;com.azure:azure-aot-graalvm-support;current})
  21. ```xml
  22. <dependency>
  23. <groupId>com.azure</groupId>
  24. <artifactId>azure-aot-graalvm-support</artifactId>
  25. <version>1.0.0-beta.3</version>
  26. </dependency>
  27. ```
  28. [//]: # ({x-version-update-start;com.azure:azure-aot-graalvm-support-netty;current})
  29. ```xml
  30. <dependency>
  31. <groupId>com.azure</groupId>
  32. <artifactId>azure-aot-graalvm-support-netty</artifactId>
  33. <version>1.0.0-beta.3</version>
  34. </dependency>
  35. ```
  36. ## Key concepts
  37. Please refer to the [Key Concepts](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/aot/azure-aot-graalvm-support#key-concepts) section of the azure-aot-graalvm-support library.
  38. ## Examples
  39. Please refer to the [Examples](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/aot/azure-aot-graalvm-support#examples) section of the
  40. `azure-aot-graalvm-support` library.
  41. ## Troubleshooting
  42. Please refer to the [Troubleshooting](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/aot/azure-aot-graalvm-support#troubleshooting) section of the
  43. `azure-aot-graalvm-support` library.
  44. ## Next steps
  45. Please refer to the [Next Steps](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/aot/azure-aot-graalvm-support#next-steps) section of the
  46. `azure-aot-graalvm-support` library.
  47. ## Contributing
  48. This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License
  49. Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.
  50. For details, visit [https://cla.microsoft.com](https://cla.microsoft.com).
  51. When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the
  52. PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this
  53. once across all repos using our CLA.
  54. This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
  55. For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
  56. [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
  57. <!-- LINKS -->
  58. [cla]: https://cla.microsoft.com
  59. [coc]: https://opensource.microsoft.com/codeofconduct/
  60. [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
  61. [coc_contact]: mailto:opencode@microsoft.com
  62. [jdk_link]: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable
  63. [azure_subscription]: https://azure.microsoft.com/free
  64. ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Faot%2Fazure-aot-graalvm-support-netty%2FREADME.png)