https://github.com/opensearch-project/common-utils
Offers a library of utilities for building Java-based OpenSearch plugins
https://github.com/opensearch-project/common-utils
Last synced: 2 months ago
JSON representation
Offers a library of utilities for building Java-based OpenSearch plugins
- Host: GitHub
- URL: https://github.com/opensearch-project/common-utils
- Owner: opensearch-project
- License: apache-2.0
- Created: 2021-04-02T21:21:37.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T03:50:57.000Z (about 1 year ago)
- Last Synced: 2024-04-13T21:00:40.936Z (about 1 year ago)
- Language: Kotlin
- Homepage:
- Size: 1.36 MB
- Stars: 17
- Watchers: 15
- Forks: 89
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/opensearch-project/common-utils)
- [OpenSearch Common Utils](#opensearch-common-utils)
- [Contributing](#contributing)
- [Getting Help](#getting-help)
- [Code of Conduct](#code-of-conduct)
- [Security](#security)
- [License](#license)
- [Copyright](#copyright)
## OpenSearch Common Utils
OpenSearch Common Utils is focused on providing reusable Java components for [OpenSearch](https://opensearch.org/) plugins.
This library is composed of following parts:
1. `SecureRestClientBuilder` - provides methods to create secure low-level and high-level REST client. This is useful to make secure REST calls to OpenSearch or other plugin APIs.
2. `InjectSecurity` - provides methods to inject user or roles. This is useful for running background jobs securely.
3. `IntegTestsWithSecurity` - provides methods to create users, roles for running integration tests with security plugin.
4. Shared request/response/action classes used for plugin to plugin transport layer calls.
5. Any common functionality across OpenSearch plugins could be moved to this.
## Contributing
See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md).
## Getting Help
If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.
For more information, see [project website](https://opensearch.org/) and [documentation](https://docs-beta.opensearch.org/). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/).
## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## Security
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.
## License
This project is licensed under the [Apache v2.0 License](LICENSE.txt).
## Copyright
Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.