PageRenderTime 22ms CodeModel.GetById 31ms RepoModel.GetById 1ms app.codeStats 0ms

/sdk/storage/azure-storage-common/README.md

http://github.com/WindowsAzure/azure-sdk-for-java
Markdown | 104 lines | 77 code | 27 blank | 0 comment | 0 complexity | a8ad0f0a4000e31ab465fd0a80923115 MD5 | raw file
Possible License(s): MIT
  1. # Azure Storage Common shared library for Java
  2. Azure Storage Common is a library that has common dependencies for all Azure Storage packages.
  3. [Source code][source] | [API reference documentation][docs]
  4. ## Getting started
  5. ### Prerequisites
  6. - [Java Development Kit (JDK)][jdk] with version 8 or above
  7. - [Azure Subscription][azure_subscription]
  8. - [Create Storage Account][storage_account]
  9. ### Include the package
  10. #### Include the BOM file
  11. Please include the azure-sdk-bom to your project to take dependency on GA version of the library. In the following snippet, replace the {bom_version_to_target} placeholder with the version number.
  12. To learn more about the BOM, see the [AZURE SDK BOM README](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/boms/azure-sdk-bom/README.md).
  13. ```xml
  14. <dependencyManagement>
  15. <dependencies>
  16. <dependency>
  17. <groupId>com.azure</groupId>
  18. <artifactId>azure-sdk-bom</artifactId>
  19. <version>{bom_version_to_target}</version>
  20. <type>pom</type>
  21. <scope>import</scope>
  22. </dependency>
  23. </dependencies>
  24. </dependencyManagement>
  25. ```
  26. and then include the direct dependency in the dependencies section without the version tag.
  27. ```xml
  28. <dependencies>
  29. <dependency>
  30. <groupId>com.azure</groupId>
  31. <artifactId>azure-storage-common</artifactId>
  32. </dependency>
  33. </dependencies>
  34. ```
  35. #### Include direct dependency
  36. If you want to take dependency on a particular version of the library that is not present in the BOM,
  37. add the direct dependency to your project as follows.
  38. [//]: # ({x-version-update-start;com.azure:azure-storage-common;current})
  39. ```xml
  40. <dependency>
  41. <groupId>com.azure</groupId>
  42. <artifactId>azure-storage-common</artifactId>
  43. <version>12.16.0</version>
  44. </dependency>
  45. ```
  46. [//]: # ({x-version-update-end})
  47. ## Key concepts
  48. ## Examples
  49. ## Troubleshooting
  50. ### Default HTTP Client
  51. All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure
  52. the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the
  53. [HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients).
  54. ### Default SSL library
  55. All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL
  56. operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides
  57. better performance compared to the default SSL implementation within the JDK. For more information, including how to
  58. reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki.
  59. ## Next steps
  60. ## Next steps Samples
  61. ## Contributing
  62. This project welcomes contributions and suggestions. Most contributions require you to agree to a [Contributor License Agreement (CLA)][cla] declaring that you have the right to, and actually do, grant us the rights to use your contribution.
  63. When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
  64. This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.
  65. <!-- LINKS -->
  66. [source]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/storage/azure-storage-common/src
  67. [samples_readme]: src/samples/README.md
  68. [docs]: https://azure.github.io/azure-sdk-for-java/
  69. [sas_token]: https://docs.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1
  70. [jdk]: https://docs.microsoft.com/java/azure/jdk/
  71. [azure_subscription]: https://azure.microsoft.com/free/
  72. [storage_account]: https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal
  73. [cla]: https://cla.microsoft.com
  74. [coc]: https://opensource.microsoft.com/codeofconduct/
  75. [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
  76. [coc_contact]: mailto:opencode@microsoft.com
  77. ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fstorage%2Fazure-storage-common%2FREADME.png)