Skip to content

Offers a library of utilities for building Java-based OpenSearch plugins

License

Notifications You must be signed in to change notification settings

opensearch-project/common-utils

Repository files navigation

OpenSearch Common Utils

OpenSearch Common Utils is focused on providing reusable Java components for OpenSearch 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 and how to contribute to this project.

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 and documentation. If you need help and are unsure where to open an issue, try forums.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com 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. Please do not create a public GitHub issue.

License

This project is licensed under the Apache v2.0 License.

Copyright

Copyright OpenSearch Contributors. See NOTICE for details.