forked from opensearch-project/geospatial
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement creation of ip2geo feature (opensearch-project#257)
* Update gradle version to 7.6 (opensearch-project#265) Signed-off-by: Vijayan Balasubramanian <[email protected]> * Implement creation of ip2geo feature * Implementation of ip2geo datasource creation * Implementation of ip2geo processor creation Signed-off-by: Heemin Kim <[email protected]> --------- Signed-off-by: Vijayan Balasubramanian <[email protected]> Signed-off-by: Heemin Kim <[email protected]> Co-authored-by: Vijayan Balasubramanian <[email protected]>
- Loading branch information
Showing
29 changed files
with
3,236 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
src/main/java/org/opensearch/geospatial/ip2geo/action/PutDatasourceAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.geospatial.ip2geo.action; | ||
|
|
||
| import org.opensearch.action.ActionType; | ||
| import org.opensearch.action.support.master.AcknowledgedResponse; | ||
|
|
||
| /** | ||
| * Ip2Geo datasource creation action | ||
| */ | ||
| public class PutDatasourceAction extends ActionType<AcknowledgedResponse> { | ||
| /** | ||
| * Put datasource action instance | ||
| */ | ||
| public static final PutDatasourceAction INSTANCE = new PutDatasourceAction(); | ||
| /** | ||
| * Put datasource action name | ||
| */ | ||
| public static final String NAME = "cluster:admin/geospatial/datasource/put"; | ||
|
|
||
| private PutDatasourceAction() { | ||
| super(NAME, AcknowledgedResponse::new); | ||
| } | ||
| } |
168 changes: 168 additions & 0 deletions
168
src/main/java/org/opensearch/geospatial/ip2geo/action/PutDatasourceRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.geospatial.ip2geo.action; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.MalformedURLException; | ||
| import java.net.URISyntaxException; | ||
| import java.net.URL; | ||
| import java.util.Locale; | ||
|
|
||
| import lombok.Getter; | ||
| import lombok.Setter; | ||
| import lombok.extern.log4j.Log4j2; | ||
|
|
||
| import org.opensearch.action.ActionRequestValidationException; | ||
| import org.opensearch.action.support.master.AcknowledgedRequest; | ||
| import org.opensearch.common.io.stream.StreamInput; | ||
| import org.opensearch.common.io.stream.StreamOutput; | ||
| import org.opensearch.common.unit.TimeValue; | ||
| import org.opensearch.core.ParseField; | ||
| import org.opensearch.core.xcontent.ObjectParser; | ||
| import org.opensearch.geospatial.ip2geo.common.DatasourceManifest; | ||
|
|
||
| /** | ||
| * GeoIP datasource creation request | ||
| */ | ||
| @Getter | ||
| @Setter | ||
| @Log4j2 | ||
| public class PutDatasourceRequest extends AcknowledgedRequest<PutDatasourceRequest> { | ||
| private static final ParseField ENDPOINT_FIELD = new ParseField("endpoint"); | ||
| private static final ParseField UPDATE_INTERVAL_IN_DAYS_FIELD = new ParseField("update_interval_in_days"); | ||
| /** | ||
| * @param datasourceName the datasource name | ||
| * @return the datasource name | ||
| */ | ||
| private String datasourceName; | ||
| /** | ||
| * @param endpoint url to a manifest file for a datasource | ||
| * @return url to a manifest file for a datasource | ||
| */ | ||
| private String endpoint; | ||
| /** | ||
| * @param updateIntervalInDays update interval of a datasource | ||
| * @return update interval of a datasource | ||
| */ | ||
| private TimeValue updateIntervalInDays; | ||
|
|
||
| /** | ||
| * Parser of a datasource | ||
| */ | ||
| public static final ObjectParser<PutDatasourceRequest, Void> PARSER; | ||
| static { | ||
| PARSER = new ObjectParser<>("put_datasource"); | ||
| PARSER.declareString((request, val) -> request.setEndpoint(val), ENDPOINT_FIELD); | ||
| PARSER.declareLong((request, val) -> request.setUpdateIntervalInDays(TimeValue.timeValueDays(val)), UPDATE_INTERVAL_IN_DAYS_FIELD); | ||
| } | ||
|
|
||
| /** | ||
| * Default constructor | ||
| * @param datasourceName name of a datasource | ||
| */ | ||
| public PutDatasourceRequest(final String datasourceName) { | ||
| this.datasourceName = datasourceName; | ||
| } | ||
|
|
||
| /** | ||
| * Constructor with stream input | ||
| * @param in the stream input | ||
| * @throws IOException IOException | ||
| */ | ||
| public PutDatasourceRequest(final StreamInput in) throws IOException { | ||
| super(in); | ||
| this.datasourceName = in.readString(); | ||
| this.endpoint = in.readString(); | ||
| this.updateIntervalInDays = in.readTimeValue(); | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(final StreamOutput out) throws IOException { | ||
| super.writeTo(out); | ||
| out.writeString(datasourceName); | ||
| out.writeString(endpoint); | ||
| out.writeTimeValue(updateIntervalInDays); | ||
| } | ||
|
|
||
| @Override | ||
| public ActionRequestValidationException validate() { | ||
| ActionRequestValidationException errors = new ActionRequestValidationException(); | ||
| validateEndpoint(errors); | ||
| validateUpdateInterval(errors); | ||
| return errors.validationErrors().isEmpty() ? null : errors; | ||
| } | ||
|
|
||
| /** | ||
| * Conduct following validation on endpoint | ||
| * 1. endpoint format complies with RFC-2396 | ||
| * 2. validate manifest file from the endpoint | ||
| * | ||
| * @param errors the errors to add error messages | ||
| */ | ||
| private void validateEndpoint(final ActionRequestValidationException errors) { | ||
| try { | ||
| URL url = new URL(endpoint); | ||
| url.toURI(); // Validate URL complies with RFC-2396 | ||
| validateManifestFile(url, errors); | ||
| } catch (MalformedURLException | URISyntaxException e) { | ||
| log.info("Invalid URL[{}] is provided", endpoint, e); | ||
| errors.addValidationError("Invalid URL format is provided"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Conduct following validation on url | ||
| * 1. can read manifest file from the endpoint | ||
| * 2. the url in the manifest file complies with RFC-2396 | ||
| * 3. updateIntervalInDays is less than validForInDays value in the manifest file | ||
| * | ||
| * @param url the url to validate | ||
| * @param errors the errors to add error messages | ||
| */ | ||
| private void validateManifestFile(final URL url, final ActionRequestValidationException errors) { | ||
| DatasourceManifest manifest; | ||
| try { | ||
| manifest = DatasourceManifest.Builder.build(url); | ||
| } catch (Exception e) { | ||
| log.info("Error occurred while reading a file from {}", url, e); | ||
| errors.addValidationError(String.format(Locale.ROOT, "Error occurred while reading a file from %s", url)); | ||
| return; | ||
| } | ||
|
|
||
| try { | ||
| new URL(manifest.getUrl()).toURI(); // Validate URL complies with RFC-2396 | ||
| } catch (MalformedURLException | URISyntaxException e) { | ||
| log.info("Invalid URL[{}] is provided for url field in the manifest file", manifest.getUrl(), e); | ||
| errors.addValidationError("Invalid URL format is provided for url field in the manifest file"); | ||
| return; | ||
| } | ||
|
|
||
| if (updateIntervalInDays.days() >= manifest.getValidForInDays()) { | ||
| errors.addValidationError( | ||
| String.format( | ||
| Locale.ROOT, | ||
| "updateInterval %d is should be smaller than %d", | ||
| updateIntervalInDays.days(), | ||
| manifest.getValidForInDays() | ||
| ) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Validate updateIntervalInDays is larger than 0 | ||
| * | ||
| * @param errors the errors to add error messages | ||
| */ | ||
| private void validateUpdateInterval(final ActionRequestValidationException errors) { | ||
| if (updateIntervalInDays.compareTo(TimeValue.timeValueDays(1)) > 0) { | ||
| errors.addValidationError("Update interval should be equal to or larger than 1 day"); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.