From effa3c727c3266fcbf8acb7739e17a46a60c467e Mon Sep 17 00:00:00 2001 From: Rick Larsen Date: Wed, 20 Oct 2021 10:40:29 -0700 Subject: [PATCH] Removed future tense from docs content (#6646) * removed future tense from docs content * removed future tense from developing docs * removed future tense from integrating docs * removed future tense from introduction docs * removed future tense from managing docs * removed future tense from metadata reference docs * removed future tense from quick start docs * removed future tense from reference docs * removed future tense from using docs * Copy edits docs content --- .../processing-framework-intro.adoc | 4 +- .../_catalogFrameworks/catalog-api.adoc | 6 +- .../catalog-framework-camel-component.adoc | 8 +- .../catalog-framework-intro.adoc | 19 +- .../_architectures/_data/data-intro.adoc | 6 +- .../_eventing/eventing-intro.adoc | 2 +- .../_plugins/filter-plugin.adoc | 8 +- .../_plugins/geocoder-plugin.adoc | 4 +- .../_plugins/metacard-attribute-plugin.adoc | 2 +- .../_plugins/metacard-backup-filestorage.adoc | 2 +- .../_plugins/metacard-backup-s3-storage.adoc | 2 +- .../_plugins/metacard-groomer.adoc | 4 +- .../_plugins/metacardingest-network.adoc | 14 +- .../_plugins/point-of-contact-plugin.adoc | 4 +- .../_architectures/_plugins/policy-intro.adoc | 4 +- .../_plugins/security-audit-plugin.adoc | 2 +- .../_plugins/tags-filter-plugin.adoc | 2 +- .../_plugins/workspace-pre-ingest-plugin.adoc | 2 +- .../_plugins/xml-attribute-plugin.adoc | 4 +- .../_queries/filterbuilder-api.adoc | 2 +- .../_resources/content-item.adoc | 2 +- .../retrieving-resources-options.adoc | 18 +- .../_resources/url-resource-reader.adoc | 12 +- .../external-ws-s-sts-support.adoc | 3 +- .../federated-identity.adoc | 4 +- .../_securityFramework/guest-interceptor.adoc | 4 +- .../_securityFramework/realms.adoc | 4 +- .../security-encryption-commands.adoc | 4 +- .../security-expansion-service.adoc | 2 +- .../security-filtering.adoc | 11 +- .../security-framework-intro.adoc | 2 +- .../security-ldap-embedded-server.adoc | 14 +- .../security-pdp-authz-realm.adoc | 4 +- .../security-rest-intro.adoc | 18 +- .../security-sts-claims-handler.adoc | 4 +- .../sts-ldap-claims-handler.adoc | 2 +- .../_transformers/atom-queryresp-xformer.adoc | 2 +- .../custom-mime-type-resolver.adoc | 2 +- .../_transformers/geojson-input-xformer.adoc | 8 +- .../_transformers/kml-metacard-xformer.adoc | 2 +- .../_transformers/kml-queryresp-xformer.adoc | 2 +- .../_transformers/mime-type-mapper-intro.adoc | 4 +- .../_transformers/pptx-input-xformer.adoc | 2 +- .../tika-mime-type-resolver.adoc | 2 +- .../assuring-bundles-and-apps.adoc | 2 +- .../_devComponents/attribute-injection.adoc | 6 +- .../_devComponents/attribute-type.adoc | 4 +- .../custom-action-components.adoc | 2 +- .../_devComponents/custom-applications.adoc | 7 +- .../_devComponents/custom-filters.adoc | 8 +- .../_devComponents/custom-query-options.adoc | 5 +- .../custom-resource-readers.adoc | 6 +- .../_devComponents/custom-sources.adoc | 2 +- .../custom-sts-claims-handlers.adoc | 12 +- .../custom-transformers-input.adoc | 8 +- .../_devComponents/custom-xacml-policies.adoc | 4 +- .../default-attribute-values.adoc | 7 +- .../_devComponents/editing-docs.adoc | 4 +- .../_devComponents/filter-delegates.adoc | 6 +- .../_devComponents/json-definition-files.adoc | 2 +- .../managed-service-factories.adoc | 8 +- .../_devComponents/metacard-type.adoc | 8 +- .../_devComponents/metacard-validators.adoc | 2 +- .../high-availability-guidance.adoc | 2 +- .../_devGuidelines/osgi-basics.adoc | 6 +- .../_endpoints/catalog-rest-endpoint.adoc | 12 +- .../_integrating/_endpoints/csw-endpoint.adoc | 16 +- .../_endpoints/endpoint-intro.adoc | 2 +- .../_endpoints/opensearch-endpoint.adoc | 4 +- .../_endpoints/prometheus-endpoint.adoc | 2 +- .../_endpoints/query-endpoints.adoc | 20 +- .../_integrating/_eventing/subscriptions.adoc | 13 +- .../high-availability-intro.adoc | 8 +- .../_coreConcepts/ingest-intro.adoc | 2 +- .../_coreConcepts/search-intro.adoc | 4 +- .../_introduction/developing-intro.adoc | 2 +- .../_introduction/documentation-notes.adoc | 9 +- .../content/_introduction/managing-intro.adoc | 2 +- .../_sources/confluence-federated-source.adoc | 6 +- .../_sources/federation-strategy.adoc | 8 +- .../_sources/opensearch-source.adoc | 2 +- .../_sources/solr-catalog-provider.adoc | 2 +- .../_configuring/_sources/wfs-11-source.adoc | 6 +- .../_configuring/_sources/wfs-20-source.adoc | 8 +- .../_sources/wfs-sources-services.adoc | 2 +- .../_configuring/admin-console-tutorial.adoc | 6 +- .../_configuring/catalog-authorization.adoc | 4 +- .../_configuring/changing-hostname.adoc | 2 +- .../_configuring/configuration-files.adoc | 2 +- .../configuring-access-plugins.adoc | 2 +- .../configuring-data-policy-plugins.adoc | 6 +- .../configuring-fanout-proxy.adoc | 6 +- .../configuring-guest-access.adoc | 6 +- .../configuring-kml-endpoint.adoc | 10 +- .../_configuring/configuring-oidc.adoc | 4 +- .../connecting-to-external-idp.adoc | 2 +- .../content-directory-monitor.adoc | 29 +- .../_configuring/decanter-services.adoc | 2 +- .../_managing/_configuring/enabling-ssl.adoc | 4 +- .../_configuring/environment-hardening.adoc | 7 +- .../_configuring/filter-policy-plugins.adoc | 2 +- .../_configuring/global-settings.adoc | 21 +- .../_configuring/hiding-errors-by-role.adoc | 6 +- .../_managing/_configuring/ldap-server.adoc | 2 +- .../_configuring/logout-theming.adoc | 6 +- .../remove-default-users-cont.adoc | 2 +- .../_configuring/remove-default-users.adoc | 2 +- .../_configuring/securing-admin-console.adoc | 4 +- .../_configuring/setting-xacml-policies.adoc | 2 +- .../_managing/_configuring/solr-synonyms.adoc | 4 +- .../_configuring/updating-system-users.adoc | 18 +- .../web-context-policy-manager.adoc | 20 +- ...tributes-added-by-attribute-injection.adoc | 2 +- ...ttributes-added-by-pre-ingest-plugins.adoc | 4 +- .../attributes-added-on-query.adoc | 2 +- .../_installing/configure-single-sign-on.adoc | 10 +- .../_installing/file-system-access.adoc | 4 +- .../_managing/_installing/finish-page.adoc | 4 +- .../_installing/firewall-config.adoc | 2 +- ...availability-initial-setup-exceptions.adoc | 14 +- .../_installing/initial-startup.adoc | 2 +- .../_installing/install-prereqs.adoc | 2 +- .../_installing/install-with-zip.adoc | 4 +- .../installing-from-the-command-line.adoc | 2 +- .../_managing/_running/catalog-commands.adoc | 3 +- .../_managing/_running/command-scheduler.adoc | 10 +- .../_managing/_running/console-commands.adoc | 2 +- .../_managing/_running/ddf-service.adoc | 2 +- .../_running/directory-monitor-ingest.adoc | 4 +- .../_managing/_running/external-ingest.adoc | 8 +- .../_managing/_running/forms-commands.adoc | 10 +- .../_managing/_running/ingest-command.adoc | 2 +- .../_running/manual-removal-expired.adoc | 2 +- .../_managing/_running/monitoring.adoc | 10 +- .../_running/subscription-commands.adoc | 8 +- .../_managing/_running/troubleshooting.adoc | 4 +- .../_managing/_running/validator-plugins.adoc | 4 +- .../content/_managing/_securing/auditing.adoc | 6 +- .../_securing/disallowing-login-wo-certs.adoc | 2 +- .../_managing/_securing/managing-crl.adoc | 30 +- .../_securing/managing-keystores.adoc | 4 +- .../_managing/_securing/securing-intro.adoc | 4 +- .../content/_managing/managing-intro.adoc | 2 +- .../complete-list-file-types.adoc | 2 +- .../security-attributes-table.adoc | 10 +- .../supported-file-formats.adoc | 2 +- .../_quickstart/quickstart-certificates.adoc | 30 +- .../_quickstart/quickstart-configuring.adoc | 6 +- .../_quickstart/quickstart-installing.adoc | 20 +- .../content/_quickstart/quickstart-intro.adoc | 4 +- .../_reference/_appReferences/mg-spatial.adoc | 20 +- .../_dependencyList/ddf-dependency-list.adoc | 674 ++++++------ .../_dependencyList/js-dependency-list.adoc | 994 +++++++++--------- .../_reference/_tables/AdminConfigPolicy.adoc | 4 +- .../_tables/CachingFederationStrategy.adoc | 4 +- .../_tables/CatalogBackupPlugin.adoc | 2 +- .../_tables/CatalogFrameworkImpl.adoc | 2 +- .../_tables/Claims_Handler_Manager.adoc | 2 +- .../_tables/Confluence_Federated_Source.adoc | 4 +- .../_tables/ContentDirectoryMonitor.adoc | 6 +- .../ContentFileSystemStorageProvider.adoc | 2 +- .../_reference/_tables/FacetWhitelist.adoc | 4 +- .../_reference/_tables/GuestInterceptor.adoc | 2 +- .../_reference/_tables/IdpMetadata.adoc | 2 +- .../_reference/_tables/KmlEndpoint.adoc | 2 +- .../_tables/LogoutRequestService.adoc | 2 +- .../_tables/MetacardAttributePlugin.adoc | 4 +- .../_tables/MetacardIngestNetworkPlugin.adoc | 2 +- .../_tables/MetacardValidityFilterPlugin.adoc | 2 +- .../_tables/MetacardValidityMarkerPlugin.adoc | 2 +- .../_tables/PdfInputTransformer.adoc | 2 +- .../_reference/_tables/PolicyManager.adoc | 4 +- .../_tables/ReliableResourceDownload.adoc | 6 +- .../content/_reference/_tables/Session.adoc | 2 +- .../_tables/TikaInputTransformer.adoc | 2 +- .../_tables/TransformerDescriptors.adoc | 6 +- .../_tables/Wfs_v1_1_0_Federated_Source.adoc | 2 +- .../_tables/Wfs_v2_0_0_Connected_Source.adoc | 4 +- .../_tables/Wfs_v2_0_0_Federated_Source.adoc | 4 +- .../_tables/WorkspaceQueryService.adoc | 2 +- .../_tables/XmlAttributePlugin.adoc | 6 +- .../_tables/admin.ui.configuration.adoc | 4 +- ...sformer.input.pdf.PdfInputTransformer.adoc | 2 +- .../_tables/landingpage.properties.adoc | 2 +- .../org.codice.ddf.transformer.preview.adoc | 4 +- .../_tables/platform.ui.config.adoc | 4 +- .../_reference/_tables/scheduler.Command.adoc | 2 +- .../_tables/service.SecurityManager.adoc | 2 +- .../content/_reference/_tables/sts.adoc | 2 +- .../_using/using-simple-search-ui.adoc | 6 +- 190 files changed, 1352 insertions(+), 1350 deletions(-) diff --git a/distribution/docs/src/main/resources/content/_architectures/_asyncFramework/processing-framework-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_asyncFramework/processing-framework-intro.adoc index 207b0997df23..76f83b3ecae7 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_asyncFramework/processing-framework-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_asyncFramework/processing-framework-intro.adoc @@ -19,7 +19,7 @@ has been ingested into the Catalog. This feature is uninstalled by default. [WARNING] ==== The *Processing Framework* does not support partial updates to the Catalog. This means that if any changes are made to a metacard in the Catalog between the time -asynchronous processing starts and ends, those changes will be overwritten by the *ProcessingFramework* updates sent back to the Catalog. This feature should be used with caution. +asynchronous processing starts and ends, those changes are overwritten by the *ProcessingFramework* updates sent back to the Catalog. This feature should be used with caution. ==== .Processing Framework Architecture @@ -141,7 +141,7 @@ A `ProcessRequest` contains a list of ``ProcessItem``s for the `ProcessingFramew should mark the `ProcessRequest` as already been processed, so that it does not process it again. .PostProcessPlugin -The `PostProcessPlugin` is a plugin that will be run by the `ProcessingFramework`. It is capable of processing ``ProcessCreateItem``s, ``ProcessUpdateItem``s, and ``ProcessDeleteItem``s. +The `PostProcessPlugin` is a plugin that is run by the `ProcessingFramework`. It is capable of processing ``ProcessCreateItem``s, ``ProcessUpdateItem``s, and ``ProcessDeleteItem``s. .ProcessItem [WARNING] diff --git a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-api.adoc b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-api.adoc index efd7adcf07b6..e44d5c5cdc41 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-api.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-api.adoc @@ -36,8 +36,8 @@ Searching the catalog involves three basic steps: .. For contextual search, optionally set the `fuzzy` flag to `true` or `false` (the default value for the `Metadata Catalog` `fuzzy` flag is `true`, while the `portal` default value is `false`). .. For contextual search, optionally set the `caseSensitive` flag to true (the default is that `caseSensitive` flag is NOT set and queries are not case sensitive). Doing so enables case sensitive matching on the search criteria. -For example, if `caseSensitive` is set to true and the phrase is “Baghdad” then only metadata containing “Baghdad” with the same matching case will be returned. -Words such as “baghdad”, “BAGHDAD”, and “baghDad” will not be returned because they do not match the exact case of the search term. +For example, if `caseSensitive` is set to true and the phrase is “Baghdad” then only metadata containing “Baghdad” with the same matching case is returned. +Words such as “baghdad”, “BAGHDAD”, and “baghDad” are not returned because they do not match the exact case of the search term. . Issue a search. . Examine the results. @@ -76,7 +76,7 @@ There are three policies available. |=== -If no sort policy is defined for a particular search, the temporal policy will automatically be applied. +If no sort policy is defined for a particular search, the temporal policy is automatically applied. ===== Product Retrieval diff --git a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-camel-component.adoc b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-camel-component.adoc index 2f39439f40dc..a23a9449f7a4 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-camel-component.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-camel-component.adoc @@ -31,9 +31,9 @@ For the CREATE and UPDATE operation, the message body can contain a list of meta For the DELETE operation, the message body can contain a list of strings or a single string object. The string objects represent the IDs of metacards to be deleted. -The exchange's "in" message will be set with the affected metacards. -In the case of a CREATE, it will be updated with the created metacards. -In the case of the UPDATE, it will be updated with the updated metacards and with the DELETE it will contain the deleted metacards. +The exchange's "in" message is set with the affected metacards. +In the case of a CREATE, it is updated with the created metacards. +In the case of the UPDATE, it is updated with the updated metacards and with the DELETE it contains the deleted metacards. .Catalog Framework Camel Component Operations [cols="2,2,3" options="header"] @@ -60,7 +60,7 @@ In the case of the UPDATE, it will be updated with the updated metacards and wit [NOTE] ==== If there is an exception thrown while the route is being executed, a -FrameworkProducerException will be thrown causing the route to fail +`FrameworkProducerException` is thrown causing the route to fail with a CamelExecutionException. ==== diff --git a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-intro.adoc index 85857a4cd1b2..7b2b050fdf85 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-intro.adoc @@ -56,7 +56,7 @@ As such, new capabilities can be developed independently, in a modular fashion, === Ensuring Compatibility -The Catalog API will evolve, but great care is taken to retain backwards compatibility with developed components. +The Catalog API evolves, but great care is taken to retain backwards compatibility with developed components. Compatibility is reflected in version numbers. === Catalog Framework Sequence Diagrams @@ -108,8 +108,8 @@ Similarly, for deletion of catalog entries, the delete requests call the `delete ==== Error Handling -Any ingest attempts that fail inside the Catalog Framework (whether the failure comes from the Catalog Framework itself, pre-ingest plugin failures, or issues with the Catalog Provider) will be logged to a separate log file for ease of error handling. -The file is located at `${home_directory}/data/log/ingest_error.log` and will log the Metacards that fail, their ID and Title name, and the stack trace associated with their failure. +Any ingest attempts that fail inside the Catalog Framework (whether the failure comes from the Catalog Framework itself, pre-ingest plugin failures, or issues with the Catalog Provider) are logged to a separate log file for ease of error handling. +The file is located at `${home_directory}/data/log/ingest_error.log` and it logs the Metacards that fail, their ID and Title name, and the stack trace associated with their failure. By default, successful ingest attempts are not logged. However, that functionality can be achieved by setting the log level of the `ingestLogger` to DEBUG (note that enabling DEBUG can cause a non-trivial performance hit). @@ -161,25 +161,24 @@ The Endpoint bundle contains a Web service that exposes the interface to query f The Endpoint calls the `CatalogFramework` to execute the operations of its specification. The `CatalogFramework` relies on the `CatalogProvider` to execute the actual query. Optional PreQuery and PostQuery Catalog Plugins may be invoked by the `CatalogFramework` to modify the query request/response prior to the Catalog Provider processing the query request and providing the query response. -If a `CatalogProvider` is not configured and no other remote Sources are configured, a fault will be returned. +If a `CatalogProvider` is not configured, and no other remote Sources are configured, a fault is returned. It is possible to have only remote Sources configured and no local `CatalogProvider` configured and be able to execute queries to specific remote Sources by specifying the site names in the query request. - ==== Product Caching -The Catalog Framework optionally provides caching of products, so future requests to retrieve the same product will be serviced much quicker. -If caching is enabled, each time a retrieve product request is received, the Catalog Framework will look in its cache (default location `${home_directory}/data/product-cache`) to see if the product has been cached locally. +The Catalog Framework optionally provides caching of products, so future requests to retrieve the same product are serviced much quicker. +If caching is enabled, each time a retrieve product request is received, the Catalog Framework looks in its cache (default location `${home_directory}/data/product-cache`) to see if the product has been cached locally. If it has, the product is retrieved from the local site and returned to the client, providing a much quicker turnaround because remote product retrieval and network traffic was avoided. If the requested product is not in the cache, the product is retrieved from the Source (local or remote) and cached locally while returning the product to the client. The caching to a local file of the product and the streaming of the product to the client are done simultaneously so that the client does not have to wait for the caching to complete before receiving the product. -If errors are detected during the caching, caching of the product will be abandoned, and the product will be returned to the client. +If errors are detected during the caching, caching of the product is abandoned, and the product is returned to the client. The Catalog Framework attempts to detect any network problems during the product retrieval, for example, long pauses where no bytes are read implying a network connection was dropped. (The amount of time defined as a "long pause" is configurable, with the default value being five seconds.) -The Catalog Framework will attempt to retrieve the product up to a configurable number of times (default = three), waiting for a configurable amount of time (default = 10 seconds) between each attempt, trying to successfully retrieve the product. +The Catalog Framework attempts to retrieve the product up to a configurable number of times (default = three), waiting for a configurable amount of time (default = 10 seconds) between each attempt, trying to successfully retrieve the product. If the Catalog Framework is unable to retrieve the product, an error message is returned to the client. -If the admin has enabled the *Always Cache When Canceled* option, caching of the product will occur even if the client cancels the product retrieval so that future requests will be serviced quickly. +If the admin has enabled the *Always Cache When Canceled* option, caching of the product occurs even if the client cancels the product retrieval so that future requests are serviced quickly. Otherwise, caching is canceled if the user cancels the product download. ==== Product Download Status diff --git a/distribution/docs/src/main/resources/content/_architectures/_data/data-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_data/data-intro.adoc index 86813d0d586e..6f8e7f6e66b1 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_data/data-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_data/data-intro.adoc @@ -90,7 +90,7 @@ Consult the documentation of the Catalog Provider in use for more information on ==== Often, the `BASIC_METACARD` `MetacardType` does not provide all the functionality or attributes necessary for a specific task. -For performance or convenience purposes, it may be necessary to create custom attributes even if others will not be aware of those attributes. +For performance or convenience purposes, it may be necessary to create custom attributes even if others are be aware of those attributes. One example could be if a user wanted to optimize a search for a date field that did not fit the definition of `CREATED`, `MODIFIED`, `EXPIRATION`, or `EFFECTIVE`. The user could create an additional `java.util.Date` attribute in order to query the attribute separately. @@ -113,7 +113,7 @@ It maintains a list of all supported `MetacardTypes` in the `CatalogFramework`, The `MetacardType` is essential for a component in the `CatalogFramework` to understand how it should interpret a metacard by knowing what attributes are available in that metacard. For example, an endpoint receiving incoming metadata can perform a lookup in the `MetacardTypeRegistry` to find a corresponding `MetacardType`. -The discovered `MetacardType` will then be used to help the endpoint populate a metacard based on the specified attributes in the `MetacardType`. +The discovered `MetacardType` is then used to help the endpoint populate a metacard based on the specified attributes in the `MetacardType`. By doing this, all the incoming metadata elements can then be available for processing, cataloging, and searching by the rest of the `CatalogFramework`. `MetacardTypes` should be registered with the `MetacardTypeRegistry`. The `MetacardTypeRegistry` makes those `MetacardTypes` available to other ${branding} `CatalogFramework` components. @@ -138,7 +138,7 @@ The reference to this service can then be used to register new `MetacardTypes` o New `MetacardTypes` are typically registered by `CatalogProviders` or sources indicating they know how to persist, index, and query attributes from that type. Endpoints or `InputTransformers` typically use the lookup functionality to access a `MetacardType` based on a parameter in the incoming metadata. -Once the appropriate `MetacardType` is discovered and obtained from the registry, the component will know how to translate incoming raw metadata into a ${branding} Metacard. +Once the appropriate `MetacardType` is discovered and obtained from the registry, the component knows how to translate incoming raw metadata into a ${branding} Metacard. === Attributes diff --git a/distribution/docs/src/main/resources/content/_architectures/_eventing/eventing-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_eventing/eventing-intro.adoc index 29dc2ce2925c..22c69563554e 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_eventing/eventing-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_eventing/eventing-intro.adoc @@ -36,7 +36,7 @@ The ((Eventing)) capability of the Catalog allows endpoints (and thus external u Notably, the Catalog allows event evaluation on both the previous value (if available) and new value of a Metacard when an update occurs. Eventing allows ${branding}s to receive events on operations (such as create, update, delete) based on particular queries or actions. -Once subscribed, users will receive notifications of events such as update or create on any source. +Once subscribed, users receive notifications of events such as update or create on any source. == Eventing Components diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/filter-plugin.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/filter-plugin.adoc index d2d15d9d79f1..6e8a52277134 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/filter-plugin.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/filter-plugin.adoc @@ -12,10 +12,10 @@ The security attribute is a Map containing a set of keys that map to lists of va The metacard is then processed by a filter plugin that creates a `KeyValueCollectionPermission` from the metacard's security attribute. This permission is then checked against the user subject to determine if the subject has the correct claims to view that metacard. The decision to filter the metacard eventually relies on the installed <<_security_pdp,Policy Decision Point>> (PDP). -The PDP that is being used returns a decision, and the metacard will either be filtered or allowed to pass through. +The PDP that is being used returns a decision, and the metacard is either filtered or allowed to pass through. How a metacard gets filtered is left up to any number of FilterStrategy implementations that might be installed. -Each FilterStrategy will return a result to the filter plugin that says whether or not it was able to process the metacard, along with the metacard or response itself. +Each `FilterStrategy` returns a result to the filter plugin that says whether or not it was able to process the metacard, along with the metacard or response itself. This allows a metacard or entire response to be partially filtered to allow some data to pass back to the requester. This could also include filtering any resources sent back to a requester. @@ -58,8 +58,8 @@ Each type of metacard must have its own `PolicyPlugin` that reads the metadata b ---- In the above example, the user's claims are represented very simply and are similar to how they would actually appear in a SAML 2 assertion. -Each of these user (or subject) claims will be converted to a `KeyValuePermission` object. -These permission objects will be implied against the permission object generated from the metacard record. +Each of these user (or subject) claims is converted to a `KeyValuePermission` object. +These permission objects is implied against the permission object generated from the metacard record. In this particular case, the metacard might be allowed if the policy is configured appropriately because all of the permissions line up correctly. == Installing the Filter Plugin diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/geocoder-plugin.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/geocoder-plugin.adoc index 751eb39e60bc..eebd7ec574fa 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/geocoder-plugin.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/geocoder-plugin.adoc @@ -6,8 +6,8 @@ :summary: Populates the `Location.COUNTRY_CODE` attribute if the Metacard has an associated location. The ((GeoCoder plugin)) is a pre-ingest plugin that is responsible for populating the Metacard's `Location.COUNTRY_CODE` attribute if the Metacard has an associated location. -If there is a valid country code for the Metacard, it will be in ISO 3166-1 alpha-3 format. -If the metacard's country code is already populated, the plugin will *not* override it. +If there is a valid country code for the Metacard, it is in ISO 3166-1 alpha-3 format. +If the metacard's country code is already populated, the plugin does *not* override it. The GeoCoder relies on either the WebService or <<{reference-prefix}offline_gazetteer_service,Offline Gazetteer>> to retrieve country code information. [WARNING] diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-attribute-plugin.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-attribute-plugin.adoc index b8525b12889e..78ba090ba82c 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-attribute-plugin.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-attribute-plugin.adoc @@ -25,7 +25,7 @@ For example, if the source attributes `sourceattribute1` and `sourceattribute2` `destinationattribute1 = MASK, VESSEL, WIRE, SACK` The other way to combine attributes is use the values common to all of the attributes. -This is called the intersection. Using our previous example, the **intersection** of +This is called the intersection. Using the previous example, the **intersection** of `sourceattribute1` and `sourceattribute2` would create the new attribute `destinationattribute1` `destinationattribute1 = MASK` diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-backup-filestorage.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-backup-filestorage.adoc index 175dc42bb45e..0c2bb4211d6e 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-backup-filestorage.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-backup-filestorage.adoc @@ -5,7 +5,7 @@ :plugintypes: postingest :summary: Stores backed-up metacards. -The ((Metacard Backup File Storage Provider)) is a storage provider that will store backed-up metacards in a specified file system location. +The ((Metacard Backup File Storage Provider)) is a storage provider that stores backed-up metacards in a specified file system location. == Installing the Metacard Backup File Storage Provider diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-backup-s3-storage.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-backup-s3-storage.adoc index 742f30ffd04a..3d4b929bf2c7 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-backup-s3-storage.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-backup-s3-storage.adoc @@ -5,7 +5,7 @@ :plugintypes: postingest :summary: Stores backed-up metacards in a specified S3 bucket and key. -The ((Metacard Backup S3 Storage Provider)) is a storage provider that will store backed up metacards in the specified ((S3)) bucket and key. +The ((Metacard Backup S3 Storage Provider)) is a storage provider that stores backed up metacards in the specified ((S3)) bucket and key. == Installing the Metacard S3 File Storage Provider diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-groomer.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-groomer.adoc index c087d827171a..f4aa5d03ba6c 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-groomer.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacard-groomer.adoc @@ -7,7 +7,7 @@ The ((Metacard Groomer Pre-Ingest plugin)) makes modifications to `CreateRequest` and `UpdateRequest` metacards. -Use this pre-ingest plugin as a convenience to apply basic rules for your metacards.  +Use this pre-ingest plugin as a convenience to apply basic rules for your metacards. This plugin makes the following modifications when metacards are in a `CreateRequest`: @@ -19,7 +19,7 @@ This plugin makes the following modifications when metacards are in a `CreateReq In an `UpdateRequest`, the same operations are performed as a `CreateRequest`, except: -* If no value is provided for `Metacard.ID` in the new metacard, it will be set using the `UpdateRequest` ID if applicable. +* If no value is provided for `Metacard.ID` in the new metacard, it is set using the `UpdateRequest` ID if applicable. == Installing the Metacard Groomer diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacardingest-network.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacardingest-network.adoc index 3c725ca0249b..f7fb33cfe1f2 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/metacardingest-network.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/metacardingest-network.adoc @@ -7,7 +7,7 @@ The ((Metacard Ingest Network Plugin)) allows the conditional insertion of new attributes on metacards during ingest based on network information from the ingest request; including IP address and hostname. -For the extent of this section, a 'rule' will refer to a configured, single instance of this plugin. +For the extent of this section, a 'rule' refers to a configured, single instance of this plugin. == Related Components to the Metacard Ingest Network Plugin @@ -30,10 +30,10 @@ See <<{reference-prefix}org.codice.ddf.catalog.plugin.metacard.MetacardIngestNet Multiple instances of the plugin can be configured by clicking on its configuration title within the configuration tab of the ${ddf-catalog} app. Each instance represents a conditional statement, or a 'rule', that gets evaluated for each ingest request. -For any request that meets the configured criteria of a rule, that rule will attempt to transform its list of key-value pairs to become new attributes on all metacards in that request. +For any request that meets the configured criteria of a rule, that rule attempts to transform its list of key-value pairs to become new attributes on all metacards in that request. -The rule is divided into two fields: "Criteria" and "Expected Value". -The "Criteria" field features a drop-down list containing the four elements for which equality can be tested: +The rule is divided into two fields: `"Criteria"` and `"Expected Value"`. +The `"Criteria"` field features a drop-down list containing the four elements for which equality can be tested: * IP Address of where the ingest request came from * Host Name of where the ingest request came from @@ -41,7 +41,7 @@ The "Criteria" field features a drop-down list containing the four elements for * Context Path that the ingest request arrived on, for example, _/services/catalog_ In order for a rule to evaluate to true and the attributes be applied, the value in the "Expected Value" field must be an exact match to the actual value of the selected criteria. -For example, if the selected criteria is "IP Address" with an expected value of "192.168.0.1", the rule only evaluates to true for ingest requests coming from "192.168.0.1" and nowhere else. +For example, if the selected criteria is `"IP Address"` with an expected value of `"192.168.0.1"`, the rule only evaluates to true for ingest requests coming from `"192.168.0.1"` and nowhere else. .Check for IPv6 IMPORTANT: Verify your system's IP configuration. Rules using "IP Address" may need to be written in IPv6 format. @@ -94,5 +94,5 @@ The following table provides some useful attributes that may commonly be set by == Usage Limitations of the Metacard Ingest Network Plugin * This plugin only works for ingest (create requests) performed over a network; data ingested via command line does not get processed by this plugin. -* Any attribute that is already set on the metacard will not be overwritten by the plugin. -* The order of execution is not guaranteed. For any rule configuration where two or more rules add different values for the same attribute, it is undefined what the final value for that attribute will be in the case where more than one of those rules evaluates to true. +* Any attribute that is already set on the metacard is not overwritten by the plugin. +* The order of execution is not guaranteed. For any rule configuration where two or more rules add different values for the same attribute, it is undetermined which provides the final value for that attribute. diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/point-of-contact-plugin.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/point-of-contact-plugin.adoc index 5087ec7ec256..1a9b6b20ff9e 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/point-of-contact-plugin.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/point-of-contact-plugin.adoc @@ -5,9 +5,9 @@ :plugintypes: policy :summary: Adds a policy if Point of Contact is updated. -The ((Point of Contact Policy Plugin)) is a PreUpdate plugin that will check if the point-of-contact attribute has changed. +The ((Point of Contact Policy Plugin)) is a PreUpdate plugin that checks if the point-of-contact attribute has changed. If it does, then it adds a policy to that metacard’s policy map that cannot be implied. -This will deny such an update request, which essentially makes the point-of-contact attribute read-only. +This denies such an update request, which essentially makes the point-of-contact attribute read-only. == Related Components to Point of Contact Policy Plugin diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/policy-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/policy-intro.adoc index 81b2475fa2c7..7811aa3f9557 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/policy-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/policy-intro.adoc @@ -8,5 +8,5 @@ ((Policy plugins)) are invoked to set up the policy for a request/response. This provides an opportunity to attach custom requirements on operations or individual metacards. -All the 'requirements' from each Policy plugin will be combined into a single policy that will be included in the request/response. -Access plugins will be used to act on this combined policy. +All the 'requirements' from each Policy plugin are combined into a single policy that is included in the request/response. +Access plugins are used to act on this combined policy. diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/security-audit-plugin.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/security-audit-plugin.adoc index ba758ed8bae9..3ad3d71a79a6 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/security-audit-plugin.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/security-audit-plugin.adoc @@ -6,7 +6,7 @@ :summary: Audits specific metacard attributes. The ((Security Audit Plugin)) is used to allow the auditing of specific metacard attributes. -Any time a metacard attribute listed in the configuration is updated, a log will be generated in the security log. +Any time a metacard attribute listed in the configuration is updated, a log entry is generated in the security log. == Installing the Security Audit Plugin diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/tags-filter-plugin.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/tags-filter-plugin.adoc index 993aeed20b69..1975f6146b0d 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/tags-filter-plugin.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/tags-filter-plugin.adoc @@ -6,7 +6,7 @@ :summary: Updates queries without filters. The ((Tags Filter Plugin)) updates queries without filters for tags, and adds a default tag of `resource`. -For backwards compatibility, a filter will also be added to include metacards without any tags attribute. +For backwards compatibility, a filter is also added to include metacards without any tags attribute. == Related Components to Tags Filter Plugin diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/workspace-pre-ingest-plugin.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/workspace-pre-ingest-plugin.adoc index 091037921994..7d7035de9420 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/workspace-pre-ingest-plugin.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/workspace-pre-ingest-plugin.adoc @@ -5,7 +5,7 @@ :plugintypes: preingest :summary: Verifies that a workspace has an associated email to enable sharing. -The ((Workspace Pre-Ingest Plugin)) verifies that a workspace has an associated email to enable sharing and assigns that email as "owner". +The ((Workspace Pre-Ingest Plugin)) verifies that a workspace has an associated email to enable sharing and assigns that email as `"owner"`. == Related Components to The Workspace Pre-Ingest Plugin diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/xml-attribute-plugin.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/xml-attribute-plugin.adoc index 907e744b7410..ce9f03ff106f 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/xml-attribute-plugin.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/xml-attribute-plugin.adoc @@ -6,8 +6,8 @@ :summary: Finds security attributes contained in a metacard's metadata. The ((XML Attribute Security Policy Plugin)) parses XML metadata contained within a metacard for security attributes on any number of XML elements in the metadata. -The configuration for the plugin contains one field for setting the XML elements that will be parsed for security attributes and the other two configurations contain the XML attributes that will be pulled off of those elements. -The *Security Attributes (union)* field will compute the union of values for each attribute defined and the *Security Attributes (intersection)* field will compute the intersection of values for each attribute defined. +The configuration for the plugin contains one field for setting the XML elements that are parsed for security attributes and the other two configurations contain the XML attributes that are pulled off of those elements. +The *Security Attributes (union)* field computes the union of values for each attribute defined and the *Security Attributes (intersection)* field computes the intersection of values for each attribute defined. == Installing the XML Attribute Security Policy Plugin diff --git a/distribution/docs/src/main/resources/content/_architectures/_queries/filterbuilder-api.adoc b/distribution/docs/src/main/resources/content/_architectures/_queries/filterbuilder-api.adoc index 6586a80b6f38..4f8ca0913a8c 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_queries/filterbuilder-api.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_queries/filterbuilder-api.adoc @@ -9,7 +9,7 @@ To avoid the complexities of working with the Filter interface directly and implementing the ${branding} Profile of the Filter specification, the ${ddf-catalog} includes an API, primarily in `${ddf-branding}.filter`, to build Filters using a fluent API. To use the `FilterBuilder` API, an instance of `${ddf-branding}.filter.FilterBuilder` should be used via the OSGi registry. -Typically, this will be injected via a dependency injection framework. +Typically, this is injected via a dependency injection framework. Once an instance of `FilterBuilder` is available, methods can be called to create and combine Filters. [TIP] diff --git a/distribution/docs/src/main/resources/content/_architectures/_resources/content-item.adoc b/distribution/docs/src/main/resources/content/_architectures/_resources/content-item.adoc index 49c4d35fa647..f8cb6770cd21 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_resources/content-item.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_resources/content-item.adoc @@ -8,4 +8,4 @@ ((Content Item)) is the domain object populated by the Storage Provider that represents the information about the content to be stored or content that has been stored in the Storage Provider. A `ContentItem` encapsulates the content's globally unique ID, mime type, and input stream (that is, the actual content). -The unique ID of a `ContentItem` will always correspond to a Metacard ID. +The unique ID of a `ContentItem` always corresponds to a Metacard ID. diff --git a/distribution/docs/src/main/resources/content/_architectures/_resources/retrieving-resources-options.adoc b/distribution/docs/src/main/resources/content/_architectures/_resources/retrieving-resources-options.adoc index b5cb4fda4bcc..a32b00e9b515 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_resources/retrieving-resources-options.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_resources/retrieving-resources-options.adoc @@ -5,10 +5,10 @@ :order: 01 :summary: Retrieving Resource Options. -Options can be specified on a retrieve resource request made through any of the supporting endpoint.  -To specify an option for a retrieve resource request, the endpoint needs to first instantiate a `ResourceRequestByProductUri` or a `ResourceRequestById`.  -Both of these `ResourceRequest` implementations allow a `Map` of properties to be specified.  -Put the specified option into the `Map` under the key `RESOURCE_OPTION`.   +Options can be specified on a retrieve resource request made through any of the supporting endpoint. +To specify an option for a retrieve resource request, the endpoint needs to first instantiate a `ResourceRequestByProductUri` or a `ResourceRequestById`. +Both of these `ResourceRequest` implementations allow a `Map` of properties to be specified. +Put the specified option into the `Map` under the key `RESOURCE_OPTION`. .Retrieve Resource with Options [source,java,linenums] @@ -18,9 +18,9 @@ properties.put("RESOURCE_OPTION", "OptionA"); ResourceRequestById resourceRequest = new ResourceRequestById("0123456789abcdef0123456789abcdef", properties); ---- -Depending on the support that the `ResourceReader` or `Source` provides for options, the `properties` `Map` will be checked for the `RESOURCE_OPTION` entry.  -If that entry is found, the option will be handled.  -If the `ResourceReader` or `Source` does not support options, that entry will be ignored. +Depending on the support that the `ResourceReader` or `Source` provides for options, the `properties` `Map` is checked for the `RESOURCE_OPTION` entry. +If that entry is found, the option is handled. +If the `ResourceReader` or `Source` does not support options, that entry is ignored. -A new `ResourceReader` or `Source` implementation can be created to support options in a way that is most appropriate.  -Since the option is passed through the catalog framework as a property, the `ResourceReader` or `Source` will have access to that option as long as the endpoint supports options. +A new `ResourceReader` or `Source` implementation can be created to support options in a way that is most appropriate. +Since the option is passed through the catalog framework as a property, the `ResourceReader` or `Source` has access to that option as long as the endpoint supports options. diff --git a/distribution/docs/src/main/resources/content/_architectures/_resources/url-resource-reader.adoc b/distribution/docs/src/main/resources/content/_architectures/_resources/url-resource-reader.adoc index cc84e597be90..f116ab0806cc 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_resources/url-resource-reader.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_resources/url-resource-reader.adoc @@ -8,13 +8,13 @@ ((({title}))) The `URLResourceReader` is an implementation of `ResourceReader` which is included in the ${branding} Catalog. It obtains a resource given an http, https, or file-based URL. -The `URLResourceReader` will connect to the provided Resource URL and read the resource's bytes into an `InputStream`. +The `URLResourceReader` connects to the provided Resource URL and reads the resource's bytes into an `InputStream`. [WARNING] ==== When a resource linked using a file-based URL is in the product cache, the ``URLResourceReader``'s `rootResourceDirectories` is not checked when downloading. It is downloaded from the product cache which bypasses the `URLResourceReader`. -For example, if path `/my/valid/path` is configured in the ``URLResourceReader``'s `rootResourceDirectories` and one downloads the product with resource-uri `file:///my/valid/path/product.txt` and then one removes `/my/valid/path` from the ``URLResourceReader``'s `rootResourceDirectories` configuration, the product will still be accessible via the product cache. +For example, if path `/my/valid/path` is configured in the ``URLResourceReader``'s `rootResourceDirectories` and one downloads the product with resource-uri `file:///my/valid/path/product.txt` and then one removes `/my/valid/path` from the ``URLResourceReader``'s `rootResourceDirectories` configuration, the product is still accessible via the product cache. ==== == Installing the URL Resource Reader @@ -39,7 +39,7 @@ permission java.io.FilePermission "", "read"; } ---- -Trailing slashes after have no effect on the permissions granted. For example, adding a permission for "${/}test${/}path" and "${/}test${/}path${/}" are equivalent. The recursive forms "${/}test${/}path${/}-", and "${/}test${/}path${/}${/}-" are also equivalent. +Trailing slashes after `` have no effect on the permissions granted. For example, adding a permission for `"${/}test${/}path"` and `"${/}test${/}path${/}"` are equivalent. The recursive forms `"${/}test${/}path${/}-"`, and `"${/}test${/}path${/}${/}-"` are also equivalent. == Configuring the URL Resource Reader @@ -54,10 +54,10 @@ See <<{reference-prefix}ddf.catalog.resource.impl.URLResourceReader,URL Resource == Using the URL Resource Reader -`URLResourceReader` will be used by the Catalog Framework to obtain a resource whose metacard is cataloged in the local data store. -This particular `ResourceReader` will be chosen by the `CatalogFramework` if the requested resource's URL has a protocol of `http`, `https`, or `file`. +`URLResourceReader` is used by the Catalog Framework to obtain a resource whose metacard is cataloged in the local data store. +This particular `ResourceReader` is chosen by the `CatalogFramework` if the requested resource's URL has a protocol of `http`, `https`, or `file`. -For example, requesting a resource with the following URL will make the Catalog Framework invoke the `URLResourceReader` for retrieval. +For example, requesting a resource with the following URL makes the Catalog Framework invoke the `URLResourceReader` for retrieval. .Example [source,http] diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/external-ws-s-sts-support.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/external-ws-s-sts-support.adoc index 6445402a4e81..7502fe357ec4 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/external-ws-s-sts-support.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/external-ws-s-sts-support.adoc @@ -15,6 +15,5 @@ Use these auth types when connecting to a non-${branding} STS or if ignoring rea === Security STS Address Provider (((Security STS Address Provider))) -This allows one to select which STS address will be used (for example, in SOAP sources) for clients of this service. +This allows one to select which STS address is used (for example, in SOAP sources) for clients of this service. Default is off (internal). - diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/federated-identity.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/federated-identity.adoc index f21dd25f6def..fc9eeaec2e13 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/federated-identity.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/federated-identity.adoc @@ -23,7 +23,7 @@ Sources still need to make authorization decisions. To solve this problem, {branding} uses federated identity. When performing any federated request (query, resource retrival, etc), {branding} attaches the requestor's SAML assertion to the outgoing request. The federated Source extracts the assertion and validates its signature to make sure it -was generated by a trusted entity. If so, the federated Source will construct a Subject for the +was generated by a trusted entity. If so, the federated Source constructs a Subject for the requestor and perform the request using that Subject. The Source can then make authorization decisions using the process already described. @@ -73,6 +73,6 @@ NOTE: With federated identity, results are filtered both by the federated Source {branding}. This is important as each may have different authorization policies. WARNING: Support for federated identity was added in DDF 2.8.x. Federated Sources older than this -will not perform any filtering. Instead, they will return all available results and leave filtering +do not perform any filtering. Instead, they return all available results and leave filtering up to the client. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/guest-interceptor.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/guest-interceptor.adoc index af13944fed61..d52c37dba261 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/guest-interceptor.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/guest-interceptor.adoc @@ -28,8 +28,8 @@ Configure the Guest Interceptor from the ${admin-console}: . Select the *Configuration* tab. . Select the *Guest Claims Configuration* configuration. . Select the `+` next to Attributes to add a new attribute. -. Add any additional attributes that will apply to every user. +. Add any additional attributes that apply to every user. . Select *Save changes*. Once these configurations have been added, the GuestInterceptor is ready for use. -Both secure and non-secure requests will be accepted by all secure ${branding} service endpoints. +Both secure and non-secure requests are accepted by all secure ${branding} service endpoints. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/realms.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/realms.adoc index 0d4c8f4231b1..fb9d9cce409e 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/realms.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/realms.adoc @@ -64,7 +64,7 @@ If no credentials are found, it supports the acquisition of basic credentials on |org.codice.ddf.security.handler.pki.PKIHandler |Handler for PKI based authentication. -X509 chain will be extracted from the HTTP request. +X509 chain is extracted from the HTTP request. |org.codice.security.idp.client.IdpHandler |Handler for IdP/SAML based authentication. @@ -105,5 +105,5 @@ This approach is often easier to configure for those that are not familiar with ==== An update was made to the IdpHandler to pass SAML assertions through the Authorization HTTP header. Cookies _are_ still accepted and processed to maintain legacy federation compatibility, but assertions are sent in the header on outbound requests. -While a machine's identity will still federate between versions, a user's identity will ONLY be federated when a ${branding} version 2.7.x server communicates with a ${branding} version 2.8.x+ server, or between two servers whose versions are 2.8.x or higher. +While a machine's identity still federates between versions, a user's identity is ONLY federated when a ${branding} version 2.7.x server communicates with a ${branding} version 2.8.x+ server, or between two servers whose versions are 2.8.x or higher. ==== diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-encryption-commands.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-encryption-commands.adoc index 7d29c1a72365..c1e406395cd7 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-encryption-commands.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-encryption-commands.adoc @@ -14,7 +14,7 @@ The `security:encrypt` command allows plain text to be encrypted using AES for e It uses randomly generated keys and associated data that are created when the system is installed, and can be found in the `${home_directory}/etc/keysets` directory. This is useful when displaying password fields in a GUI. -Below is an example of the security:encrypt command used to encrypt the plain text "myPasswordToEncrypt". +Below is an example of the `security:encrypt` command used to encrypt the plain text `"myPasswordToEncrypt"`. The output, `bR9mJpDVo8bTRwqGwIFxHJ5yFJzatKwjXjIo/8USWm8=`, is the encrypted value. [source%nowrap.java] @@ -28,7 +28,7 @@ bR9mJpDVo8bTRwqGwIFxHJ5yFJzatKwjXjIo/8USWm8= This bundle is installed by default with the `security-encryption` feature. This bundle is tied specifically to the ${branding} console and can be uninstalled if not needed. -When uninstalled, however, administrators will not be able to encrypt and decrypt data from the console. +When uninstalled, however, administrators are not able to encrypt and decrypt data from the console. === Configuring the Security Encryption Commands diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-expansion-service.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-expansion-service.adoc index dd34723caf12..cd9e86e9a06c 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-expansion-service.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-expansion-service.adoc @@ -81,7 +81,7 @@ The examples below use the following collection of rulesets: |=== -It is expected that multiple instances of the expansion service will be running at the same time. +It is expected that multiple instances of the expansion service are running at the same time. Each instance of the service defines a unique property that is useful for retrieving specific instances of the expansion service. There are two pre-defined instances used by ${ddf-branding}: one for expanding user attributes and one for metacard attributes. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-filtering.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-filtering.adoc index b43d27ac2eab..a15c9b60178d 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-filtering.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-filtering.adoc @@ -10,16 +10,17 @@ ((Metacard filtering)) is performed by the <<{developing-prefix}filter_plugin,Filter Plugin>> after a query has been performed, but before the results are returned to the requestor. -Each metacard result will contain security attributes that are populated by the CatalogFramework based on the PolicyPlugins that populates this attribute. (These plugins are NOT provided by default. You must create your own plugin for your specific metadata) +Each metacard result contains security attributes that are populated by the +CatalogFramework based on the PolicyPlugins that populates this attribute. (These plugins are NOT provided by default. You must create your own plugin for your specific metadata) The security attribute is a HashMap containing a set of keys that map to lists of values. The metacard is then processed by a filter plugin that creates a `KeyValueCollectionPermission` from the metacard's security attribute. This permission is then checked against the user subject to determine if the subject has the correct claims to view that metacard. The decision to filter the metacard eventually relies on the PDP (`feature:install security-pdp-authz`). -The PDP returns a decision, and the metacard will either be filtered or allowed to pass through. +The PDP returns a decision, and the metacard is either filtered or allowed to pass through. The security attributes populated on the metacard are completely dependent on the type of the metacard. Each type of metacard must have its own PolicyPlugin that reads the metadata being returned and returns the metacard's security attribute. -If the subject permissions are missing during filtering, all resources will be filtered. +If the subject permissions are missing during filtering, all resources are filtered. .Example (represented as simple XML for ease of understanding): [source,xml,linenums] @@ -57,8 +58,8 @@ If the subject permissions are missing during filtering, all resources will be f ---- In the above example, the user's claims are represented very simply and are similar to how they would actually appear in a SAML 2 assertion. -Each of these user (or subject) claims will be converted to a KeyValuePermission object. -These permission objects will be implied against the permission object generated from the metacard record. +Each of these user (or subject) claims are converted to a `KeyValuePermission` object. +These permission objects are implied against the permission object generated from the metacard record. In this particular case, the metacard might be allowed if the policy is configured appropriately because all of the permissions line up correctly. To enable filtering on a new type of record, implement a PolicyPlugin that is able to read the string metadata contained within the metacard record. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-framework-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-framework-intro.adoc index fd04c107716d..0d732fbd95ea 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-framework-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-framework-intro.adoc @@ -8,4 +8,4 @@ ((({title}))) The ${branding} Security Framework utilizes http://shiro.apache.org/[Apache Shiro] as the underlying security framework. -The classes mentioned in this section will have their full package name listed, to make it easy to tell which classes come with the core Shiro framework and which are added by ${branding}. +The classes mentioned in this section have their full package name listed, to make it easy to tell which classes come with the core Shiro framework and which are added by ${branding}. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-ldap-embedded-server.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-ldap-embedded-server.adoc index 7b362c62d388..be79f65b4b03 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-ldap-embedded-server.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-ldap-embedded-server.adoc @@ -40,17 +40,17 @@ Configure the Embedded LDAP from the ${admin-console}: |Description |LDAP Port -|Sets the port for LDAP (plaintext and startTLS). 0 will disable the port. +|Sets the port for LDAP (plaintext and startTLS). 0 disables the port. |LDAPS Port -|Sets the port for LDAPS. 0 will disable the port. +|Sets the port for LDAPS. 0 disables the port. |Base LDIF File |Location on the server for a LDIF file. -This file will be loaded into the LDAP and overwrite any existing entries. +This file is loaded into the LDAP and overwrites any existing entries. This option should be used when updating the default groups/users with a new LDIF file for testing. The LDIF file being loaded may contain any LDAP entries (schemas, users, groups, etc.). -If the location is left blank, the default base LDIF file will be used that comes with ${branding}. +If the location is left blank, the default base LDIF file included with ${branding} is used. |=== @@ -230,12 +230,12 @@ The default schemas loaded into the LDAP instance are the same defaults that com === Starting and Stopping the Embedded LDAP The embedded LDAP application installs a feature with the name `ldap-embedded`. -Installing and uninstalling this feature will start and stop the embedded LDAP server. -This will also install a fresh instance of the server each time. +Installing and uninstalling this feature starts and stops the embedded LDAP server. +This also installs a fresh instance of the server each time. If changes need to persist, stop then start the `embedded-ldap-opendj` bundle (rather than installing/uninstalling the feature). All settings, configurations, and changes made to the embedded LDAP instances are persisted across ${branding} restarts. -If ${branding} is stopped while the LDAP feature is installed and started, it will automatically restart with the saved settings on the next ${branding} start. +If ${branding} is stopped while the LDAP feature is installed and started, it automatically restarts with the saved settings on the next ${branding} start. === Limitations of the Embedded LDAP diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-pdp-authz-realm.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-pdp-authz-realm.adoc index b26972a6ba00..0394a06d8787 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-pdp-authz-realm.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-pdp-authz-realm.adoc @@ -9,9 +9,9 @@ ((({title}))) The ${ddf-security} PDP AuthZ Realm exposes a realm service that makes decisions on authorization requests using the attributes stored within the metacard to determine if access should be granted. -This realm can use XACML and will delegate decisions to an external processing engine if internal processing fails. +This realm can use XACML and delegates decisions to an external processing engine if internal processing fails. Decisions are first made based on the "match-all" and "match-one" logic. -Any attributes listed in the "match-all" or "match-one" sections will not be passed to the XACML processing engine and they will be matched internally. +Any attributes listed in the "match-all" or "match-one" sections are not passed to the XACML processing engine and they are matched internally. It is recommended to list as many attributes as possible in these sections to avoid going out to the XACML processing engine for performance reasons. If it is desired that all decisions be passed to the XACML processing engine, remove all of the "match-all" and "match-one" configurations. The configuration below provides the mapping between user attributes and the attributes being asserted - one map exists for each type of mapping (each map may contain multiple values). diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-rest-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-rest-intro.adoc index 9fb42dbf2205..8920dae5a8fb 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-rest-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-rest-intro.adoc @@ -64,16 +64,16 @@ It initializes all Security Filters and runs them in order according to service . The *Web SSO Filter* reads from the web context policy manager and functions as the first decision point. If the request is from a whitelisted context, no further authentication is needed and the request skips through the rest of the security filters to the desired endpoint. -If the context is not on the whitelist, the filter will first attempt to pull authentication information off of the session. -If authentication information cannot be found on the session, the filter will then attempt to get an authentication handler for the context. +If the context is not on the whitelist, the filter first attempts to pull authentication information off of the session. +If authentication information cannot be found on the session, the filter then attempts to get an authentication handler for the context. The filter loops through all configured context handlers until one signals that it has found authentication information that it can use to build a token. This configuration can be changed by modifying the web context policy manager configuration. -If unable to resolve the context, the filter will return an authentication error and the process stops. +If unable to resolve the context, the filter returns an authentication error and the process stops. If a handler is successfully found, an auth token is assigned and the request continues to the login filter. . The *Login Filter* receives an authentication token and returns a subject. To retrieve the subject, the authentication token is sent through Shiro to the configured authenticating realms. -The realms will take the authentication token and attempt to return authentication info to the Shiro framework in order to put together a subject. +The realms takes the authentication token and attempts to return authentication info to the Shiro framework in order to put together a subject. . If the Subject is returned, the request moves to the *AuthZ Filter* to check permissions on the user. If the user has the correct permissions to access that web context, the request can hit the endpoint. @@ -123,8 +123,8 @@ The SAML Handler and the ((Assertion Consumer Service)) are both part of the IdP The ((Metadata Exchange)) happens asynchronously from any login event. The exchange can happen via HTTP or File, or the metadata XML itself can be pasted into the configuration for the SAML client. The metadata contains information about what bindings are accepted by the client or server and whether or not either expects messages to be signed, etc. -The redirect from the Assertion Consumer Service to the Endpoint will cause the client to pass back through the entire filter chain, which will get caught at the `Has Session` point of the `WebSsoFilter`. -The request will proceed through the rest of the filters as any other connection would in the previous diagram. +The redirect from the Assertion Consumer Service to the Endpoint causes the client to pass back through the entire filter chain, which gets caught at the `Has Session` point of the `WebSsoFilter`. +The request proceeds through the rest of the filters as any other connection would in the previous diagram. Unauthenticated non-browser clients that pass the HTTP headers signaling that they understand SAML ECP can authenticate via that mechanism as explained below. @@ -181,11 +181,11 @@ Unauthenticated non-browser clients that pass the HTTP headers signaling that th ((SAML ECP)) can be used to authenticate a non-browser client or non-person entity (NPE). This method of authentication is useful when there is no human in the loop, but authentication with an IdP is still desired. -The SAML Handler will send a PAOS (Reverse SOAP) request as an initial response back to the Secure Client, assuming the client has sent the necessary HTTP headers to declare that it supports this function. +The SAML Handler sends a PAOS (Reverse SOAP) request as an initial response back to the Secure Client, assuming the client has sent the necessary HTTP headers to declare that it supports this function. That response does not complete the request/response loop, but is instead caught by a SOAP intermediary, which is implemented through a CXF interceptor. The PAOS response contains an `` request message, which is intended to be rerouted to a SAML IdP via SOAP. -The SOAP intermediary will then contact an IdP (selection of the IdP is not covered by the spec). -The IdP will either reject the login attempt, or issue a Signed `` that is to be delivered to the Assertion Consumer Service by the intermediary. +The SOAP intermediary then contacts an IdP (selection of the IdP is not covered by the spec). +The IdP either rejects the login attempt, or issues a Signed `` that is to be delivered to the Assertion Consumer Service by the intermediary. The method of logging into the IdP is not covered by the spec and is up to the implementation. The SP is then signaled to supply the originally requested resource, assuming the signed Response message is valid and the user has permission to view the resource. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-sts-claims-handler.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-sts-claims-handler.adoc index 39f5f083773d..4e62272af44c 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-sts-claims-handler.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-sts-claims-handler.adoc @@ -7,7 +7,7 @@ == {title} -((Claims handlers)) are classes that convert the incoming user credentials into a set of attribute claims that will be populated in the user Subject object. -An example in action would be the LDAPClaimsHandler that takes in the user's credentials and retrieves the user's attributes from a backend LDAP server. +((Claims handlers)) are classes that convert the incoming user credentials into a set of attribute claims that are populated in the user Subject object. +For example, the `LDAPClaimsHandler` takes in the user's credentials and retrieves the user's attributes from a backend LDAP server. These attributes are then mapped and added to the Subject being created. Integrators and developers can add more claims handlers that can handle other types of external services that store user attributes. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/sts-ldap-claims-handler.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/sts-ldap-claims-handler.adoc index 813df9257153..cf7f6636f256 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/sts-ldap-claims-handler.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/sts-ldap-claims-handler.adoc @@ -12,7 +12,7 @@ The ((${ddf-security} LDAP Claims Handler)) bundle adds functionality that allow [NOTE] ==== All claims handlers are queried for user attributes regardless of realm. -This means that two different users with the same username in different LDAP servers will end up with both of their claims in each of their individual assertions. +This means that two different users with the same username in different LDAP servers end up with both of their claims in each of their individual assertions. ==== === Installing Security LDAP Claims Handler diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/atom-queryresp-xformer.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/atom-queryresp-xformer.adoc index 8a6464c2c27e..6d2e5ff48219 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/atom-queryresp-xformer.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/atom-queryresp-xformer.adoc @@ -165,7 +165,7 @@ Developers could use this transformer to programmatically transform `QueryRespon |`/feed/entry/content` |Metacard XML generated by `${branding}.catalog.transform.MetacardTransformer` with `shortname=xml`. -If no transformer found, `/feed/entry/content/@type` will be text and `Metacard.ID` is displayed +If no transformer found, `/feed/entry/content/@type` is text and `Metacard.ID` is displayed `4e1f38d1913b4e93ac622e6c1b258f89` |=== diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/custom-mime-type-resolver.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/custom-mime-type-resolver.adoc index 475689cf1e52..d5c8c1924408 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/custom-mime-type-resolver.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/custom-mime-type-resolver.adoc @@ -25,7 +25,7 @@ These are mime types not supported by the default `TikaMimeTypeResolver`. |=== -As a `MimeTypeResolver`, the Custom Mime Type Resolver will provide methods to map the file extension to the corresponding mime type, and vice versa. +As a `MimeTypeResolver`, the Custom Mime Type Resolver provides methods to map the file extension to the corresponding mime type, and vice versa. == Installing the Custom Mime Type Resolver diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/geojson-input-xformer.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/geojson-input-xformer.adoc index 559a50a1344f..2b22b8039dfd 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/geojson-input-xformer.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/geojson-input-xformer.adoc @@ -56,7 +56,7 @@ Additionally, the input transformer currently does not handle ``FeatureCollectio ---- ==== -The following sample _will_ create a valid metacard: +The following sample _does_ create a valid metacard: .Sample Parseable GeoJson (Point) [source,JSON,linenums] @@ -127,9 +127,9 @@ If a `MetacardType` is specified on the GeoJSON input, the customized properties } ---- -When the GeoJSON Input Transformer gets GeoJSON with the `MetacardType` specified, it will perform a lookup in the `MetacardTypeRegistry` to obtain the specified `MetacardType` in order to understand how to parse the GeoJSON. -If no `MetacardType` is specified, the GeoJSON Input Transformer will assume the default `MetacardType`. -If an unregistered `MetacardType` is specified, an exception will be returned to the client indicating that the `MetacardType` was not found. +When the GeoJSON Input Transformer gets GeoJSON with the `MetacardType` specified, it performs a lookup in the `MetacardTypeRegistry` to obtain the specified `MetacardType` in order to understand how to parse the GeoJSON. +If no `MetacardType` is specified, the GeoJSON Input Transformer assumes the default `MetacardType`. +If an unregistered `MetacardType` is specified, an exception is returned to the client indicating that the `MetacardType` was not found. == Usage Limitations of the GeoJSON Input Transformer diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/kml-metacard-xformer.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/kml-metacard-xformer.adoc index 4dd9068e476e..d4ce3c4a5410 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/kml-metacard-xformer.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/kml-metacard-xformer.adoc @@ -6,7 +6,7 @@ :summary: Translates a metacard into a KML-formatted document. The ((KML Metacard Transformer)) is responsible for translating a metacard into a KML-formatted document. -The KML will contain an HTML description that will display in the pop-up bubble in Google Earth. +The KML contains an HTML description that displays in the pop-up bubble in Google Earth. The HTML contains links to the full metadata view as well as the resource. == Installing the KML Metacard Transformer diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/kml-queryresp-xformer.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/kml-queryresp-xformer.adoc index 0e2fe8027a07..f326843827a4 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/kml-queryresp-xformer.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/kml-queryresp-xformer.adoc @@ -6,7 +6,7 @@ :summary: Translates a query response into a KML-formatted document. The ((KML Query Response Transformer)) translates a query response into a KML-formatted document. -The KML will contain an HTML description for each metacard that will display in the pop-up bubble in Google Earth. +The KML contains an HTML description for each metacard that displays in the pop-up bubble in Google Earth. The HTML contains links to the full metadata view as well as the resource. == Installing the KML Query Response Transformer diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/mime-type-mapper-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/mime-type-mapper-intro.adoc index e33746bbf432..88dce9232699 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/mime-type-mapper-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/mime-type-mapper-intro.adoc @@ -16,5 +16,5 @@ If no mapping is found for the file extension, `null` is returned for the mime t Similarly, the `MimeTypeMapper` accesses each `MimeTypeResolver` according to its priority until the provided mime type is successfully mapped to its corresponding file extension. If no mapping is found for the mime type, `null` is returned for the file extension. -For files with no file extension, the MimeTypeMapper will attempt to determine the mime type from the contents of the file. -If it is unsuccessful, the file will be ingested as a binary file. +For files with no file extension, the MimeTypeMapper attempts to determine the mime type from the contents of the file. +If it is unsuccessful, the file is ingested as a binary file. diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/pptx-input-xformer.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/pptx-input-xformer.adoc index c2586de3b680..92333a22895e 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/pptx-input-xformer.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/pptx-input-xformer.adoc @@ -8,7 +8,7 @@ The ((PPTX Input Transformer)) translates ((Microsoft PowerPoint)) (OOXML only) documents into Catalog Metacards, using https://tika.apache.org/[Apache Tika] for basic metadata and https://poi.apache.org/[Apache POI] for thumbnail creation. The PPTX Input Transformer ingests PPTX documents into the ${branding} Content Repository and the Metadata Catalog, and adds a thumbnail of the first page in the PPTX document. -The PPTX Input Transformer will take precedence over the Tika Input Transformer for PPTX documents. +The PPTX Input Transformer takes precedence over the Tika Input Transformer for PPTX documents. .{title} Usage [cols="1,2m" options="header"] diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/tika-mime-type-resolver.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/tika-mime-type-resolver.adoc index ac90f651ab9f..535777fb1298 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/tika-mime-type-resolver.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/tika-mime-type-resolver.adoc @@ -10,7 +10,7 @@ The `TikaMimeTypeResolver` is a `MimeTypeResolver` that is implemented using the Using the Apache Tika content analysis toolkit, the `TikaMimeTypeResolver` provides support for resolving over 1300 mime types, but not all mime types yield the same quality metadata. The `TikaMimeTypeResolver` is assigned a default priority of `-1` to insure that it is always invoked last by the `MimeTypeMapper`. -This insures that any custom `MimeTypeResolvers` that may be installed will be invoked before the `TikaMimeTypeResolver`. +This insures that any custom `MimeTypeResolvers` that may be installed is invoked before the `TikaMimeTypeResolver`. The `TikaMimeTypeResolver` provides the bulk of the default mime type support for ${branding}. diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/assuring-bundles-and-apps.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/assuring-bundles-and-apps.adoc index 29d9519c7e3b..a39804270d8b 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/assuring-bundles-and-apps.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/assuring-bundles-and-apps.adoc @@ -11,7 +11,7 @@ ${branding} Artifacts in the JAR file format (such as bundles or KAR files) can To work with Java signatures, a keystore/truststore is required. For testing or trial purposes ${branding} can sign and validate using a self-signed certificate, generated with the keytool utility. -In an actuall installation, a certificate issued from a trusted Certificate Authority will be used. +In an actual installation, a certificate issued from a trusted Certificate Authority is used. Additional documentation on keytool can be found at http://docs.oracle.com/javase/6/docs/technotes/tools/windows/keytool.html[Keytool home] {external-link}. diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/attribute-injection.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/attribute-injection.adoc index 4cac7ef22c78..4ef3ac70b314 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/attribute-injection.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/attribute-injection.adoc @@ -5,7 +5,7 @@ :summary: Creating a custom attribute injection. :order: 05 -((Attribute injections)) are defined attributes that will be injected into all metacard types or into specific metacard types. This capability allows metacard types to be extended with new attributes. +((Attribute injections)) are defined attributes that are injected into all metacard types or into specific metacard types. This capability allows metacard types to be extended with new attributes. == Attribute Injection Definition @@ -37,10 +37,10 @@ The value of `inject` is simply a list of objects where each object contains the The value corresponding to the `attribute` key is the name of the attribute to inject. The `metacardTypes` key is optional. -If it is left out, then the attribute will be injected into every metacard type. +If it is left out, then the attribute is injected into every metacard type. In that case it can be thought of as a 'global' attribute injection. If the `metacardTypes` key is included, then its value must be a list of strings where each string is the name of a metacard type. -In this case, the attribute will be injected only into metacard types that match one of the types given in the list. +In this case, the attribute is injected only into metacard types that match one of the types given in the list. .Global and Specific Inject Values [source,json] diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/attribute-type.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/attribute-type.adoc index f4f183698e0a..89bada4b6aa5 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/attribute-type.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/attribute-type.adoc @@ -43,8 +43,8 @@ The attributes `stored`, `indexed`, `tokenized`, and `multivalued` must be inclu ==== `stored`:: If true, the value of the attribute should be stored in the underlying datastore. Some attributes may only be indexed or used in transit and do not need to be persisted. `indexed`:: If true, then the value of the attribute should be included in the datastore's index and therefore be part of query evaluation. -`tokenized`:: Only applicable to STRING_TYPE attributes, if true then stopwords and punctuation will be stripped prior to storing and/or indexing. If false, only an exact string will match. -`multi-valued`:: If true, then the attribute values will be Lists of the attribute type rather than single values. +`tokenized`:: Only applicable to STRING_TYPE attributes, if true then stopwords and punctuation are stripped prior to storing and/or indexing. If false, only an exact string matches. +`multi-valued`:: If true, then the attribute values are Lists of the attribute type rather than single values. ==== The `type` attribute must also be included and must have one of the allowed values: diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-action-components.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-action-components.adoc index dda1abb0823f..9c3e6aab4260 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-action-components.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-action-components.adoc @@ -9,7 +9,7 @@ To provide a service, such as a link to a metacard, the `ActionProvider` interfa An `ActionProvider` essentially provides a List of `Actions` when given input that it can recognize and handle. For instance, if a REST endpoint ActionProvider was given a metacard, it could provide a link based on the metacard's ID. An Action Provider performs an action when given a subject that it understands. -If it does not understand the subject or does not know how to handle the given input, it will return `Collections.emptyList()`. +If it does not understand the subject or does not know how to handle the given input, it returns `Collections.emptyList()`. An Action Provider is required to have an ActionProvider id. The Action Provider must register itself in the OSGi Service Registry with the `${ddf-branding-lowercase}.action.ActionProvider` interface and must also have a service property value for `id`. An action is a URL that, when invoked, provides a resource or executes intended business logic. diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-applications.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-applications.adoc index 5639b13de70f..e89ad56cbdf6 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-applications.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-applications.adoc @@ -6,8 +6,8 @@ The ${branding} applications are a collection of OSGi bundles that contain configurations to be displayed in the ${admin-console}. The applications are defined in the ${etc/application-definitions} directory. -Any json file added to the ${etc/application-definitions} with name, description, and bundleLocations keys will be displayed in the ${admin-console}. -The application will only display if one of the bundles listed in the bundleLocations key is running or there is at least 1 plugin associated with that application running. +Any json file added to the ${etc/application-definitions} with name, description, and bundleLocations keys is displayed in the ${admin-console}. +The application only displays if one of the bundles listed in the bundleLocations key is running or there is at least 1 plugin associated with that application running. A KAR file is a Karaf-specific archive format (*K*araf *AR*chive). It is a jar file that contains a feature descriptor file and one or more OSGi bundle jar files. @@ -17,8 +17,7 @@ The feature descriptor file identifies a set of bundles that need to be installe Given the modular nature of OSGi, some applications perform operations on the services themselves. In order to present, identify, and manipulate the services, they need descriptive identifying information. -Any service that implements the `Describable` interface in `org.codice.ddf.platform.services.common` will -have an obligation to provide this information. +Any service that implements the `Describable` interface in `org.codice.ddf.platform.services.common` must provide this information. The relevant fields are as follows: ID:: a unique identifier for the service diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-filters.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-filters.adoc index 8839decb9a5a..9d840a7d1743 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-filters.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-filters.adoc @@ -284,14 +284,14 @@ ft:query(//inventory:book/@subject,'science'). . `FilterAdapter` visits the `OR` filter first. . `OR` filter visits its children in a loop. . The first child in the loop that is encountered is the LHS `PropertyIsLike`. -. The `FilterAdapter` will call the `FilterDelegate` `PropertyIsLike` method with the LHS property and literal. +. The `FilterAdapter` calls the `FilterDelegate` `PropertyIsLike` method with the LHS property and literal. . The LHS `PropertyIsLike` delegate method builds the XQuery syntax that makes sense for this particular underlying object store. In this case, the _subject_ property is specific to this XML database, and the business logic maps the _subject_ property to its index at `//inventory:book/@subject` Note that `ft:query` in this instance is a custom XQuery module for this specific XML database that does full text searches. . The `FilterAdapter` then moves back to the `OR` filter, which visits its second child. -. The `FilterAdapter` will call the `FilterDelegate` `PropertyIsLike` method with the RHS property and literal. +. The `FilterAdapter` calls the `FilterDelegate` `PropertyIsLike` method with the RHS property and literal. . The RHS `PropertyIsLike` delegate method builds the XQuery syntax that makes sense for this particular underlying object store. In this case, the _subject_ property is specific to this XML database, and the business logic maps the _subject_ property to its index at `//inventory:book/@subject` Note that `ft:query` in this instance is a custom XQuery module for this specific XML database that does full text searches. . The `FilterAdapter` then moves back to its `OR` Filter which is now done with its children. . It then collects the output of each child and sends the list of results to the `FilterDelegate OR` method. -. The final result object will be returned from the `FilterAdapter` adapt method. +. The final result object is returned from the `FilterAdapter` adapt method. ==== FilterVisitor Process for Figure Parsing @@ -394,7 +394,7 @@ The following table displays the common metacard attributes with their respectiv Comparison operators compare the value associated with a property name with a given Literal value. Endpoints and sources should try to use metacard types other than the object type. The object type only supports backwards compatibility with `java.net.URI`. -Endpoints that send other objects will not be supported by standard sources. +Endpoints that send other objects are not supported by standard sources. The following table maps the metacard types to supported comparison operators. .Metacard Types to Comparison Operators diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-query-options.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-query-options.adoc index f887aaea53d4..b1acbc8df2c1 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-query-options.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-query-options.adoc @@ -37,8 +37,7 @@ filterFactory.literal(value))) ; Every Source must be able to evaluate a Query object. Nevertheless, each Source could evaluate the Query differently depending on what that Source supports as to properties and query capabilities. For instance, a common property all Sources understand is id, but a Source could possibly store frequency values under the property name "frequency." -Some Sources may not support frequency property inquiries and will -throw an error stating it cannot interpret the property. +Some Sources may not support frequency property inquiries and throw an error stating it cannot interpret the property. In addition, some Sources might be able to handle spatial operations, while others might not. A developer should consult a Source's documentation for the limitations, capabilities, and properties that a Source can support. @@ -62,7 +61,7 @@ A developer should consult a Source's documentation for the limitations, capabil |Determines whether the total number of results should be returned. |`TimeoutMillis` -|The amount of time in milliseconds before the query is to be abandoned. If a zero or negative timeout is set, the catalog framework will default to a value configurable via the Admin UI under Catalog -> Configuration -> Query Operations. +|The amount of time in milliseconds before the query is to be abandoned. If a zero or negative timeout is set, the catalog framework defaults to a value configurable via the Admin UI under Catalog -> Configuration -> Query Operations. |=== diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-resource-readers.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-resource-readers.adoc index fac5918c2141..625f3b8ec420 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-resource-readers.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-resource-readers.adoc @@ -43,9 +43,9 @@ public ResourceResponse retrieveResource( URI uri, Map arg This method is the main entry to the `ResourceReader`. It is used to retrieve a `Resource` and send it back to the caller (generally the `CatalogFramework`). Information needed to obtain the entry is contained in the `URI` reference. -The URI Scheme will need to match a scheme specified in the `getSupportedSchemes` method. +The URI Scheme needs to match a scheme specified in the `getSupportedSchemes` method. This is how the CatalogFramework determines which `ResourceReader` implementation to use. -If there are multiple `ResourceReaders` supporting the same scheme, these `ResourceReaders` will be invoked iteratively. +If there are multiple `ResourceReaders` supporting the same scheme, these `ResourceReaders` are invoked iteratively. Invocation of the `ResourceReaders` stops once one of them returns a `Resource`. Arguments are also passed in. @@ -73,7 +73,7 @@ if ( !uri.getScheme().equals("http") ) ---- . Implement the business logic. -. For example, the `URLResourceReader` will obtain the resource through a connection: +. For example, the `URLResourceReader` obtains the resource through a connection: [source,java,linenums] ---- diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-sources.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-sources.adoc index acb9af6198b8..3ddc47e37727 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-sources.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-sources.adoc @@ -69,7 +69,7 @@ The `factory-pid` property of the metatype must contain one of the following in [NOTE] ==== -Remote sources currently extend the `ResourceReader` interface. However, a `RemoteSource` is not treated as a `ResourceReader`. The `getSupportedSchemes()` method should never be called on a `RemoteSource`, thus the suggested implementation for a `RemoteSource` is to return an empty set. The `retrieveResource( …​ )` and `getOptions( …​ )` methods will be called and MUST be properly implemented by a `RemoteSource`. +Remote sources currently extend the `ResourceReader` interface. However, a `RemoteSource` is not treated as a `ResourceReader`. The `getSupportedSchemes()` method should never be called on a `RemoteSource`, thus the suggested implementation for a `RemoteSource` is to return an empty set. The `retrieveResource( … )` and `getOptions( … )` methods are called and MUST be properly implemented by a `RemoteSource`. ==== === Developing Catalog Providers diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-sts-claims-handlers.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-sts-claims-handlers.adoc index 6f0f1e9f6b9d..0b262659682d 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-sts-claims-handlers.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-sts-claims-handlers.adoc @@ -53,7 +53,7 @@ public interface ClaimsHandler { } ---- + -. Expose the new claims handler as an OSGi service under the `org.apache.cxf.sts.claims.ClaimsHandler` interface. +. Expose the new claims handler as an OSGi service under the `org.apache.cxf.sts.claims.ClaimsHandler` interface. + [source,xml,linenums] ---- @@ -542,7 +542,7 @@ It is the simplest way to request a SAML assertion, but many endpoints won't acc * WS-Addressing header with Action, To, and Message ID * Valid, non-expired timestamp -* Username Token containing a username and password that the STS will authenticate +* Username Token containing a username and password that the STS authenticates * Issued over HTTPS * KeyType of http://docs.oasis-open.org/ws-sx/ws-trust/200512/Bearer * Claims (optional): Some endpoints may require that the SAML assertion include attributes of the user, such as an authenticated user's role, name identifier, email address, etc. If the SAML assertion needs those attributes, the `RequestSecurityToken` must specify which ones to include. @@ -598,7 +598,7 @@ This is the response from the STS containing the SAML assertion to be used in su The `saml2:Assertion` block contains the entire SAML assertion. The `Signature` block contains a signature from the STS's private key. -The endpoint receiving the SAML assertion will verify that it trusts the signer and ensure that the message wasn't tampered with. +The endpoint receiving the SAML assertion verifies that it trusts the signer and ensure that the message wasn't tampered with. The `AttributeStatement` block contains all the Claims requested. @@ -729,7 +729,7 @@ HM0dPfiQLQ99ElWkv/0= In order to obtain a SAML assertion to use in secure communication to ${branding}, a `RequestSecurityToken` (RST) request has to be made to the STS. -An endpoint's policy will specify the type of security token needed. +An endpoint's policy specifies the type of security token needed. Most of the endpoints that have been used with ${branding} require a SAML v2.0 assertion with a required KeyType of http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey. This means that the SAML assertion provided by the client to a ${branding} endpoint must contain a SubjectConfirmation block with a type of "holder-of-key" containing the client's public key. This is used to prove that the client can possess the SAML assertion returned by the STS. @@ -745,7 +745,7 @@ See the request block below for an example of how these components should be pop * Issued over HTTPS * TokenType of http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0 * KeyType of http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey -* X509 Certificate as the Proof of Possession or POP. This needs to be the certificate of the client that will be both requesting the SAML assertion and using the SAML assertion to issue a query +* X509 Certificate as the Proof of Possession or POP. This needs to be the certificate of the client that is both requesting the SAML assertion and using the SAML assertion to issue a query * Claims (optional): Some endpoints may require that the SAML assertion include attributes of the user, such as an authenticated user's role, name identifier, email address, etc. If the SAML assertion needs those attributes, the RequestSecurityToken must specify which ones to include. ** UsernameToken: If Claims are required, the RequestSecurityToken security header must contain a UsernameToken element with a username and password. @@ -831,7 +831,7 @@ This is the response from the STS containing the SAML assertion to be used in su The `saml2:Assertion` block contains the entire SAML assertion. The `Signature` block contains a signature from the STS's private key. -The endpoint receiving the SAML assertion will verify that it trusts the signer and ensure that the message wasn't tampered with. +The endpoint receiving the SAML assertion verifies that it trusts the signer and ensure that the message wasn't tampered with. The `SubjectConfirmation` block contains the client's public key, so the server can verify that the client has permission to hold this SAML assertion. The `AttributeStatement` block contains all of the claims requested. diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-transformers-input.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-transformers-input.adoc index af6bb213a3ce..ab136ddaf064 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-transformers-input.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-transformers-input.adoc @@ -137,10 +137,10 @@ Alternatively, make an Apache Camel route in a blueprint file and deploy it usin Follow this design pattern for compatibility: .From -When using *from*, `catalog:inputtransformer?id=text/xml`, an Input Transformer will be created and registered in the OSGi registry with an id of `text/xml`. +When using *from*, `catalog:inputtransformer?id=text/xml`, an Input Transformer is created and registered in the OSGi registry with an id of `text/xml`. .To -When using *to*, `catalog:inputtransformer?id=text/xml`, an Input Transformer with an id matching text/xml will be discovered from the OSGi registry and invoked. +When using *to*, `catalog:inputtransformer?id=text/xml`, an Input Transformer with an id matching text/xml is discovered from the OSGi registry and invoked. .InputTransformer Message Formats [cols="3,2,1m" optiona="header"] @@ -163,7 +163,7 @@ When using *to*, `catalog:inputtransformer?id=text/xml`, an Input Transformer wi [TIP] ==== Its always a good idea to wrap the `mimeType` value with the RAW parameter as shown in the example above. -This will ensure that the value is taken exactly as is, and is especially useful when you are using special characters. +This ensures that the value is taken exactly as is, and is especially useful when you are using special characters. ==== .InputTransformer Creation Example @@ -196,4 +196,4 @@ An example of using an Apache Camel route to define an `InputTransformer` in a b == Input Transformer Boot Service Flag The `org.codice.ddf.platform.bootflag.BootServiceFlag` service with a service property of `id=inputTransformerBootFlag` is used to indicate certain Input Transformers are ready in the system. -Adding an Input Transformers ID to a new or existing JSON file under `${home_directory}/etc/transformers` will cause the service to wait for an Input Transformer with the given ID. +Adding an Input Transformers ID to a new or existing JSON file under `${home_directory}/etc/transformers` causes the service to wait for an Input Transformer with the given ID. diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-xacml-policies.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-xacml-policies.adoc index 452026a81c46..2caf7f5d5587 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-xacml-policies.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-xacml-policies.adoc @@ -19,8 +19,8 @@ Additional components can be created and added to ${branding} to identify specif ==== In the examples below, the policy has specified targets for the above type of calls. -For the Filtering code, the target was set for "filter", and the Service validation code targets were geared toward two services: `query` and `LocalSiteName`. -In a production environment, these actions for service authorization will generally be full URNs that are described within the SOAP WSDL. +For the Filtering code, the target was set for `filter`, and the Service validation code targets were geared toward two services: `query` and `LocalSiteName`. +In a production environment, these actions for service authorization generally are full URNs that are described within the SOAP WSDL. == XACML Policy Attributes diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/default-attribute-values.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/default-attribute-values.adoc index 0a19bcea718e..a201e5342329 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/default-attribute-values.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/default-attribute-values.adoc @@ -34,7 +34,7 @@ The value of `defaults` is a list of objects where each object contains the keys } ---- -The value corresponding to the `attribute` key is the name of the attribute to which the default value will be applied. The value corresponding to the `value` key is the default value of the attribute. +The value corresponding to the `attribute` key is the name of the attribute to which the default value is applied. The value corresponding to the `value` key is the default value of the attribute. [NOTE] ==== @@ -43,11 +43,12 @@ The attribute's default value must be of the same type as the attribute, but it Dates must be UTC datetimes in the ISO 8601 format, `yyyy-MM-ddTHH:mm:ssZ` ==== -The `metacardTypes` key is optional. If it is left out, then the default attribute value will be applied to every metacard that has that attribute. It can be thought of as a 'global' default value. If the `metacardTypes` key is included, then its value must be a list of strings where each string is the name of a metacard type. In this case, the default attribute value will be applied only to metacards that match one of the types given in the list. +The `metacardTypes` key is optional. If it is left out, then the default attribute value is applied to every metacard that has that attribute. It can be thought of as a 'global' default value. If the `metacardTypes` key is included, then its value must be a list of strings where each string is the name of a metacard type. In this case, the default attribute value is applied only to metacards that match one of the types given in the list. [NOTE] ==== -In the event that an attribute has a 'global' default value as well as a default value for a specific metacard type, the default value for the specific metacard type will be applied (the more specific default value wins). +In the event that an attribute has a 'global' default value as well as a default value for a specific metacard type, the default value for the specific metacard +type is applied (the more specific default value wins). ==== Example: diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/editing-docs.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/editing-docs.adoc index 69d816bd6860..8b3b2d1d489d 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/editing-docs.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/editing-docs.adoc @@ -41,7 +41,7 @@ Quick Start:: This section is intended for getting set up with a test, demonstra Managing:: The managing section covers "how-to" instructions to be used to install, configure, and maintain an instance of ${branding} in a production environment. This content should be aimed at system administrators. Security hardening should be integrated into these sections. -Using:: This section is primarily aimed at the final end users who will be performing tasks with ${branding}. This content should guide users through common tasks and user interfaces. +Using:: This section is primarily aimed at the final end users who perform tasks with ${branding}. This content should guide users through common tasks and user interfaces. Integrating:: This section guides developers building other projects looking to connect to new or existing instances of ${branding}. @@ -98,4 +98,4 @@ By mimicking the build and directory structure of the documentation, downstream Sub-directories are organized according to the documents that make up the main library. `images`:: any pre-existing images, such as screenshots, to be included in the documentation. `templates`:: template files used to create documentation artifacts. -A `build` sub-directory holds the templates that will not be standalone documents to render specific sections. +A `build` sub-directory holds the templates that are not standalone documents to render specific sections. diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/filter-delegates.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/filter-delegates.adoc index 6940d45b9239..310ff590b6bc 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/filter-delegates.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/filter-delegates.adoc @@ -11,13 +11,13 @@ The reference Filter Adapter implementation contains the necessary boilerplate v == Creating a New Filter Delegate A Filter Delegate contains the logic that converts normalized filter input into a form that the target data source can handle. -Delegate methods will be called in a depth first order as the Filter Adapter visits filter nodes. +Delegate methods are called in a depth-first order as the Filter Adapter visits filter nodes. === Implementing the Filter Delegate . Create a Java class extending `FilterDelegate`. + `public class ExampleDelegate extends ${ddf-branding}.catalog.filter.FilterDelegate {` -. `FilterDelegate` will throw an appropriate exception for all methods not implemented. Refer to the ${branding} JavaDoc for more details about what is expected of each `FilterDelegate` method. +. `FilterDelegate` throws an appropriate exception for all methods not implemented. Refer to the ${branding} JavaDoc for more details about what is expected of each `FilterDelegate` method. [NOTE] ==== @@ -27,7 +27,7 @@ A code example of a Filter Delegate can be found in `${ddf-branding}.catalog.fil === Throwing Exceptions Filter delegate methods can throw `UnsupportedOperationException` run-time exceptions. -The `GeotoolsFilterAdapterImpl` will catch and re-throw these exceptions as `UnsupportedQueryExceptions`. +The `GeotoolsFilterAdapterImpl` catches and re-throws these exceptions as `UnsupportedQueryExceptions`. === Using the Filter Adapter diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/json-definition-files.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/json-definition-files.adoc index 2e29aae7e375..ac41b4e0d8f7 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/json-definition-files.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/json-definition-files.adoc @@ -32,4 +32,4 @@ Once the definition file is ready to be deployed, put the definition file `:/services/catalog/ ---- -If successful, a status of `200 OK` will be returned, along with the content of the metacard requested. +If successful, a status of `200 OK` is returned, along with the content of the metacard requested. .Read Success Response Example [source,javascript,linenums] diff --git a/distribution/docs/src/main/resources/content/_integrating/_endpoints/csw-endpoint.adoc b/distribution/docs/src/main/resources/content/_integrating/_endpoints/csw-endpoint.adoc index abd79ab9f3cf..f8ba6c41fbda 100644 --- a/distribution/docs/src/main/resources/content/_integrating/_endpoints/csw-endpoint.adoc +++ b/distribution/docs/src/main/resources/content/_integrating/_endpoints/csw-endpoint.adoc @@ -86,7 +86,7 @@ use the `typeName` attribute in the `csw:Insert` element ---- To receive a copy of the metacard in the response, specify `verboseResponse="true"` in the `csw:Transaction`. -The `InsertResult` element of the response will hold the metacard information added to the catalog. +The `InsertResult` element of the response holds the metacard information added to the catalog. [source,xml] ---- @@ -110,7 +110,7 @@ The `InsertResult` element of the response will hold the metacard information ad ---- -A successful ingest will return a status of `200 OK` and `csw:TransactionResponse`. +A successful ingest returns a status of `200 OK` and `csw:TransactionResponse`. .Sample XML Transaction `Insert` Response [source,xml] @@ -296,11 +296,11 @@ Within the `Constraint` element, define the query as an OSG or CQL filter. .Querying a Specific Source with the CSW Endpoint To query a `Specific Source`, specify a query for a `source-id`. To find a valid `source-id` , send a <<{integrating-prefix}csw_endpoint_get_capabilities_examples,Get Capabilities>> request. -Configured sources will be listed in the `FederatedCatalogs` section of the response. +Configured sources are listed in the `FederatedCatalogs` section of the response. [NOTE] ==== -The `DistributedSearch` element must be specific with a `hopCount` greater than 1 to identify it as a federated query, otherwise the ``source-id``'s will be ignored. +The `DistributedSearch` element must be specific with a `hopCount` greater than 1 to identify it as a federated query, otherwise the ``source-id``'s is ignored. ==== .Querying a Specific Source Sample Request @@ -851,7 +851,7 @@ Within the `csw:Transaction` element, use the `csw:RecordProperty` to update ind Use the `Name` element to specify the name of the record property to be updated and set the `Value` element to the value to update in the record. -The values in the `Update` will completely replace those that are already in the record. +The values in the `Update` completely replace those that are already in the record. [source,xml,linenums] ---- @@ -1040,9 +1040,9 @@ but it subscribes to a search and sends events to a `ResponseHandler` endpoint a the `GetRecords` request used in the subscription. The `ResponseHandler` must use the https protocol and receive a HEAD request to poll for availability and POST/PUT/DELETE requests for creation, updates, and deletions. -The response to a `GetRecords` request on the subscription url will be an acknowledgement containing the original +The response to a `GetRecords` request on the subscription url is an acknowledgement containing the original `GetRecords` request and a `requestId`. -The client will be assigned a `requestId` (URN). +The client is assigned a `requestId` (URN). A Subscription listens for events from federated sources if the `DistributedSearch` element is present and the catalog is a member of a federation. @@ -1299,7 +1299,7 @@ The constraint can be either an OGC or CQL filter. The `GetCapabilities` operation describes the operations the catalog supports and the URLs used to access those operations. The CSW endpoint supports both `HTTP GET` and `HTTP POST` requests for the `GetCapabilities` operation. -The response to either request will always be a `csw:Capabilities` XML document. +The response to either request is always a `csw:Capabilities` XML document. This XML document is defined by the http://schemas.opengis.net/csw/2.0.2/CSW-discovery.xsd[CSW-Discovery XML Schema] {external-link}. .CSW Endpoint `GetCapabilities` URL for GET request diff --git a/distribution/docs/src/main/resources/content/_integrating/_endpoints/endpoint-intro.adoc b/distribution/docs/src/main/resources/content/_integrating/_endpoints/endpoint-intro.adoc index 270f9a7507ab..ea9ee08863b6 100644 --- a/distribution/docs/src/main/resources/content/_integrating/_endpoints/endpoint-intro.adoc +++ b/distribution/docs/src/main/resources/content/_integrating/_endpoints/endpoint-intro.adoc @@ -8,6 +8,6 @@ [NOTE] ==== -Not all installations will expose all available endpoints. Check with ${branding} administrator to confirm availability of these endpoints. +Not all installations expose all available endpoints. Check with ${branding} administrator to confirm availability of these endpoints. ==== diff --git a/distribution/docs/src/main/resources/content/_integrating/_endpoints/opensearch-endpoint.adoc b/distribution/docs/src/main/resources/content/_integrating/_endpoints/opensearch-endpoint.adoc index 924450d4a456..73fb9abb039d 100644 --- a/distribution/docs/src/main/resources/content/_integrating/_endpoints/opensearch-endpoint.adoc +++ b/distribution/docs/src/main/resources/content/_integrating/_endpoints/opensearch-endpoint.adoc @@ -215,7 +215,7 @@ The OpenSearch Endpoint can also use these additional parameters to refine queri |`` is optional but has a value of `asc` or `desc` (default is `desc`). However, when `` is `relevance`, `` must be `desc`. -Sorting by `date` will sort the results by the <<{metadata-prefix}effective,`effective`>> date. +Sorting by `date` sorts the results by the <<{metadata-prefix}effective,`effective`>> date. default: `relevance:desc` @@ -224,7 +224,7 @@ default: `relevance:desc` |Integer >= 0 |Maximum # of results to return. -If `count` is also specified, the `count` value will take precedence over the `maxResults` value. +If `count` is also specified, the `count` value takes precedence over the `maxResults` value. default: `1000` diff --git a/distribution/docs/src/main/resources/content/_integrating/_endpoints/prometheus-endpoint.adoc b/distribution/docs/src/main/resources/content/_integrating/_endpoints/prometheus-endpoint.adoc index 278a332cbb92..ea011f941fd1 100644 --- a/distribution/docs/src/main/resources/content/_integrating/_endpoints/prometheus-endpoint.adoc +++ b/distribution/docs/src/main/resources/content/_integrating/_endpoints/prometheus-endpoint.adoc @@ -11,7 +11,7 @@ The ((Prometheus endpoint)) provides various metrics about ${branding} such as the number of queries made to a specific source and counters of ingest operations. -An external Prometheus server will need to be setup and configured to scrape from ${branding}. The +An external Prometheus server must be set up and configured to scrape from ${branding}. The endpoint is exposed at: .Prometheus URL diff --git a/distribution/docs/src/main/resources/content/_integrating/_endpoints/query-endpoints.adoc b/distribution/docs/src/main/resources/content/_integrating/_endpoints/query-endpoints.adoc index 1832a88e8471..19b07505f04c 100644 --- a/distribution/docs/src/main/resources/content/_integrating/_endpoints/query-endpoints.adoc +++ b/distribution/docs/src/main/resources/content/_integrating/_endpoints/query-endpoints.adoc @@ -48,7 +48,7 @@ To create a query metacard through the queries endpoint, send a `POST` request t } ---- -A successful create request will return a status of `201 CREATED`. +A successful create request returns a status of `201 CREATED`. .Queries Endpoint Create Success Response Body [source,json,linenums] @@ -78,7 +78,7 @@ A successful create request will return a status of `201 CREATED`. } ---- -An unsuccessful create request will return a status of `500 SERVER ERROR`. +An unsuccessful create request returns a status of `500 SERVER ERROR`. .Queries Endpoint Create Failure Response Body [source,json,linenums] @@ -134,7 +134,7 @@ To retrieve a query metacard through the queries endpoint, send a `GET` request |=== -A successful retrieval request will return a status of `200 OK`. +A successful retrieval request returns a status of `200 OK`. === Queries Endpoint Retrieve All Fuzzy Examples @@ -146,7 +146,7 @@ To retrieve all query metacards based on some text based value through the queri https://:/search/catalog/internal/queries?text= ---- -A fuzzy search will only be performed against the `title`, `modified`, `owner`, and `description` attributes. +A fuzzy search is only performed against the `title`, `modified`, `owner`, and `description` attributes. === Queries Endpoint Retrieve Examples @@ -158,7 +158,7 @@ https://:/search/catalog/internal/queries/ To retrieve a specific query metacard through the queries endpoint, send a `GET` request to the queries endpoint with an id. -A successful retrieval request will return a status of `200 OK`. +A successful retrieval request returns a status of `200 OK`. .Query Endpoint Not Found Response Body [source,json,linenums] @@ -168,7 +168,7 @@ A successful retrieval request will return a status of `200 OK`. } ---- -An unsuccessful retrieval request will return a status of `404 NOT FOUND`. +An unsuccessful retrieval request returns a status of `404 NOT FOUND`. === Queries Endpoint Update Examples @@ -198,7 +198,7 @@ To update a specific query metacard through the queries endpoint, send a `PUT` r } ---- -A successful update request will return a status of `200 OK`. +A successful update request returns a status of `200 OK`. .Update Query Request Response Body [source,json,linenums] @@ -228,7 +228,7 @@ A successful update request will return a status of `200 OK`. } ---- -An unsuccessful update request will return a status of `404 NOT FOUND`. +An unsuccessful update request returns a status of `404 NOT FOUND`. .Update Query Unsuccessful Response Body [source,json,linenums] @@ -249,9 +249,9 @@ https://:/search/catalog/internal/queries/ To delete a specific query metacard through the queries endpoint, send a `GET` request to the queries endpoint with an id. -A successful deletion request will return a status of `204 NO CONTENT`. +A successful deletion request returns a status of `204 NO CONTENT`. -An unsuccessful deletion request will return a status of `404 NOT FOUND`. +An unsuccessful deletion request returns a status of `404 NOT FOUND`. .Delete Query Not Found Response Body [source,json,linenums] diff --git a/distribution/docs/src/main/resources/content/_integrating/_eventing/subscriptions.adoc b/distribution/docs/src/main/resources/content/_integrating/_eventing/subscriptions.adoc index fcafe89fbe82..2d892c29c61b 100644 --- a/distribution/docs/src/main/resources/content/_integrating/_eventing/subscriptions.adoc +++ b/distribution/docs/src/main/resources/content/_integrating/_eventing/subscriptions.adoc @@ -15,13 +15,13 @@ A Subscription itself is a series of events during which various plugins or tran === Creation * Subscriptions are created directly with the<<{architecture-prefix}event_processor,Event Processor>> or declaratively through use of the Whiteboard Design Pattern. -* The Event Processor will invoke each Pre-Subscription Plugin and, if the subscription is not rejected, the subscription will be activated. +* The Event Processor invokes each Pre-Subscription Plugin and, if the subscription is not rejected, the subscription is activated. === Evaluation -* When a metacard matching the subscription is created, updated, or deleted in any Source, each Pre-Delivery Plugin will be invoked. +* When a metacard matching the subscription is created, updated, or deleted in any Source, each Pre-Delivery Plugin is invoked. -* If the delivery is not rejected, the associated Delivery Method callback will be invoked. +* If the delivery is not rejected, the associated Delivery Method callback is invoked. === Update Evaluation @@ -30,7 +30,8 @@ Notably, the Catalog allows event evaluation on both the previous value (if avai === Durability Subscription durability is not provided by the Event Processor. -Thus, all subscriptions are transient and will not be recreated in the event of a system restart. +Thus, all subscriptions are transient and not recreated in the event of a system restart. + It is the responsibility of Endpoints using subscriptions to persist and re-establish the subscription on startup. This decision was made for the sake of simplicity, flexibility, and the inability of the Event Processor to recreate a fully configured Delivery Method without being overly restrictive. @@ -49,8 +50,8 @@ Currently, the Catalog reference implementation does not contain a subscription Therefore, an endpoint that exposes a web service interface to create, update, and delete subscriptions would provide a client's subscription filtering criteria to be used by Catalog's Event Processor to determine which events are of interest to the client. The endpoint client also provides the callback URL of the event consumer to be called when an event matching the subscription's criteria is found. This callback to the event consumer is made by a Delivery Method implementation that the client provides when the subscription is created. -Whenever an event occurs in the Catalog matching the subscription, the Delivery Method implementation will be called by the Event Processor. -The Delivery Method will, in turn, send the event notification out to the event consumer. +Whenever an event occurs in the Catalog matching the subscription, the Delivery Method implementation is called by the Event Processor. +The Delivery Method, in turn, sends the event notification out to the event consumer. As part of the subscription creation process, the Catalog verifies that the event consumer at the specified callback URL is available to receive callbacks. Therefore, the client must ensure the event consumer is running prior to creating the subscription. The Catalog completes the subscription creation by executing any pre-subscription Catalog Plugins, and then registering the subscription with the OSGi Service Registry. diff --git a/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/high-availability-intro.adoc b/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/high-availability-intro.adoc index 72ae271735a6..735ea32f3b27 100644 --- a/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/high-availability-intro.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/high-availability-intro.adoc @@ -13,16 +13,16 @@ In a Highly Available Cluster, ${branding} has failover capabilities when a ${br [NOTE] ==== -The word "node", from a High Availability perspective, is one of the two ${branding} systems running within the Highly Available Cluster. +The word "node," from a High Availability perspective, describes one of the two ${branding} systems running within the Highly Available Cluster. Though there are multiple systems running with the Highly Available Cluster, it is still considered a single ${branding} from a user's perspective or from other ${branding}s' perspectives. ==== This setup consists of a SolrCloud instance, 2 ${branding} nodes connected to that SolrCloud, and a failover proxy that sits in front of those 2 nodes. -One of the ${branding} nodes will be arbitrarily chosen to be the active node, and the other will be the "hot standby" node. +One of the ${branding} nodes is arbitrarily chosen to be the active node, and the other is the "hot standby" node. It is called a "hot standby" node because it is ready to receive traffic even though it's not currently receiving any. -The failover proxy will route all traffic to the active node. -If the active node fails for any reason, the standby node will become active and the failover proxy will route all traffic to the new active node. +The failover proxy routes all traffic to the active node. +If the active node fails for any reason, the standby node becomes active and the failover proxy routes all traffic to the new active node. See the below diagrams for more detail. .Highly Available Cluster diff --git a/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/ingest-intro.adoc b/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/ingest-intro.adoc index 3ebd21e840ee..3b06a03e9026 100644 --- a/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/ingest-intro.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/ingest-intro.adoc @@ -11,5 +11,5 @@ Ingest is the process of bringing data resources, metadata, or both into the cat Ingested files are <<{integrating-prefix}transformers,transformed>> into a neutral format that can be searched against as well as migrated to other formats and systems. See <<{managing-prefix}ingesting_data, Ingesting Data>> for the various methods of ingesting data. -Upon ingest, a transformer will read the metadata from the ingested file and populate the fields of a metacard. +Upon ingest, a transformer reads the metadata from the ingested file and populates the fields of a metacard. Exactly how this is accomplished depends on the origin of the data, but most fields (except id) are imported directly. diff --git a/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/search-intro.adoc b/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/search-intro.adoc index 7238c2996e6b..e85aa9d92993 100644 --- a/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/search-intro.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/search-intro.adoc @@ -30,5 +30,5 @@ Temporal searches can use the `created` or `modified` date attributes. Datatype Search:: A datatype search is used to search for metadata based on the datatype of the resource. Wildcards (*) can be used in both the datatype and version fields. -Metadata that matches any of the datatypes (and associated versions if specified) will be returned. -If a version is not specified, then all metadata records for the specified datatypes regardless of version will be returned. +Metadata that matches any of the datatypes (and associated versions if specified) is returned. +If a version is not specified, then all metadata records for the specified datatypes regardless of version are returned. diff --git a/distribution/docs/src/main/resources/content/_introduction/developing-intro.adoc b/distribution/docs/src/main/resources/content/_introduction/developing-intro.adoc index 806ca74c3769..14e460a421aa 100644 --- a/distribution/docs/src/main/resources/content/_introduction/developing-intro.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/developing-intro.adoc @@ -4,7 +4,7 @@ :summary: Introduction to Developing sections. :order: 00 -Developers will build or extend the functionality of the applications.  +Developers build or extend the functionality of the applications.  ${branding} includes several extension points where external developers can add functionality to support individual use cases. diff --git a/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc b/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc index 38db49838253..547fa4264686 100644 --- a/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc @@ -14,7 +14,7 @@ This introduction section is intended to give a high-level overview of the conce Administrators:: <<{managing-prefix}managing,Managing>> | -Administrators will be installing, maintaining, and supporting existing applications. +Administrators install, maintain, and support existing applications. Use this section to <<{managing-prefix}installation_prerequisites,prepare>>, <<{managing-prefix}installing,install>>, <<{managing-prefix}configuring,configure>>, <<{managing-prefix}running,run>>, and <<{managing-prefix}monitoring,monitor>> ${branding}. Users:: @@ -24,11 +24,12 @@ Use this section to navigate the various user interfaces available in ${branding Integrators:: <<{integrating-prefix}integrating,Integrating>> | -Integrators will use the existing applications to support their external frameworks. This section will provide details for finding, accessing, and using the components of ${branding}. + +Integrators use the existing applications to support their external frameworks. This section provides details for finding, accessing, and using the components of ${branding}. Developers:: <<{developing-prefix}developing,Developing>> | -Developers will build or extend the functionality of the applications. +Developers build or extend the functionality of the applications. === Documentation Conventions @@ -53,7 +54,7 @@ Hyperlinks that take the user away from the ${branding} documentation are marked === Support -Questions about ${ddf-branding} should be posted to the https://groups.google.com/d/forum/ddf-users[ddf-users forum] {external-link} or https://groups.google.com/d/forum/ddf-developers[ddf-developers forum] {external-link}, where they will be responded to quickly by a member of the ${ddf-branding} team. +Questions about ${ddf-branding} should be posted to the https://groups.google.com/d/forum/ddf-users[ddf-users forum] {external-link} or https://groups.google.com/d/forum/ddf-developers[ddf-developers forum] {external-link}, to be responded to quickly by a member of the ${ddf-branding} team. ==== Documentation Updates diff --git a/distribution/docs/src/main/resources/content/_introduction/managing-intro.adoc b/distribution/docs/src/main/resources/content/_introduction/managing-intro.adoc index 2016299b52b2..ad5d663d1e68 100644 --- a/distribution/docs/src/main/resources/content/_introduction/managing-intro.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/managing-intro.adoc @@ -3,5 +3,5 @@ :status: published :priority: 1 -Administrators will be installing, maintaining, and supporting existing applications. +Administrators install, maintain, and support existing applications. Use this section to prepare, install, configure, run, and monitor a ${branding}. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/confluence-federated-source.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/confluence-federated-source.adoc index 25b9c8cf44c2..e5c509ec1bb5 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/confluence-federated-source.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/confluence-federated-source.adoc @@ -43,11 +43,11 @@ See <<{reference-prefix}Confluence_Federated_Source, Confluence Federated Source [IMPORTANT] ==== -If an additional attribute is not part of the Confluence metacard type or <<{developing-prefix}attribute_injection_definition,injected>>, the attribute will not be added to the metacard. +If an additional attribute is not part of the Confluence metacard type or <<{developing-prefix}attribute_injection_definition,injected>>, the attribute is not added to the metacard. ==== .Usage Limitations of the Confluence Federated Source -Most of the fields that can be queried on Confluence have some sort of restriction on them. Most of the fields do not support the `like` aka `~` operation so the source will convert `like` queries to `equal` queries for attributes that don't support `like`. If the source receives a query with attributes it doesn't understand, it will just ignore them. If the query doesn't contain any attributes that map to Confluence search attributes, an empty result set will be returned. +Most of the fields that can be queried on Confluence have some sort of restriction on them. Most of the fields do not support the `like` aka `~` operation so the source converts `like` queries to `equal` queries for attributes that don't support `like`. If the source receives a query with attributes it doesn't understand, it just ignores them. If the query doesn't contain any attributes that map to Confluence search attributes, an empty result set is returned. -Depending on your version of Confluence, when downloading attachments you might get redirected to a different download URL. The default URLResourceReader configuration allows redirects, but if the option was disabled in the past, the download will fail. This can be fixed by re-enabling redirects in the `URLResourceReader` <<{developing-prefix}configuring_the_url_resource_reader,configuration>>. +Depending on your version of Confluence, when downloading attachments you might get redirected to a different download URL. The default `URLResourceReader` configuration allows redirects, but if the option was disabled in the past, the download fails. This can be fixed by re-enabling redirects in the `URLResourceReader` <<{developing-prefix}configuring_the_url_resource_reader,configuration>>. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/federation-strategy.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/federation-strategy.adoc index 530b9abaae6a..788e10dc958c 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/federation-strategy.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/federation-strategy.adoc @@ -7,11 +7,11 @@ == {title} -A federation strategy federates a query to all of the Remote Sources in the query's list, processes the results in a unique way, and then returns the results to the client.  -For example, implementations can choose to halt processing until all results return and then perform a mass sort or return the results back to the client as soon as they are received back from a Federated Source. +A federation strategy federates a query to all of the Remote Sources in the query's list, processes the results in a unique way, and then returns the results to the client. +For example, implementations can choose to halt processing until all results return and then perform a mass sort or return the results back to the client as soon as they are received back from a Federated Source. -An endpoint can optionally specify the federation strategy to use when it invokes the query operation. -Otherwise, the Catalog provides a default federation strategy that will be used: the Catalog Federation Strategy. +An endpoint can optionally specify the federation strategy to use when it invokes the query operation. +Otherwise, the Catalog provides a default federation strategy to use: the Catalog Federation Strategy. === Configuring Federation Strategy diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/opensearch-source.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/opensearch-source.adoc index ad1a0cd37891..d97a8c67b601 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/opensearch-source.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/opensearch-source.adoc @@ -90,7 +90,7 @@ If multiple point radius searches are encountered, each point radius is converte |Pulled from the query if it is a bounding-box query. + + Or else, calculated from the query if it is a single geometry or polygon query and the <<{reference-prefix}shouldConvertToBBox,`shouldConvertToBBox`>> configuration option is `true`. -NOTE: Converting a polygon that crosses the antimeridian to a bounding box will produce an incorrect bounding box. + +NOTE: Converting a polygon that crosses the antimeridian to a bounding box produces an incorrect bounding box. + //TODO DDF-3742 + Or else, calculated from the query if it is a geometry collection and the <<{reference-prefix}shouldConvertToBBox,`shouldConvertToBBox`>> configuration option is `true`. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/solr-catalog-provider.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/solr-catalog-provider.adoc index 4e2798d77046..bd812df362f9 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/solr-catalog-provider.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/solr-catalog-provider.adoc @@ -65,7 +65,7 @@ Configuration shared between Solr Server instances is managed by Zookeeper. ==== A minimum of three Zookeeper nodes required. Three Zookeeper nodes are needed to form a quorum. -A three Zookeeper ensemble allows for a single server to fail and the service will still be available. +A three Zookeeper ensemble allows for a single server to fail and the service to still be available. More Zookeeper nodes can be added to achieve greater fault tolerance. The total number of nodes must always be an odd number. See https://lucene.apache.org/solr/guide/${solr.docs.version}/setting-up-an-external-zookeeper-ensemble.html#SettingUpanExternalZooKeeperEnsemble-SettingupaZooKeeperEnsemble[ Setting Up an External Zoo Keeper Ensemble] for more information. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-11-source.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-11-source.adoc index fd9bd201846c..3398541714b9 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-11-source.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-11-source.adoc @@ -42,10 +42,10 @@ See <<{reference-prefix}Wfs_v1_1_0_Federated_Source,WFS v.1.1 Federated Source c .WFS URL The WFS URL must match the endpoint for the service being used. The type of service and version are added automatically, so they do not need to be included. -Some servers will throw an exception if they are included twice, so do not include those. +Some servers throw an exception if they are included twice, so do not include those. The syntax depends on the server. -However, in most cases, the syntax will be everything before the `?` character in the URL that corresponds to the `GetCapabilities` query. +However, in most cases, the syntax is everything before the `?` character in the URL that corresponds to the `GetCapabilities` query. .Example GeoServer 2.12.1 Syntax ---- @@ -58,4 +58,4 @@ In this case, the WFS URL would be: `http://www.example.org:8080/geoserver/wfs` The WFS v1.1.0 Source supports mapping metacard attributes to WFS feature properties for queries (GetFeature requests) to the WFS server. The source uses a `MetacardMapper` service to determine how to map a given metacard attribute in a query to a feature property the WFS server understands. It looks for a `MetacardMapper` whose `getFeatureType()` matches the feature type being queried. -Any `MetacardMapper` service implementation will work, but ${branding} provides one in the ${ddf-spatial} application called <<{reference-prefix}org.codice.ddf.spatial.ogc.wfs.catalog.mapper.MetacardMapper,Metacard to WFS Feature Map>>. +Any `MetacardMapper` service implementation can be used, but ${branding} provides one in the ${ddf-spatial} application called <<{reference-prefix}org.codice.ddf.spatial.ogc.wfs.catalog.mapper.MetacardMapper,Metacard to WFS Feature Map>>. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-20-source.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-20-source.adoc index 0f31f3bb20e3..70eda67ab01a 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-20-source.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-20-source.adoc @@ -39,10 +39,10 @@ See <<{reference-prefix}Wfs_v2_0_0_Federated_Source,WFS v.2.0 Federated source c .WFS URL The WFS URL must match the endpoint for the service being used. The type of service and version is added automatically, so they do not need to be included. -Some servers will throw an exception if they are included twice, so do not include those. +Some servers throw an exception if they are included twice, so do not include those. The syntax depends on the server. -However, in most cases, the syntax will be everything before the `?` character in the URL that corresponds to the `GetCapabilities` query. +However, in most cases, the syntax is everything before the `?` character in the URL that corresponds to the `GetCapabilities` query. .Example GeoServer 2.5 Syntax ---- @@ -78,8 +78,8 @@ There are two ways to configure the `MetacardMapper`: .Example WFS MetacardMapper Configuration The following shows how to configure the `MetacardMapper` to be used with the sample data provided with GeoServer. This configuration shows a custom mapping for the feature type ‘states’. -For the given type, we are taking the feature property ‘STATE_NAME’ and mapping it to the metacard attribute ‘title’. -In this particular case, since we mapped the state name to title in the metacard, it will now be fully searchable. +For the given type, the feature property ‘STATE_NAME’ is mapped to the metacard attribute ‘title’. +In this particular case, since the state name is mapped to title in the metacard, it is now fully searchable. .Example `MetacardMapper` Configuration Within a `feature.xml` file: [source,xml,linenums] diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-sources-services.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-sources-services.adoc index b6d78b73dcb4..a11a9c4115d0 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-sources-services.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/_sources/wfs-sources-services.adoc @@ -26,7 +26,7 @@ or <<{managing-prefix}wfs_2_0_source,WFS v2.0.0 Source>> for more information ab .Converting a WFS Feature In order to expose WFS features to ${branding} clients, the WFS feature must be converted into the common data format of the ${branding}, a metacard. The OGC package contains a `GenericFeatureConverter` that attempts to populate mandatory metacard fields with properties from the WFS feature XML. -All properties will be mapped directly to new attributes in the metacard. +All properties are mapped directly to new attributes in the metacard. However, the `GenericFeatureConverter` may not be able to populate the default metacard fields with properties from the feature XML. .Creating a Custom Converter diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/admin-console-tutorial.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/admin-console-tutorial.adoc index 74e3209479a0..c7e5cfd60e7d 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/admin-console-tutorial.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/admin-console-tutorial.adoc @@ -58,7 +58,7 @@ Features are collections of OSGi bundles, configuration data, and/or other featu .Transitive Dependencies [NOTE] ==== -Features may have dependencies on other features and will auto-install them as needed. +Features may have dependencies on other features and auto-install them as needed. ==== In the ${admin-console}, Features are found on the *Features* tab of the *System* tab. @@ -68,8 +68,8 @@ In the ${admin-console}, Features are found on the *Features* tab of the *System . Select the *Features* tab. . Uninstalled features are shown with a *play* arrow under the *Actions* column. .. Select the *play* arrow for the desired feature. -.. The *Status* will change from *Uninstalled* to *Installed*. +.. The *Status* changes from *Uninstalled* to *Installed*. . Installed features are shown with a *stop* icon under the *Actions* column. .. Select the *stop* icon for the desired feature. -.. The *Status* will change from *Installed* to *Uninstalled*. +.. The *Status* changes from *Installed* to *Uninstalled*. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/catalog-authorization.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/catalog-authorization.adoc index 24d4aebcd28d..e00901745652 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/catalog-authorization.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/catalog-authorization.adoc @@ -19,8 +19,8 @@ All ${branding} Catalog operations can be restricted to users with certain attri . Select on the *Resource URI Policy Plugin* configuration. . Add any required attributes for each operation type. -Only users with the attributes listed on the *Catalog Policy Plugin* configuration will be allowed to access those operations. +Only users with the attributes listed on the *Catalog Policy Plugin* configuration are allowed to access those operations. By default, all operations only require a role of "guest" which every user has mixed into their attributes by way of the *Guest Claims Handler*. -If the default Guest user role is changed to something other than "guest" this configuration will need to be updated to allow users to continue using ${branding} Catalog operations. +If the default Guest user role is changed to something other than "guest" this configuration must be updated to allow users to continue using ${branding} Catalog operations. The *Resource URI Policy Plugin* functions in a very similar manner, but permits the `resource-uri` field to be protected separately from the rest of the metacard. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/changing-hostname.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/changing-hostname.adoc index d1f671b1adbc..f1b976dd2fae 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/changing-hostname.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/changing-hostname.adoc @@ -10,6 +10,6 @@ By default, the STS server, STS client and the rest of the services use the system property `org.codice.ddf.system.hostname` which is defaulted to 'localhost' and not to the fully qualified domain name of the ${branding} instance. Assuming the ${branding} instance is providing these services, the configuration must be updated to use the *fully qualified domain name* as the service provider. -If the ${branding} is being accessed from behind a proxy or load balancer, set the system property `org.codice.ddf.external.hostname` to the hostname users will be using to access the ${branding}. +If the ${branding} is being accessed from behind a proxy or load balancer, set the system property `org.codice.ddf.external.hostname` to the hostname users use to access the ${branding}. This can be changed during <<{managing-prefix}completing_installation_from_the_admin_console,Initial Configuration>> or later by editing the `${home_directory}/etc/custom.system.properties` file. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuration-files.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuration-files.adoc index 541aabf85383..87b0cd4e60a9 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuration-files.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuration-files.adoc @@ -23,7 +23,7 @@ A template file is provided for some configurable ${branding} items so that they [WARNING] ==== -If the ${admin-console} is enabled again, all of the configuration done via `.config` files will be loaded and displayed. +If the ${admin-console} is enabled again, all of the configuration done via `.config` files is loaded and displayed. However, note that the name of the `.config` file is not used in the ${admin-console}. Rather, a universally unique identifier (UUID) is added when the ${branding} item was created and displays this UUID in the console (for example, `OpenSearchSource.112f298e-26a5-4094-befc-79728f216b9b`) ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-access-plugins.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-access-plugins.adoc index 1199c1298d69..7ef3b3ddc65c 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-access-plugins.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-access-plugins.adoc @@ -23,7 +23,7 @@ To configure the Security Audit Plugin: . Select *Configuration* tab. . Select *Security Audit Plugin*. -Add the desired metacard attributes that will be audited when modified. +Add the desired metacard attributes that are audited when modified. See <<{reference-prefix}org.codice.ddf.catalog.plugin.security.audit.SecurityAuditPlugin,Security Audit Plugin configurations>> for all possible configurations. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-data-policy-plugins.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-data-policy-plugins.adoc index 9d84f6b16276..0a5e49271197 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-data-policy-plugins.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-data-policy-plugins.adoc @@ -38,15 +38,15 @@ See <<{reference-prefix}org.codice.ddf.catalog.security.policy.metacard.Metacard === Configuring the Metacard Validation Marker Plugin (((Metacard Validation Marker Plugin))) -By default, the Metacard Validation Marker Plugin will mark metacards with validation errors and warnings as they are reported by each metacard validator and then allow the ingest. +By default, the Metacard Validation Marker Plugin marks metacards with validation errors and warnings as they are reported by each metacard validator and then allows the ingest. To prevent the ingest of certain invalid metacards, the `Metacard Validity Marker` plugin can be configured to "enforce" one or more validators. -Metacards that are invalid according to an "enforced" validator will not be ingested. +Metacards that are invalid according to an "enforced" validator are not ingested. . Navigate to the *${admin-console}*. . Select the *${ddf-catalog}* application. . Select the *Configuration* tab. . Select the *Metacard Validity Marker Plugin*. -.. If desired, enter the ID of any metacard validator to enforce. This will prevent ingest of metacards that fail validation. +.. If desired, enter the ID of any metacard validator to enforce. This prevents ingest of metacards that fail validation. .. If desired, check *Enforce Errors* or *Enforce Warnings*, or both. See <<{reference-prefix}ddf.catalog.metacard.validation.MetacardValidityMarkerPlugin,Metacard Validity Marker Plugin configurations>> for all possible configurations. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-fanout-proxy.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-fanout-proxy.adoc index 4f50336dd269..e49eef5ae063 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-fanout-proxy.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-fanout-proxy.adoc @@ -19,6 +19,6 @@ All queries are enterprise queries and no catalog provider needs to be configure . Save changes. ${branding} is now operating as a fanout proxy. -Only queries and resource retrieval requests will be allowed. -All queries will be federated. -Create, update, and delete requests will not be allowed, even if a Catalog Provider was configured prior to the reconfiguration as a fanout. +Only queries and resource retrieval requests are allowed. +All queries are federated. +Create, update, and delete requests are not allowed, even if a Catalog Provider was configured prior to the reconfiguration as a fanout. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-guest-access.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-guest-access.adoc index 36f771d02a7d..7cfea50c0554 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-guest-access.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-guest-access.adoc @@ -14,13 +14,13 @@ By default, ${branding} allows guest access. Because ${branding} does not know the identity of a Guest user, it cannot assign security attributes to the Guest. The administrator must configure the attributes and values (the "claims") to be assigned to Guests. The Guest Claims become the default minimum attributes for every user, both authenticated and unauthenticated. -Even if a user claim is more restrictive, the guest claim will grant access, so ensure the guest claim is only as permissive as necessary. +Even if a user claim is more restrictive, the guest claim grants access, so ensure the guest claim is only as permissive as necessary. The *Guest* user is uniquely identified with a Principal name of the format `Guest@UID`. The unique identifier is assigned to a Guest based on its source IP address and is cached so that subsequent -Guest accesses from the same IP address within a 30-minute window will get the same unique identifier. +Guest accesses from the same IP address within a 30-minute window get the same unique identifier. To support administrators' need to track the source IP Address for a given Guest user, the IP Address -and unique identifier mapping will be audited in the security log. +and unique identifier mapping are audited in the security log. * Make sure that all the default logical names for locations of the security services are defined. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-kml-endpoint.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-kml-endpoint.adoc index eabcd46dc734..43f555a57e97 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-kml-endpoint.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-kml-endpoint.adoc @@ -9,17 +9,17 @@ ((Keyhole Markup Language)) (_KML_)(((KML))) is an XML notation for describing geographic annotation and visualization for 2- and 3- dimensional maps. -(((KML Network Link endpoint)))The root network link will create a network link for each configured source, including the local catalog. -The individual source network links will perform a query against the OpenSearch Endpoint periodically based on the current view in the KML client. +(((KML Network Link endpoint)))The root network link creates a network link for each configured source, including the local catalog. +The individual source network links perform a query against the OpenSearch Endpoint periodically based on the current view in the KML client. The query parameters for this query are obtained by a bounding box generated by Google Earth. -The root network link will refresh every 12 hours or can be forced to refresh. -As a user changes their current view, the query will be re-executed with the bounding box of the new view. +The root network link refreshes every 12 hours or can be forced to refresh. +As a user changes their current view, the query is re-executed with the bounding box of the new view. (This query gets re-executed two seconds after the user stops moving the view.) This KML Network Link endpoint has the ability to serve up custom KML style documents and Icons to be used within that document. The KML style document must be a valid XML document containing a KML style. The KML Icons should be placed in a single level directory and must be an image type (png, jpg, tif, etc.). -The Description will be displayed as a pop-up from the root network link on Google Earth. +The Description is displayed as a pop-up from the root network link on Google Earth. This may contain the general purpose of the network and URLs to external resources. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-oidc.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-oidc.adoc index 845f2442e6e9..7bc303d20e93 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-oidc.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-oidc.adoc @@ -32,8 +32,8 @@ Once connected, the Web Context Policy Manager needs to be updated. to do so, === OAuth 2.0 OAuth 2.0 is an authorization protocol and ${branding} can use it when federating. -When a user queries a source that is configured to use this protocol, ${branding} will forward the user's information (access token) with the request. -If a source can be configured to use OAuth 2.0, `OAuth 2.0` will appear as an option under `Authentication Type` in the source's configuration. +When a user queries a source that is configured to use this protocol, ${branding} forwards the user's information (access token) with the request. +If a source can be configured to use OAuth 2.0, `OAuth 2.0` appears as an option under `Authentication Type` in the source's configuration. To configure a source to use OAuth 2.0, under the source's configuration, diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/connecting-to-external-idp.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/connecting-to-external-idp.adoc index d2e899e30e67..e15fc54e6f3d 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/connecting-to-external-idp.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/connecting-to-external-idp.adoc @@ -21,7 +21,7 @@ The SP metadata can found at `https://:/services/saml/sso/metadata`. [NOTE] ==== -The certificate that the external IdP uses for signing will need to be added to the ${branding}'s keystore. See <<{managing-prefix}updating_key_store_trust_store_via_the_admin_console,Updating Key Store / Trust Store via the Admin Console>> for details. +The certificate that the external IdP uses for signing needs to be added to the ${branding}'s keystore. See <<{managing-prefix}updating_key_store_trust_store_via_the_admin_console,Updating Key Store / Trust Store via the Admin Console>> for details. ==== [NOTE] diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/content-directory-monitor.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/content-directory-monitor.adoc index faac9a659180..a0a1b27d1147 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/content-directory-monitor.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/content-directory-monitor.adoc @@ -8,7 +8,7 @@ == {title} ((({title}))) -The Content Directory Monitor (CDM) provides the capability to easily add content and metacards into the ${ddf-catalog} by placing a file in a directory. +The Content Directory Monitor (CDM) provides the capability to easily add content and metacards into the ${ddf-catalog} by placing a file in a directory. === Installing the Content Directory Monitor @@ -38,9 +38,9 @@ After adding permissions, a system restart is required for them to take effect. . permission java.io.FilePermission "${/}-", "read, write"; ---- -Trailing slashes after have no effect on the permissions granted. For example, adding a permission for "${/}test${/}path" and "${/}test${/}path${/}" are equivalent. The recursive forms "${/}test${/}path${/}-", and "${/}test${/}path${/}${/}-" are also equivalent. +Trailing slashes after `` have no effect on the permissions granted. For example, adding a permission for `"${/}test${/}path"` and `"${/}test${/}path${/}"` are equivalent. The recursive forms `"${/}test${/}path${/}-"`, and `"${/}test${/}path${/}${/}-"` are also equivalent. -Line 1 gives the CDM the permissions to read from the monitored directory path. Line 2 gives the CDM the permissions to recursively read and write from the monitored directory path, specified by the directory path's suffix "${/}-". +Line 1 gives the CDM the permissions to read from the monitored directory path. Line 2 gives the CDM the permissions to recursively read and write from the monitored directory path, specified by the directory path's suffix `"${/}-"`. If a CDM configuration is deleted, then the corresponding permissions that were added should be deleted to avoid granting unnecessary permissions to parts of the system. @@ -92,7 +92,7 @@ Regardless of the option, the ${branding} takes each file in a monitored directo * *Erases* the original file from the monitored directory. .Move -* Copies the file into the directory `.\ingested` *(this will double the disk space used)* +* Copies the file into the directory `.\ingested` *(this doubles the disk space used)* * Copies the file into the Content Repository. * Creates a metacard in the Catalog from the file. * *Erases* the original file from the monitored directory. @@ -110,12 +110,9 @@ This is configured by setting the number of *Maximum Concurrent Files* in the co A maximum of 8 is imposed to protect system resources. .Read Lock -When the CDM is set up, the directory specified is continuously scanned, and files are locked for processing based on the *ReadLock Time Interval*. -This does not apply to the *Monitor in place* processing directive. -Files will not be ingested without having a ReadLock that has observed no change in the file size. -This is done so that files that are in transit will not be ingested prematurely. The interval should be dependent on the speed of the copy to the directory monitor (ex. network drive vs local disk). -For local files, the default value of 500 milliseconds is recommended. The recommended interval for network drives is 1000 - 2000 milliseconds. -If the value provided is less than 100, 100 milliseconds will be used. +When the CDM is set up, the directory specified is continuously scanned, and files are locked for processing based on the *ReadLock Time Interval*. This does not apply to the *Monitor in place* processing directive. Files are not ingested without having a ReadLock that has observed no change in the file size. +This is done so that files that are in transit are not ingested prematurely. The interval should be dependent on the speed of the copy to the directory monitor (ex. network drive vs local disk). +For local files, the default value of 500 milliseconds is recommended. The recommended interval for network drives is 1000 - 2000 milliseconds. If the value provided is less than 100, 100 milliseconds is used. It is also recommended that the *ReadLock Time Interval* be set to a lower amount of time when the *Maximum Concurrent Files* is set above 1 so that files are locked in a timely manner and processed as soon as possible. When a higher *ReadLock Time Interval* is set, the time it takes for files to be processed is increased. @@ -137,20 +134,20 @@ To set multi-valued attributes, use a separate override for each value. For exam `*topic.keyword=PPI*` + `*topic.keyword=radiology*` -Attributes will only be overridden if they are part of the <<{integrating-prefix}metacard_type, metacard type>> or are <<{developing-prefix}attribute_injection_definition,injected>>. +Attributes are only overridden if they are part of the <<{integrating-prefix}metacard_type, metacard type>> or are <<{developing-prefix}attribute_injection_definition,injected>>. All attributes in the <<{metadata-prefix}catalog_taxonomy_definitions, catalog taxonomy tables>> are injected into all metacards by default and can be overridden. [IMPORTANT] ==== -If an overridden attribute is not part of the <<{integrating-prefix}metacard_type, metacard type>> or <<{developing-prefix}attribute_injection_definition,injected>> the attribute will not be added to the metacard. +If an overridden attribute is not part of the <<{integrating-prefix}metacard_type, metacard type>> or <<{developing-prefix}attribute_injection_definition,injected>> the attribute is not added to the metacard. ==== For example, if the metacard type contains contact email, `*contact.point-of-contact-email*` -but the value is not currently set, adding an attribute override will set the attribute value. +but the value is not currently set, adding an attribute override sets the attribute value. To override attributes that are not part of the metacard type, <<{developing-prefix}attribute_injection_definition,attribute injection>> can be used. .Blacklist @@ -162,15 +159,15 @@ One such example of this is "thumbs.db" in Windows. This file type and any temporary files are included in the blacklist. .Errors -If the CDM fails to read the file, an error will be logged in the CDM log. If the directory monitor is +If the CDM fails to read the file, an error is logged in the CDM log. If the directory monitor is configured to *Delete* or *Move*, the original file is also moved to the `\.errors` directory. .Logging -CDM will send logs detailing the processing of files in the directory to `cdm.log`. +CDM sends log entries detailing the processing of files in the directory to `cdm.log`. [TIP] ==== -The log level for CDM can be set with the following console command. At the DEBUG level, CDM will periodically log the list of files still currently processing. +The log level for CDM can be set with the following console command. At the DEBUG level, CDM periodically logs the list of files still currently processing. ---- log:set DEBUG cdmLogger ---- diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/decanter-services.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/decanter-services.adoc index 9f054740435b..b3d87cb5c8ff 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/decanter-services.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/decanter-services.adoc @@ -14,7 +14,7 @@ Further information on Karaf Decanter services and configurations can be found h === Configuring Decanter Service Level Agreement (SLA) Checker The Decanter SLA Checker provides a way to create alerts based on configurable conditions in events posted to `decanter/collect/*` and can be configured by editing the file `${home_directory}/etc/org.apache.karaf.decanter.sla.checker.cfg`. -By default there are only two checks that will produce alerts, and they are based on the `SystemNotice` event property of `priority`. +By default there are only two checks that produce alerts, and they are based on the `SystemNotice` event property of `priority`. .Decanter SLA Configuration |=== diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/enabling-ssl.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/enabling-ssl.adoc index bcefe20ed3c8..a4aac8f7bec3 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/enabling-ssl.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/enabling-ssl.adoc @@ -7,7 +7,7 @@ == {title} (((SSL))) -In order for outbound secure connections (HTTPS) to be made from components like Federated Sources and Resource Readers configuration may need to be updated with keystores and security properties. +In order for outbound secure connections (HTTPS) to be made from components like Federated Sources and Resource Readers, configuration may need to be updated with keystores and security properties. These values are configured in the `${home_directory}/etc/custom.system.properties` file. The following values can be set: @@ -21,7 +21,7 @@ The following values can be set: |`javax.net.ssl.trustStore` |`etc/keystores/serverTruststore.jks` |The java keystore that contains the trusted public certificates for Certificate Authorities (CAs) that can be used to validate SSL Connections for outbound TLS/SSL connections (such as HTTPS). -When making outbound secure connections a handshake will be done with the remote secure server and the CA that is in the signing chain for the remote server's certificate must be present in the trust store for the secure connection to be successful. +When making outbound secure connections a handshake is done with the remote secure server and the CA that is in the signing chain for the remote server's certificate must be present in the trust store for the secure connection to be successful. |`javax.net.ssl.trustStorePassword` |`changeit` diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/environment-hardening.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/environment-hardening.adoc index b1b37be6c7fc..eedfac78d116 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/environment-hardening.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/environment-hardening.adoc @@ -67,12 +67,11 @@ SSH can also be authenticated and authorized through an external Realm, such as LDAP. This can be accomplished by editing the `${home_directory}/etc/org.apache.karaf.shell.cfg` file and setting the value for `sshRealm` to the appropriate realm, such as `ldap`. No restart of ${branding} is necessary after this change. -By definition, all connections over SSH will be authenticated and authorized and secure from eavesdropping. +By definition, all connections over SSH are authenticated and authorized and secure from eavesdropping. [WARNING] ==== -Enabling SSH will expose your file system such that any user with access to your ${branding} shell will -have read/write/execute access to all directories and files accessible to your installation user. +Enabling SSH exposes your file system because any user with access to your ${branding} shell has read/write/execute access to all directories and files accessible to your installation user. *Because of this, SSH is not recommended in a secure environment and should be turned off in a fully hardened system.* @@ -91,7 +90,7 @@ Setting this configuration may break compatibility to legacy systems that do not [WARNING] ==== -Setting this configuration will require a certificate to be installed in the browser. +Setting this configuration requires a certificate to be installed in the browser. ==== |Session Inactivity Timeout diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/filter-policy-plugins.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/filter-policy-plugins.adoc index e472e159086a..a78adf1fb541 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/filter-policy-plugins.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/filter-policy-plugins.adoc @@ -9,4 +9,4 @@ Several ((Policy Plugins)) for catalog filtering exist currently, <<{developing-prefix}metacard_attribute_security_policy_plugin,Metacard Attribute Security Policy Plugin>> and <<{developing-prefix}xml_attribute_security_policy_plugin,XML Attribute Security Policy Plugin>>. These Policy Plugin implementations allow an administrator to easily add filtering capabilities to some standard Metacard types for all ${ddf-catalog} operations. -These plugins will place policy information on the Metacard itself that allows the <<{developing-prefix}filter_plugin,Filter Plugin>> to restrict unauthorized users from viewing content they are not allowed to view. +These plugins place policy information on the Metacard itself that allows the <<{developing-prefix}filter_plugin,Filter Plugin>> to restrict unauthorized users from viewing content they are not allowed to view. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/global-settings.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/global-settings.adoc index 513bbdc08332..f8d5c8ba0e5d 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/global-settings.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/global-settings.adoc @@ -132,7 +132,7 @@ NOTE: This *DOES* change the port the system runs on. |Internal Root Context |org.codice.ddf.system.rootContext |String -|The base or root context that services will be made available under. +|The base or root context that services are made available under. |/services |Yes @@ -185,7 +185,7 @@ NOTE: Does not change the port the system runs on. |External Root Context |org.codice.ddf.external.context |String -|The base or root context that services will be advertised under. +|The base or root context that services are advertised under. |/services |Yes @@ -266,7 +266,7 @@ TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |Allow Basic Auth Over Http |org.codice.allowBasicAuthOverHttp |Boolean -|Set to true to allow Basic Auth credentials to be sent over HTTP unsecurely. This should only be done in a test environment. These events will be audited. +|Set to true to allow Basic Auth credentials to be sent over HTTP unsecurely. This should only be done in a test environment. These events are audited. |false |Yes @@ -314,9 +314,9 @@ The interval is measured in seconds. |File extensions flagged as potentially dangerous to the host system or external clients |bad.file.extensions |String -|Files uploaded with these bad file extensions will have their file names sanitized before being saved +|Files uploaded with these bad file extensions have their file names sanitized before being saved -For example, `sample_file.exe` will be renamed to `sample_file.bin` upon ingest +For example, `sample_file.exe` is renamed to `sample_file.bin` upon ingest |.exe, .jsp, .html, @@ -393,9 +393,10 @@ For example, `sample_file.exe` will be renamed to `sample_file.bin` upon ingest |File names flagged as potentially dangerous to the host system or external clients |bad.files |String -|Files uploaded with these bad file names will have their file names sanitized before being saved. +|Files uploaded with these bad file names have their file names sanitized before being saved + +For example, `crossdomain.xml` is renamed to `file.bin` upon ingest -For example, `crossdomain.xml` will be renamed to `file.bin` upon ingest |crossdomain.xml, clientaccesspolicy.xml, .htaccess, @@ -414,7 +415,7 @@ robots.txt |Mime types flagged as potentially dangerous to external clients |bad.mime.types |String -|Files uploaded with these mime types will be rejected from the upload +|Files uploaded with these mime types are rejected from the upload |text/html, text/javascript, text/x-javascript, @@ -427,7 +428,7 @@ application/x-msmetafile |File names flagged as potentially dangerous to external clients |ignore.files |String -|Files uploaded with these file names will be rejected from the upload +|Files uploaded with these file names are rejected from the upload |.DS_Store, Thumbs.db |Yes @@ -514,7 +515,7 @@ For example, the url for the local csw service (\${secure_url}/services/csw) cou ${variable-prefix}org.codice.ddf.system.protocol}${variable-prefix}org.codice.ddf.system.hostname}:${variable-prefix}org.codice.ddf.system.port}${variable-prefix}org.codice.ddf.system.rootContext}/csw ---- -This variable version is more verbose, but will not need to be changed if the system `host`, `port` or `root` context changes. +This variable version is more verbose, but does not need to be changed if the system `host`, `port` or `root` context changes. [WARNING] ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/hiding-errors-by-role.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/hiding-errors-by-role.adoc index 663bdedaceeb..3063d75a359a 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/hiding-errors-by-role.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/hiding-errors-by-role.adoc @@ -11,7 +11,7 @@ Prevent certain users from seeing data with certain types of errors or warnings. Typically, this is used for security markings. -If the *Metacard Validation Filter Plugin* is configured to *Filter errors* and/or *Filter warnings*, metacards with errors/warnings will be hidden from users without the specified user attributes. +If the *Metacard Validation Filter Plugin* is configured to *Filter errors* and/or *Filter warnings*, metacards with errors/warnings are hidden from users without the specified user attributes. . Navigate to the *${admin-console}*. . Select the *${ddf-catalog}* application. @@ -25,5 +25,5 @@ If the *Metacard Validation Filter Plugin* is configured to *Filter errors* and/ To harden the system and prevent other ${branding} systems from querying invalid data in the local catalog, it is recommended to create and set user roles that are unique to the local system (ie. a user role that includes a UUID). -. Select *Filter errors* to filter errors. Users without the `invalid-state` attribute will not see metacards with errors. -. Select *Filter warnings* to filter warnings. Users without the `invalid-state` attribute will not see metacards with warnings. +. Select *Filter errors* to filter errors. Users without the `invalid-state` attribute cannot see metacards with errors. +. Select *Filter warnings* to filter warnings. Users without the `invalid-state` attribute cannot see metacards with warnings. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/ldap-server.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/ldap-server.adoc index 6f81ff1dc934..809c21044cb0 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/ldap-server.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/ldap-server.adoc @@ -19,7 +19,7 @@ Then change the LDAP Bind User Password in the <<{reference-prefix}Claims_Handle A claim is an additional piece of data about a principal that can be included in a token along with basic token data. A claims manager provides hooks for a developer to plug in claims handlers to ensure that the STS includes the specified claims in the issued token. -Claims handlers convert incoming user credentials into a set of attribute claims that will be populated in the SAML assertion. +Claims handlers convert incoming user credentials into a set of attribute claims that is populated in the SAML assertion. For example, the `LDAPClaimsHandler` takes in the user's credentials and retrieves the user's attributes from a backend LDAP server. These attributes are then mapped and added to the SAML assertion being created. Integrators and developers can add more claims handlers that can handle other types of external services that store user attributes. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/logout-theming.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/logout-theming.adoc index d0c4289322de..e59bc5174256 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/logout-theming.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/logout-theming.adoc @@ -11,13 +11,13 @@ The logout pages is presented to users through the navigation of ${branding} and has a changeable timeout value. . Navigate to the *${admin-console}*. -. Select *${ddf-security}* Application. +. Select *${ddf-security}* Application. . Select *Configuration* tab. . Select *Logout Page*. The customizable feature of the logout page is the *Logout Page Time Out*. This is the time limit the IDP -client will wait for a user to click log out on the logout page. Any requests that take longer than this -time for the user to submit will be rejected. +client waits for a user to click log out on the logout page. Any requests that take longer than this +time for the user to submit are rejected. . *Default value*: 3600000 (milliseconds) diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/remove-default-users-cont.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/remove-default-users-cont.adoc index d393c626ed57..17486dc57927 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/remove-default-users-cont.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/remove-default-users-cont.adoc @@ -7,7 +7,7 @@ [WARNING] ==== -Once the default users are removed, the `<${branding}_HOME>/bin/client` and `<${branding}_HOME>/bin/client.bat` scripts will not work. +Once the default users are removed, the `<${branding}_HOME>/bin/client` and `<${branding}_HOME>/bin/client.bat` scripts do not work. If SSH access to the Karaf shell is to be supported, edit the file `org.apache.karaf.shell.cfg` in the `/etc` directory, changing the value of the `sshRealm` property from `karaf` to `ldap`. ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/remove-default-users.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/remove-default-users.adoc index ea67ec772f0b..863d9f27a5d5 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/remove-default-users.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/remove-default-users.adoc @@ -11,7 +11,7 @@ * *{hardening-step}* The default security configuration uses a property file located at `${home_directory}/etc/users.properties` to store users and passwords. -A hardened system will remove this file and manage all users externally, via an LDAP server or by other means. +A hardened system removes this file and manage all users externally, via an LDAP server or by other means. .Default Users are an Insecure Default [NOTE] diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/securing-admin-console.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/securing-admin-console.adoc index f1ec60d40a70..bbaccb3248a6 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/securing-admin-console.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/securing-admin-console.adoc @@ -19,7 +19,7 @@ To set access restrictions on the ${admin-console}, consult the organization's s . Select the *${ddf-security}* application. . Select the *Configuration* tab. . Select the *Web Context Policy Manager*. -.. A dialogue will pop up that allows you to edit ${branding} access restrictions. +.. A dialogue allows you to edit ${branding} access restrictions. .. If your infrastructure supports multiple <<{reference-prefix}org.codice.ddf.security.policy.context.impl.PolicyManager,authentication methods>>, you may specify them here. .. Role requirements may be enforced by configuring the <<{reference-prefix}org.codice.ddf.security.policy.context.impl.PolicyManager,required attributes>> for a given context. .. The <<{reference-prefix}org.codice.ddf.security.policy.context.impl.PolicyManager,white listed contexts>> allows child contexts to be excluded from the authentication constraints of their parents. @@ -52,4 +52,4 @@ Organizational requirements should dictate which applications are restricted and + `org.codice.ddf.security.policy.context.impl.PolicyManager="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role=admin"` -If a permission is specified, any user without the required attributes will be unable to see or modify the feature, app, or configuration. +If a permission is specified, any user without the required attributes is unable to see or modify the feature, app, or configuration. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/setting-xacml-policies.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/setting-xacml-policies.adoc index 0d79a7e1bc0d..e698a1235c8d 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/setting-xacml-policies.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/setting-xacml-policies.adoc @@ -8,6 +8,6 @@ == {title} To set up a ((XACML policy)), place the desired XACML policy in the `/etc/pdp/policies` directory and update the included `access-policy.xml` to include the new policy. -This is the directory in which the PDP will look for XACML policies every 60 seconds. +This is the directory in which the PDP looks for XACML policies every 60 seconds. See <<{developing-prefix}developing_xacml_policies,Developing XACML Policies>> for more information about custom XACML policies. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/solr-synonyms.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/solr-synonyms.adoc index ee40cda81b09..7b9c52d296f2 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/solr-synonyms.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/solr-synonyms.adoc @@ -7,9 +7,9 @@ == {title} -When configured, text searches in Solr will utilize synonyms when attempting to match text within the catalog. +When configured, text searches in Solr utilize synonyms when attempting to match text within the catalog. Synonyms are used during keyword/anyText searches as well as when searching on specific text attributes when using the `like` / `contains` operator. -Text searches using the `equality` / `exact match` operator will not utilize synonyms. +Text searches using the `equality` / `exact match` operator do not utilize synonyms. Solr utilizes a `synonyms.txt` file which exists for each Solr core. Synonym matching is most pertinent to metacards which are contained within 2 cores: `catalog` and `metacard_cache`. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/updating-system-users.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/updating-system-users.adoc index 86de457de3c1..cb4bee6eda56 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/updating-system-users.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/updating-system-users.adoc @@ -9,11 +9,11 @@ ((System users)) By default, all system users are located in the `${home_directory}/etc/users.properties` and `${home_directory}/etc/users.attributes` files. -The default users included in these two files are "admin" and "localhost". +The default users included in these two files are `admin` and `localhost`. The `users.properties` file contains username, password, and role information; while the `users.attributes` file is used to mix in additional attributes. The `users.properties` file must also contain the user corresponding to the fully qualified domain name (FQDN) of the system where ${branding} is running. This FQDN user represents this host system internally when making decisions about what operations the system is capable of performing. -For example, when performing a ${branding} Catalog Ingest, the system's attributes will be checked against any security attributes present on the metacard, prior to ingest, to determine whether or not the system should be allowed to ingest that metacard. +For example, when performing a ${branding} Catalog Ingest, the system's attributes are checked against any security attributes present on the metacard, prior to ingest, to determine whether or not the system should be allowed to ingest that metacard. Additionally, the `users.attributes` file can contain user entries in a regex format. This allows an administrator to mix in attributes for external systems that match a particular regex pattern. @@ -36,19 +36,19 @@ The `users.attributes` file uses a JSON format as shown below: } ---- -For this example, the "admin" user will end up with two additional claims of "test" and "test1" with values of "testValue" and [ "testing1", "testing2", "testing3" ] respectively. -Also, any host matching the regex ".*host.*" would end up with the claim "reg" with the single value of "ex". -The "localhost" user would have no additional attributes mixed in. +For this example, the `"admin"` user ends up with two additional claims of `"test"` and `"test1"` with values of `"testValue"` and `[ "testing1", "testing2", "testing3" ]` respectively. +Also, any host matching the regex `".*host.*"` would end up with the claim `"reg"` with the single value of `"ex"`. +The `"localhost"` user would have no additional attributes mixed in. [WARNING] ==== -It is possible for a regex in `users.attributes` to match users as well as a system, so verify that the regex pattern's scope will not be too great when using this feature. +It is possible for a regex in `users.attributes` to match users as well as a system, so verify that the regex pattern's scope is not too great when using this feature. ==== [WARNING] ==== -If your data will contain security markings, and these markings are being parsed out into the metacard security attributes via a PolicyPlugin, then the FQDN user *MUST* be updated with attributes that would grant the privileges to ingest that data. -Failure to update the FQDN user with sufficient attributes will result in an error being returned for any ingest request. +If your data contains security markings, and these markings are being parsed out into the metacard security attributes via a PolicyPlugin, then the FQDN user *MUST* be updated with attributes that would grant the privileges to ingest that data. +Failure to update the FQDN user with sufficient attributes results in an error being returned for any ingest request. ==== [WARNING] @@ -61,5 +61,5 @@ The following attribute values are not allowed: * an array including any of the above * `[]` -Additionally, attribute names should not be repeated, and the order that the attributes are defined and the order of values within an array will be ignored. +Additionally, attribute names should not be repeated, and the order that the attributes are defined and the order of values within an array is ignored. ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/web-context-policy-manager.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/web-context-policy-manager.adoc index 7b5980dc7119..8a51e3cc31a7 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/web-context-policy-manager.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/web-context-policy-manager.adoc @@ -18,8 +18,8 @@ See <<{reference-prefix}org.codice.ddf.security.policy.context.impl.PolicyManage === Guest Access ((Guest access)) is a toggleable configuration. -Enabling guest access will cause all users to be assigned a guest principal for use throughout the entire system. -The guest principal will be used either by itself or along with any other principals acquired from configured authentication types. +Enabling guest access causes all users to be assigned a guest principal for use throughout the entire system. +The guest principal is used either by itself or along with any other principals acquired from configured authentication types. === Session Storage Enabling session storage allows the system to persist the user login through the use of cookies. @@ -52,7 +52,7 @@ The `web-context-policy-config.properties` file format is: [WARNING] ==== If the file-based configuration is used, the *authentication type* configuration for web pages and endpoints in the ${admin-console} is ignored. -All other configurations in the Web Context Policy Manager such as Guest Access, Required Attributes, and White Listed Contexts will *not* be ignored. +All other configurations in the Web Context Policy Manager such as Guest Access, Required Attributes, and White Listed Contexts are *not* ignored. ==== .Default Types of Authentication @@ -78,11 +78,11 @@ All other configurations in the Web Context Policy Manager such as Guest Access, ==== Terminating and Non-Terminating Authentication Types Terminating authentication types are authentication types where, once hit, must either allow or forbid access to the system. -No other authentication types will be checked once a terminating authentication type is hit. +No other authentication types are checked once a terminating authentication type is hit. Non-Terminating authentication types are authentication types where, once hit, must first verify that the client supports the authentication type's method of obtaining credentials. If the client supports the non-terminating authentication type's method of obtaining credentials, it either allows or forbids access to the system. -However if the client does not support the non-terminating authentication type's method of obtaining credentials, the system will continue to the next configured authentication type. +However if the client does not support the non-terminating authentication type's method of obtaining credentials, the system continues to the next configured authentication type. `PKI` is the only non-terminating authentication type. `BASIC`, `OIDC`, and `SAML` are terminating authentication types. @@ -94,10 +94,10 @@ The system first checks to see if the client supports the acquisition of SAML cr - If the connecting client is a machine that supports SAML ECP, the system can acquire SAML credentials. - If the connecting client is a machine that does not support SAML ECP, the system cannot acquire SAML credentials. -If the system can acquire SAML credentials from the client, the system will attempt to acquire said credentials and either allow or forbid access. -If the system cannot acquire SAML credentials from the client, the system will forbid access. +If the system can acquire SAML credentials from the client, the system attempts to acquire said credentials and either allow or forbid access. +If the system cannot acquire SAML credentials from the client, the system forbids access. -Otherwise, if ${branding} is protected by the non-terminating `PKI` authorization type and the system cannot acquire PKI certificates from the client, the system will continue to the next configured authentication type. +Otherwise, if ${branding} is protected by the non-terminating `PKI` authorization type and the system cannot acquire PKI certificates from the client, the system continues to the next configured authentication type. === Required Attributes @@ -106,5 +106,5 @@ For example, the default required attribute for the `/admin` context is `role=sy === White Listed Contexts -White listed contexts are trusted contexts which will bypass security. -Any sub-contexts of a white listed context will be white listed as well, unless they are specifically assigned a policy. +White listed contexts are trusted contexts which bypass security. +Any sub-contexts of a white listed context are white listed as well, unless they are specifically assigned a policy. diff --git a/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-by-attribute-injection.adoc b/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-by-attribute-injection.adoc index 9ef5617923fc..13e80253a353 100644 --- a/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-by-attribute-injection.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-by-attribute-injection.adoc @@ -17,7 +17,7 @@ A <<{integrating-prefix}metacard_type,Metacard Type>> indicates the attributes a Attribute values can only be set/modified if the attribute exists in the metacard's metacard type. Attributes are initially injected with blank values. -However, if an attempt is made to inject an attribute that already exists, the attribute will retain the original value. +However, if an attempt is made to inject an attribute that already exists, the attribute retains the original value. ==== See <<{metadata-prefix}catalog_taxonomy_definitions,Catalog Taxonomy Definitions>> for a list of attributes injected by default. + diff --git a/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-by-pre-ingest-plugins.adoc b/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-by-pre-ingest-plugins.adoc index aa652f0ca476..98d0a8ab12f8 100644 --- a/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-by-pre-ingest-plugins.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-by-pre-ingest-plugins.adoc @@ -10,5 +10,5 @@ The <<{architecture-prefix}pre_ingest_plugins,Pre-Ingest Plugins>> are responsible for setting attribute fields on metacards before they are stored in the catalog. * The <<{architecture-prefix}expiration_date_pre_ingest_plugin,Expiration Date Pre-Ingest Plugin>> adds or updates expiration dates which can be used later for archiving old data. -* The <<{architecture-prefix}geocoder_plugin,Geocoder Plugin>> is responsible for populating the metacard’s `Location.COUNTRY_CODE` attribute if the metacard has an associated location. If the metacard’s country code is already populated, the plugin will not override it. -* The <<{architecture-prefix}metacard_groomer,Metacard Groomer>> plugin adds/updates IDs and timestamps to the created metacard. \ No newline at end of file +* The <<{architecture-prefix}geocoder_plugin,Geocoder Plugin>> is responsible for populating the metacard’s `Location.COUNTRY_CODE` attribute if the metacard has an associated location. If the metacard’s country code is already populated, the plugin does not override it. +* The <<{architecture-prefix}metacard_groomer,Metacard Groomer>> plugin adds/updates IDs and timestamps to the created metacard. diff --git a/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-on-query.adoc b/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-on-query.adoc index 2c17246dc190..b538815345a7 100644 --- a/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-on-query.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_datamanagement/attributes-added-on-query.adoc @@ -7,4 +7,4 @@ == {title} -Metacards resulting from a query will undergo <<{managing-prefix}attributes_added_by_attribute_injection,Attribute Injection>>, then have their <<{managing-prefix}attributes_added_by_attribute_overrides_query,Attributes Overridden>>. +Metacards resulting from a query undergo <<{managing-prefix}attributes_added_by_attribute_injection,Attribute Injection>>, then have their <<{managing-prefix}attributes_added_by_attribute_overrides_query,Attributes Overridden>>. diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/configure-single-sign-on.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/configure-single-sign-on.adoc index f19be7f249d1..09cc944b4b00 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/configure-single-sign-on.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/configure-single-sign-on.adoc @@ -19,12 +19,12 @@ Configure ${BRANDING}'s internal Identity Provider Server. . *_SP Metadata_*: The metatada of the desired Service Provider to connect to the internal IdP. Can be configured as an HTTPS URL (`https://`), file URL (`file:`), or an XML block (`<md:EntityDescriptor>...</md:EntityDescriptor>`). . *_Require Signed AuthnRequests_*: -Toggle whether or not to require signed `AuthnRequests`. When off, unsigned `AuthnRequests` will be rejected. +Toggle whether or not to require signed `AuthnRequests`. When off, unsigned `AuthnRequests` are rejected. -. *_Limit RelayStates to 80 Bytes_*: Toggle whether or not to restrict the `RelayState` length to 80 bytes. The SAML specification requires a maximum length of 80 bytes. When on, messages with `RelayStates` over 80 bytes will be rejected. Only disable if this length is not enforced by the IdP being connected. +. *_Limit RelayStates to 80 Bytes_*: Toggle whether or not to restrict the `RelayState` length to 80 bytes. The SAML specification requires a maximum length of 80 bytes. When on, messages with `RelayStates` over 80 bytes are rejected. Only disable if this length is not enforced by the IdP being connected. . *_Cookie Expiration Time (minutes)_*: -Sets the cookie expiration time for Single Sign On, which determines how long the internal IdP will cache SAML assertions for later use. This value should match the lifetime of SAML assertions. +Sets the cookie expiration time for Single Sign On, which determines how long the internal IdP caches SAML assertions for later use. This value should match the lifetime of SAML assertions. IdP Client:: Configure handling of incoming requests where SAML authentication is enabled. @@ -33,7 +33,7 @@ Configure handling of incoming requests where SAML authentication is enabled. The metadata of the desired IdP to authenticate with. Can be configured as an HTTPS URL (`https://`), file URL (`file:`), or an XML block (`<md:EntityDescriptor>...</md:EntityDescriptor>`). . *_Perform User-Agent Check_*: -If selected, this will allow clients that do not support ECP and are not browsers to fall back to PKI, BASIC, and potentially GUEST authentication, if enabled. +If selected, this allows clients that do not support ECP and are not browsers to fall back to PKI, BASIC, and potentially GUEST authentication, if enabled. .OIDC Select the IdP type desired and set other options as needed. @@ -42,7 +42,7 @@ OIDC Handler Configuration:: Configurations relating to handling incoming requests where OIDC authentication is enabled. . *_IdP Type_*: -The type of IdP that OIDC will be authenticating with. +The type of IdP to authenticate with OIDC. . *_Client ID_*: Unique ID for the client. This may be provided by the Identity Provider. diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/file-system-access.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/file-system-access.adoc index c1a3a63fa376..8e46f1e603b6 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/file-system-access.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/file-system-access.adoc @@ -10,10 +10,10 @@ Restrict access to sensitive files by ensuring that the only users with access privileges are administrators. Within the `${home_directory}`, a directory is created named ${branding-lowercase}-${project.version}. -This directory will be referred to in the documentation as `${home_directory}`. +This directory is referred to in the documentation as `${home_directory}`. . Do not assume the deployment is from a trusted source; verify its origination. -. Check the available storage space on the system to ensure the deployment will not exceed the available space. +. Check the available storage space on the system to ensure the deployment does not exceed the available space. . Set maximum storage space on the `${home_directory}/deploy` and `${home_directory}/system` directories to restrict the amount of space used by deployments. === Setting Directory Permissions diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/finish-page.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/finish-page.adoc index fdc5eea81e9f..72873fc3496f 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/finish-page.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/finish-page.adoc @@ -7,11 +7,11 @@ .Finished Page **** -Upon successful startup, the *Finish* page will redirect to the ${admin-console} to begin further configuration, ingest, or federation. +Upon successful startup, the *Finish* page redirects to the ${admin-console} to begin further configuration, ingest, or federation. [NOTE] ==== -The redirect will only work if the certificates are configured in the browser. + +The redirect only works if the certificates are configured in the browser. + Otherwise the redirect link must be used. ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/firewall-config.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/firewall-config.adoc index 830c84906bf3..50f7a9f7ebe5 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/firewall-config.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/firewall-config.adoc @@ -9,7 +9,7 @@ (((Firewall Port Configuration))) Below is a table listing all of the default ports that ${branding} uses and a description of what they are used for. -Firewalls will need to be configured to open these ports in order for external systems to communicate with ${branding}. +Firewalls need to be configured to open these ports in order for external systems to communicate with ${branding}. .Port List [cols="1a,7a" options="header"] diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/high-availability-initial-setup-exceptions.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/high-availability-initial-setup-exceptions.adoc index d0ca7924fd78..a6fdb656034e 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/high-availability-initial-setup-exceptions.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/high-availability-initial-setup-exceptions.adoc @@ -15,7 +15,7 @@ These steps are handled differently for the initial setup of a Highly Available In order to integrate with a failover proxy, the ${branding} node's system properties (in `${home_directory}/etc/custom.system.properties`) must be changed to publish the correct port to external systems and users. This must be done before installing the first ${branding} node. See <<{managing-prefix}high_availability_initial_setup, High Availability Initial Setup>>. -There are two internal port properties that must be changed to whatever ports the ${branding} will use on its system. +There are two internal port properties that must be changed to whatever ports the ${branding} uses on its system. Then there are two external port properties that must be changed to whatever ports the failover proxy is forwarding traffic through. [WARNING] @@ -25,7 +25,7 @@ There may be unexpected behavior otherwise. ==== In the below example, the failover proxy with a hostname of service.org is forwarding https traffic via 8993 and http traffic via 8181. -The ${branding} node will run on 1111 for https and 2222 for http (on the host that it's hosted on). +The ${branding} node runs on 1111 for https and 2222 for http (on the host that it's hosted on). The hostname of the ${branding} must match the hostname of the proxy. [source] ---- @@ -47,7 +47,7 @@ On Windows, this means they must be under the same drive. === Highly Available Security Auditing -A third party tool will have to be used to persist the logs in a highly available manner. +A third party tool must be used to persist the logs in a highly available manner. * Edit the `${home_directory}/etc/org.ops4j.pax.logging.cfg` file to enable log4j2, following the steps in <<{managing-prefix}enabling_fallback_audit_logging, Enabling Fallback Audit Logging>>. * Then put the appropriate log4j2 appender in `${home_directory}/etc/log4j2.xml` to send logs to the chosen third party tool. @@ -71,7 +71,7 @@ This certificate, and any subsequent certificates signed by the Demo CA, are int and should not be used in production. ==== -Certificates need to have Subject Alternative Names (SANs) which will include the host for the failover +Certificates need to have Subject Alternative Names (SANs) which include the host for the failover proxy and for both ${branding} nodes. A certificate with SANs signed by the Demo CA can be obtained by navigating to `${home_directory}/etc/certs/` and, assuming the proxy's hostname is service.org, running the following for UNIX operating systems: @@ -90,7 +90,7 @@ CertNew -cn service.org -san "DNS:service.org" [NOTE] ==== -Systems that use DDF version 2.11.4 or later will automatically get a DNS SAN entry matching the CN +Systems that use DDF version 2.11.4 or later automatically get a DNS SAN entry matching the CN without the need to specify the `-san` argument to the `CertNew` command. ==== @@ -100,5 +100,5 @@ More customization for certs can be achieved by following the steps at === High Availability Installation Profile Instead of having to manually turn features on and off, there is a High Availability installation profile. -This profile will not show up in the UI Installer, but can be installed by executing `profile:install ha` on the command line *instead* of stepping through the UI Installer. -This profile will install all of the High Availability supported features. +This profile does not show up in the UI Installer, but can be installed by executing `profile:install ha` on the command line *instead* of stepping through the UI Installer. +This profile installs all of the High Availability supported features. diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/initial-startup.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/initial-startup.adoc index a98e6f14befd..d46ac93d7923 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/initial-startup.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/initial-startup.adoc @@ -87,7 +87,7 @@ During ${branding} installation, the major directories and files shown in the ta |Log file that records user interactions with the system for auditing purposes. |`deploy` -|Hot-deploy directory – KARs and bundles added to this directory will be hot-deployed (Empty upon ${branding} installation) +|Hot-deploy directory – KARs and bundles added to this directory are hot-deployed (Empty upon ${branding} installation) |`documentation` |HTML and PDF copies of ${branding} documentation. diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/install-prereqs.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/install-prereqs.adoc index a69d049589df..4a2865755985 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/install-prereqs.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/install-prereqs.adoc @@ -9,7 +9,7 @@ [WARNING] ==== -For security reasons, ${branding} cannot be started from a user's home directory. If attempted, the system will automatically shut down. +For security reasons, ${branding} cannot be started from a user's home directory. If attempted, the system automatically shuts down. ==== These are the system/environment requirements to configure _prior_ to an installation. diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/install-with-zip.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/install-with-zip.adoc index cd4bb4a094da..5eb78fe1f986 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/install-with-zip.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/install-with-zip.adoc @@ -17,7 +17,7 @@ To install the ${branding} distribution zip, perform the following: . Download the ${branding} {download-url}[zip file] {external-link}. . After the <<{managing-prefix}installation_prerequisites,prerequisites>> have been met, change the current directory to the desired install directory, creating a new directory if desired. -This will be referred to as `${home_directory}`. +This is referred to as `${home_directory}`. + .Windows Pathname Warning [WARNING] @@ -100,5 +100,5 @@ Instead, use the java jar command line utility to unzip the distribution (see ex ---- The unzipping process may take time to complete. -The command prompt will stop responding to input during this time. +The command prompt stops responding to input during this time. ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/installing-from-the-command-line.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/installing-from-the-command-line.adoc index 446fd19088fe..bb7c66f7a9bd 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/installing-from-the-command-line.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/installing-from-the-command-line.adoc @@ -25,5 +25,5 @@ The certificates must be set up manually as described in <<{managing-prefix}mana [NOTE] ==== -The system will need to be restarted after changing any of these settings. +The system needs to be restarted after changing any of these settings. ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_running/catalog-commands.adoc b/distribution/docs/src/main/resources/content/_managing/_running/catalog-commands.adoc index b8f72818c97d..bf4379e2992a 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/catalog-commands.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/catalog-commands.adoc @@ -78,7 +78,8 @@ Provides a list of environment variables. .catalog:dump Options The `catalog:dump` command provides selective export of metacards based on date ranges. The `--created-after` and `--created-before` options allow filtering on the date and time that the metacard was created, while `--modified-after` and `--modified-before` options allow filtering on the date and time that the metacard was last modified (which is the created date if no other modifications were made). -These date ranges are exclusive (that is, if the date and time match exactly, the metacard will not be included). +These date ranges are exclusive (that is, if the date and time match exactly, the +metacard is not included). [[_date_filtering_options]]The date filtering options (`--created-after`, `--created-before`, `--modified-after`, and `--modified-before`) can be used in any combination, with the export result including only metacards that match all of the provided conditions. If no date filtering options are provided, `created` and `modified` dates are ignored, so that all metacards match. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/command-scheduler.adoc b/distribution/docs/src/main/resources/content/_managing/_running/command-scheduler.adoc index 51198bce3bce..d748d5c4a561 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/command-scheduler.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/command-scheduler.adoc @@ -15,11 +15,11 @@ Writing these types of scripts are specific to the administrator's operating sys The administrator can also create a Command Schedule, which currently requires only two fields. The Command Scheduler only runs when the container is running, so there is no need to verify if the container is up. In addition, when the container is restarted, the commands are rescheduled and executed again. -A command will be repeatedly executed indefinitely according to the configured interval until the container is shutdown or the Scheduled Command is deleted. +A command is repeatedly executed indefinitely according to the configured interval until the container is shutdown or the Scheduled Command is deleted. [NOTE] ==== -There will be further attempts to execute the command according to the configured interval even if an attempt fails. +Further attempts are made to execute the command according to the configured interval even if an attempt fails. See the log for details about failures. ==== @@ -31,14 +31,14 @@ Configure the Command Scheduler to execute a command at specific intervals. . Select the *${ddf-platform}* application. . Click on the *Configuration* tab. . Select *Platform Command Scheduler*. -. Enter the command or commands to be executed in the *Command* text field. Commands can be separated by a semicolon and will execute in order from left to right. +. Enter the command or commands to be executed in the *Command* text field. Commands can be separated by a semicolon and execute in order from left to right. . Enter an interval in the *Interval* field. This can either be a Quartz Cron expression or a positive integer (seconds) (e.x. `0 0 0 1/1 * ? *` or `12`). . Select the interval type in the *Interval Type* drop-down. . Click the *Save changes* button. [NOTE] ==== -Scheduling commands will be delayed by 1 minute to allow time for bundles to load when ${branding} is starting up. +Scheduling commands are delayed by 1 minute to allow time for bundles to load when ${branding} is starting up. ==== === Updating a Scheduled Command @@ -55,7 +55,7 @@ Scheduled commands have the following syntax: `${ddf-branding-lowercase}.platfor === Output of Scheduled Commands -Commands that normally write out to the console will write out to the log. +Commands that normally write out to the console write out to the log. For example, if an `echo "Hello World"` command is set to run every five seconds, the log contains the following: .Sample Command Output in the Log diff --git a/distribution/docs/src/main/resources/content/_managing/_running/console-commands.adoc b/distribution/docs/src/main/resources/content/_managing/_running/console-commands.adoc index 7ee058ca1efc..5d9f6c66ecc7 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/console-commands.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/console-commands.adoc @@ -7,7 +7,7 @@ == {title} ((({title}))) -Once the distribution has started, administrators will have access to a powerful command line console, the ${command-console}. +Once the distribution has started, administrators have access to a powerful command line console, the ${command-console}. This ${command-console} can be used to manage services, install new features, and manage the state of the system. The ${command-console} is available to the user when the distribution is started manually or may also be accessed by using the `bin/client.bat` or `bin/client` scripts. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/ddf-service.adoc b/distribution/docs/src/main/resources/content/_managing/_running/ddf-service.adoc index 796e76cb4234..03e49710028a 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/ddf-service.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/ddf-service.adoc @@ -11,7 +11,7 @@ === Running as a Service with Automatic Start on System Boot Because ${branding} is built on top of Apache Karaf, ${branding} can use the Karaf Wrapper to run ${branding} as a service and enable automatic startup and shutdown. -When ${branding} is started using Karaf Wrapper, new `wrapper.log` and `wrapper.log.n` (where n goes from 1 to 5 by default) log files will be generated to include wrapper and console specific information. +When ${branding} is started using Karaf Wrapper, new `wrapper.log` and `wrapper.log.n` (where n goes from 1 to 5 by default) log files are generated to include wrapper and console specific information. [WARNING] ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_running/directory-monitor-ingest.adoc b/distribution/docs/src/main/resources/content/_managing/_running/directory-monitor-ingest.adoc index d92f49d50da2..84ea7e096633 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/directory-monitor-ingest.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/directory-monitor-ingest.adoc @@ -10,8 +10,8 @@ The ${ddf-catalog} application contains a ((Content Directory Monitor)) feature that allows files placed in a single directory to be monitored and ingested automatically. For more information about configuring a directory to be monitored, see <<{managing-prefix}configuring_the_content_directory_monitor,Configuring the Content Directory Monitor>>. -Files placed in the monitored directory will be ingested automatically. -If a file cannot be ingested, they will be moved to an automatically created directory named `.errors`. +Files placed in the monitored directory are ingested automatically. +If a file cannot be ingested, they are moved to an automatically created directory named `.errors`. More information about the ingest operations can be found in the ingest log. The default location of the log is `${home_directory}/data/log/ingest_error.log`. Optionally, ingested files can be automatically moved to a directory called `.ingested`. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/external-ingest.adoc b/distribution/docs/src/main/resources/content/_managing/_running/external-ingest.adoc index ac0f39703fd7..c40d31b3f599 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/external-ingest.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/external-ingest.adoc @@ -25,9 +25,9 @@ Where: + *-X* specifies the type of HTTP operation. For this example, it is necessary to POST (ingest) data to the server. + *-d* specifies the data sent in the POST request. The `${at-symbol}` character is necessary to specify that the data is a file. + -The last parameter is the URL of the server that will receive the data. +The last parameter is the URL of the server receiving the data. -This should return a response similar to the following (the actual catalog ID in the id and Location URL fields will be different): +This should return a response similar to the following (the actual catalog ID in the id and Location URL fields are different): .Sample Response [source,http,linenums] @@ -40,7 +40,7 @@ Location: ${secure_url}/services/catalog/44dc84da101c4f9d9f751e38d9c4d97b Server: Jetty(7.5.4.v20111024) ---- -. Use a web browser to verify a file was successfully ingested. Enter the URL returned in the response's HTTP header in a web browser. For instance in our example, it was `/services/catalog/44dc84da101c4f9d9f751e38d9c4d97b`. The browser will display the catalog entry as XML in the browser. +. Use a web browser to verify a file was successfully ingested. Enter the URL returned in the response's HTTP header in a web browser. For instance in the example, it was `/services/catalog/44dc84da101c4f9d9f751e38d9c4d97b`. The browser displays the catalog entry as XML in the browser. . Verify the catalog entry exists by executing a query via the OpenSearch endpoint. . Enter the following URL in a browser `/services/catalog/query?q=${branding-lowercase}`. A single result, in Atom format, should be returned. @@ -52,4 +52,4 @@ curl -k -X POST -i -H "Content-Type: multipart/mixed" -F parse.resource=@/path/t ---- More information about the ingest operations can be found in the ingest log. -The default location of the log is `${home_directory}/data/log/ingest_error.log`. \ No newline at end of file +The default location of the log is `${home_directory}/data/log/ingest_error.log`. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/forms-commands.adoc b/distribution/docs/src/main/resources/content/_managing/_running/forms-commands.adoc index a734807feaaa..d948ceca4d9b 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/forms-commands.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/forms-commands.adoc @@ -21,13 +21,13 @@ forms:load --formsDirectory "/etc/forms" --forms "forms.json" --results "results ---- Where: + -*-formsDirectory* Specifies the directory in which the forms JSON and XML will reside +*-formsDirectory* Specifies the directory in which the forms JSON and XML reside. -*-results* Specifies the file name of the `results.json` file +*-results* Specifies the file name of the `results.json` file. -*-forms* Specifies the file name of the `forms.json` file +*-forms* Specifies the file name of the `forms.json` file. -It's important to note that `forms:load` will fallback to the system default location for forms, results and the forms directory. The defaults are as follows: +It's important to note that `forms:load` falls back to the system default location for forms, results and the forms directory. The defaults are as follows: ``` formsDirectory: "/etc/forms" forms: "forms.json" @@ -38,7 +38,7 @@ Example search forms and result form data can be found in `${home_directory}/etc Managing Forms -In addition to ingesting new system forms into the system, we provide the capability to manage the forms, view the forms and remove them. +In addition to ingesting new system forms into the system, you have the capability to manage the forms, view the forms and remove them. .Viewing All Forms ---- diff --git a/distribution/docs/src/main/resources/content/_managing/_running/ingest-command.adoc b/distribution/docs/src/main/resources/content/_managing/_running/ingest-command.adoc index 05a31e88686e..aa288c8981ad 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/ingest-command.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/ingest-command.adoc @@ -21,7 +21,7 @@ The syntax for the ingest command is `ingest -t ` Select the `` based on the type of files ingested. -Metadata will be extracted if it exists in a format compatible with the transformer. +Metadata is extracted if it exists in a format compatible with the transformer. The default transformer is the <<{developing-prefix}xml_input_transformer,XML input transformer>>, which supports the metadata schema `catalog:metacard`. To see a list of all transformers currently installed, and the file types supported by each, run the `catalog:transformers` command. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/manual-removal-expired.adoc b/distribution/docs/src/main/resources/content/_managing/_running/manual-removal-expired.adoc index 54149cf2e53f..6781233a94f9 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/manual-removal-expired.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/manual-removal-expired.adoc @@ -30,7 +30,7 @@ The `--expired` option is to remove only expired records. [IMPORTANT] ==== -If the `--expired` option is omitted, then all records will be removed from the Catalog. +If the `--expired` option is omitted, then all records are removed from the Catalog. ==== The Catalog Command is convenient for removing records but it is not guaranteed to be fast or efficient. Additionally, certain configurations for archiving Catalog records can dramatically slow the process. If efficiency and speed are desired, interact directly with the catalog storage provider to delete records. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/monitoring.adoc b/distribution/docs/src/main/resources/content/_managing/_running/monitoring.adoc index 20c07b21d52a..8e9ccd7ef07a 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/monitoring.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/monitoring.adoc @@ -90,7 +90,7 @@ To enable access logs for the current ${branding}, do the following: ---- -Change the location of the logs to the desired location. In the settings above, location will default to data/log (same place where the log is located). +Change the location of the logs to the desired location. In the settings above, location defaults to `data/log` (same place where the log is located). The log is using _National Center for Supercomputing Association Applications (NCSA)_ or Common format (hence the class 'NCSARequestLog'). This is the most popular format for access logs and can be parsed by many web server analytics tools. Here is a sample output: @@ -109,13 +109,13 @@ This is the most popular format for access logs and can be parsed by many web se * Navigate to the *System* tab * Select *Logs* -The ((LogViewer)) displays the most recent 500 log messages by default, but will grow to a maximum of 5000 messages. -To view incoming logs, select the *PAUSED* button to toggle it to *LIVE* mode. Switching this back to *PAUSED* will prevent any new logs from being displayed in the LogViewer. Note that this only affects the logs displayed by the LogViewer and does not affect the underlying log. +The ((LogViewer)) displays the most recent 500 log messages by default, but can grow to a maximum of 5000 messages. +To view incoming logs, select the *PAUSED* button to toggle it to *LIVE* mode. Switching this back to *PAUSED* prevents any new logs from being displayed in the LogViewer. Note that this only affects the logs displayed by the LogViewer and does not affect the underlying log. Log events can be filtered by: * Log level (`ERROR`, `WARNING`, etc). -** The LogViewer will display at the currently configured log level for the Karaf logs. +** The LogViewer displays at the currently configured log level for the Karaf logs. *** See <<{managing-prefix}controlling_log_level, Controlling Log Level>> to change log level. * Log message text. * Bundle generating the message. @@ -123,7 +123,7 @@ Log events can be filtered by: [WARNING] ==== It is not recommended to use the LogViewer if the system logger is set to a low reporting level such as `TRACE`. -The volume of messages logged will exceed the polling rate, and incoming logs may be missed. +The volume of messages logged may exceed the polling rate, and incoming logs may be missed. The actual logs being polled by the LogViewer can still be accessed at `${home_directory}/data/log` ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_running/subscription-commands.adoc b/distribution/docs/src/main/resources/content/_managing/_running/subscription-commands.adoc index 6516baa88464..72f66d660c2b 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/subscription-commands.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/subscription-commands.adoc @@ -29,7 +29,7 @@ The subscriptions commands are installed when the Catalog application is install .subscriptions:list Command Usage Examples Note that no arguments are required for the `subscriptions:list` command. -If no argument is provided, all subscriptions will be listed. +If no argument is provided, all subscriptions are listed. A count of the subscriptions found matching the list command's search phrase (or LDAP filter) is displayed first followed by each subscription's ID. .List All Subscriptions @@ -119,9 +119,9 @@ my.contextual.id.json|http://172.18.14.169:8088/services/json/local/event/notifi .subscriptions:delete Command Usage The arguments for the `subscriptions:delete` command are the same as for the `list` command, except that a search phrase or LDAP filter must be specified. -If one of these is not specified an error will be displayed. -When the `delete` command is executed it will display each subscription ID it is deleting. -If a subscription matches the search phrase but cannot be deleted, a message in red will be displayed with the ID. +If one of these is not specified, an error is displayed. +When the `delete` command is executed, it displays each subscription ID it is deleting. +If a subscription matches the search phrase but cannot be deleted, a message in red is displayed with the ID. After all matching subscriptions are processed, a summary line is displayed indicating how many subscriptions were deleted out of how many matching subscriptions were found. .Delete a Specific Subscription Using Its Exact ID diff --git a/distribution/docs/src/main/resources/content/_managing/_running/troubleshooting.adoc b/distribution/docs/src/main/resources/content/_managing/_running/troubleshooting.adoc index 3a3b9d7ee882..1fac6980f72b 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/troubleshooting.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/troubleshooting.adoc @@ -53,9 +53,9 @@ a|Restart ${branding}. . Start up ${branding}: `./${branding-lowercase}` -|Distribution Will Not Start +|Distribution Does Not Start -${branding} will not start when calling the start script defined during installation. +${branding} does not start when calling the start script defined during installation. |Complete the following procedure. . Verify that Java is correctly installed. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/validator-plugins.adoc b/distribution/docs/src/main/resources/content/_managing/_running/validator-plugins.adoc index 3b0bceed0e73..b145c01de02b 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/validator-plugins.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/validator-plugins.adoc @@ -18,8 +18,8 @@ ingested is valid. Below is a list of the validators run against the data ingest . Select the *System* tab. . Select the *Configuration* tab. . Select *Metacard Validation Marker Plugin*. -.. If *Enforce errors* is checked, these validators below will be run on ingest. -.. If *Enforce errors* is not checked, these validators below will *not* be run on ingest. +.. If *Enforce errors* is checked, these validators below are run on ingest. +.. If *Enforce errors* is not checked, these validators below are *not* run on ingest. ==== === Validators run on ingest diff --git a/distribution/docs/src/main/resources/content/_managing/_securing/auditing.adoc b/distribution/docs/src/main/resources/content/_managing/_securing/auditing.adoc index 6b40f6e82656..80fa5b94f29c 100644 --- a/distribution/docs/src/main/resources/content/_managing/_securing/auditing.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_securing/auditing.adoc @@ -52,10 +52,10 @@ If you want to change the location of your systems security backup log from the * edit `${home_directory}/security/configurations.policy` ** find "Security-Hardening: Backup Log File Permissions" -** below `grant codeBase "file:/pax-logging-log4j2"` add the path to the directory containing the new log file you will create in the next step. +** below `grant codeBase "file:/pax-logging-log4j2"` add the path to the directory containing the new log file created in the next step. * edit `${home_directory}/etc/log4j2.xml` ** find the entry for the `securityBackup` appender. (see example) -** change value of `filename` and prefix of `filePattern` to the name/path of the desired failover security logs +** change value of `filename` and prefix of `filePattern` to the name/path of the desired failover security logs. .`securityBackup` Appender Before [source,xml,linenums] @@ -75,6 +75,6 @@ If you want to change the location of your systems security backup log from the [WARNING] ==== -If the system is unable to write to the `security.log` file on system startup, fallback logging will be unavailable. +If the system is unable to write to the `security.log` file on system startup, fallback logging is unavailable. Verify that the `security.log` file is properly configured and contains logs before configuring a fall back. ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_securing/disallowing-login-wo-certs.adoc b/distribution/docs/src/main/resources/content/_managing/_securing/disallowing-login-wo-certs.adoc index 638d3403a588..9e05cc685b92 100644 --- a/distribution/docs/src/main/resources/content/_managing/_securing/disallowing-login-wo-certs.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_securing/disallowing-login-wo-certs.adoc @@ -14,7 +14,7 @@ ${branding} can be configured to prevent login without a valid PKI certificate. * Select *${ddf-security}*. * Select *Web Context Policy Manager*. * Add a policy for each context requiring restriction. -** For example, just configuring `PKI` as the authentication type for web pages will disallow login without certificates to ${branding}. +** For example, just configuring `PKI` as the authentication type for web pages disallows login without certificates to ${branding}. * Click *Save*. [NOTE] diff --git a/distribution/docs/src/main/resources/content/_managing/_securing/managing-crl.adoc b/distribution/docs/src/main/resources/content/_managing/_securing/managing-crl.adoc index 84138100b192..5e306907d671 100644 --- a/distribution/docs/src/main/resources/content/_managing/_securing/managing-crl.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_securing/managing-crl.adoc @@ -45,7 +45,7 @@ $> openssl ca -gencrl -out crl-tokenissuer-revoked.pem [NOTE] ==== -Enabling CRL revocation or modifying the CRL file will require a restart of ${branding} to apply updates. +Enabling CRL revocation or modifying the CRL file requires a restart of ${branding} to apply updates. ==== . Place the CRL in ${home_directory}/etc/keystores. @@ -56,13 +56,13 @@ Enabling CRL revocation or modifying the CRL file will require a restart of ${br .. `${home_directory}/etc/ws-security/issuer/signature.properties` . (Replace with the file path or URL of the CRL file used in previous step.) -Adding this property will also enable CRL revocation for any context policy implementing PKI authentication. -For example, setting PKI as the authentication type for web pages in the Web Context Policy Manager will disable basic authentication and require a certificate. -If a certificate is not in the CRL, it will be allowed through, otherwise it will get a 401 error. -If no certificate is provided, and guest access is enabled on the web context policy, guest access will be granted. +Adding this property also enables CRL revocation for any context policy implementing PKI authentication. +For example, setting PKI as the authentication type for web pages in the Web Context Policy Manager disables basic authentication and require a certificate. +If a certificate is not in the CRL, it is allowed through. If not, it receives a 401 error. +If no certificate is provided, and guest access is enabled on the web context policy, guest access is granted. This also enables CRL revocation for the STS endpoint. -The STS CRL Interceptor monitors the same `encryption.properties` file and operates in an identical manner to the PKI Authenication's CRL handler. Enabling the CRL via the `encryption.properties` file will also enable it for the STS, and also requires a restart. +The STS CRL Interceptor monitors the same `encryption.properties` file and operates in an identical manner to the PKI Authenication's CRL handler. Enabling the CRL via the `encryption.properties` file also enabless it for the STS, and also requires a restart. If the CRL cannot be placed in ${home_directory}/etc/keystores but can be accessed via an *HTTPS* URL: @@ -73,25 +73,25 @@ If the CRL cannot be placed in ${home_directory}/etc/keystores but can be access . Add the *HTTPS* URL under *CRL URL address* . Check the *Enable CRL via URL* option -A local CRL file will be created and the `encryption.properties` and `signature.properties` files will be set as mentioned above. +A local CRL file is created and the `encryption.properties` and `signature.properties` files are set as mentioned above. ===== Add Revocation to a Web Context -The PKIHandler implements CRL revocation, so any web context that is configured to use PKI authentication will also use CRL revocation if revocation is enabled. +The PKIHandler implements CRL revocation, so any web context that is configured to use PKI authentication also uses CRL revocation if revocation is enabled. . After enabling revocation (see above), open the *Web Context Policy Manager*. . Add or modify the *Authentication Types for Web Pages* and *Authentication Types for Endpoints* configurations to use PKI. . If guest access is also required, check the `Allow Guest Access` box in the policy. -With guest access, a user with a revoked certificate will be given a 401 error, but users without a certificate will be able to access the web context as the guest user. +With guest access, a user with a revoked certificate is given a 401 error, but users without a certificate is able to access the web context as the guest user. The STS CRL interceptor does not need a web context specified. -The CRL interceptor for the STS will become active after specifying the CRL file path, or the URL for the CRL, in the `encryption.properties` file and restarting ${branding}. +The CRL interceptor for the STS becomes active after specifying the CRL file path, or the URL for the CRL, in the `encryption.properties` file and restarting ${branding}. [NOTE] ==== -Disabling or enabling CRL revocation or modifying the CRL file will require a restart of ${branding} to apply updates. -If CRL checking is already enabled, adding a new context via the *Web Context Policy Manager* will not require a restart. +Disabling or enabling CRL revocation or modifying the CRL file requires a restart of ${branding} to apply updates. +If CRL checking is already enabled, adding a new context via the *Web Context Policy Manager* does not require a restart. ==== ===== Adding Revocation to an Endpoint @@ -126,7 +126,7 @@ Add the following property to the `jasws` endpoint in the endpoint's `blueprint. ===== Verifying Revocation -A *Warning* similar to the following will be displayed in the logs of the source and endpoint showing the exception encountered during certificate validation: +A *Warning* similar to the following is displayed in the logs of the source and endpoint showing the exception encountered during certificate validation: [source] ---- @@ -164,6 +164,6 @@ The advantage of using an OCSP Server over a CRL is the fact that a local copy o [NOTE] ==== -If an error occurs while communicating with the OCSP server, an alert will be posted to the ${admin-console}. -Until the error is resolved, certificates will not be verified against the server. +If an error occurs while communicating with the OCSP server, an alert is posted to the ${admin-console}. +Until the error is resolved, certificates are not verified against the server. ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_securing/managing-keystores.adoc b/distribution/docs/src/main/resources/content/_managing/_securing/managing-keystores.adoc index 916601d6206b..fe6ce5defbd1 100644 --- a/distribution/docs/src/main/resources/content/_managing/_securing/managing-keystores.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_securing/managing-keystores.adoc @@ -10,13 +10,13 @@ (((Keystores)))Certificates, and sometimes their associated private keys, are stored in keystore files. ${branding} includes two default keystore files, the server key store and the server trust store. The server keystore holds ${branding}'s certificate and private key. -It will also hold the certificates of other nodes whose signature ${branding} will accept. +It also holds the certificates of other nodes whose signature ${branding} accept. (((Truststore)))The truststore holds the certificates of nodes or other entities that ${branding} needs to trust. [NOTE] ==== Individual certificates of other nodes should be added to the keystore instead of CA certificates. -If a CA's certificate is added, ${branding} will automatically trust any certificate that is signed by that CA. +If a CA's certificate is added, ${branding} automatically trusts any certificate that is signed by that CA. ==== ==== Adding an Existing Server Keystore diff --git a/distribution/docs/src/main/resources/content/_managing/_securing/securing-intro.adoc b/distribution/docs/src/main/resources/content/_managing/_securing/securing-intro.adoc index d322fd206646..e457fa564235 100644 --- a/distribution/docs/src/main/resources/content/_managing/_securing/securing-intro.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_securing/securing-intro.adoc @@ -12,12 +12,12 @@ Security is an important consideration for ${branding}, so it is imperative to u .Securing ${branding} Components [IMPORTANT] ==== -${branding} is enabled with an ((Insecure Defaults Service)) which will warn users/admins if the system is configured with insecure defaults. +${branding} is enabled with an ((Insecure Defaults Service)) which warns users/admins if the system is configured with insecure defaults. A banner is displayed on the admin console notifying "The system is insecure because default configuration values are in use." A detailed view is available of the properties to update. ==== -Security concerns will be highlighted in the configuration sections to follow. +Security concerns are highlighted in the configuration sections to follow. diff --git a/distribution/docs/src/main/resources/content/_managing/managing-intro.adoc b/distribution/docs/src/main/resources/content/_managing/managing-intro.adoc index fb491b84da94..35d22d1eee85 100644 --- a/distribution/docs/src/main/resources/content/_managing/managing-intro.adoc +++ b/distribution/docs/src/main/resources/content/_managing/managing-intro.adoc @@ -3,5 +3,5 @@ :status: published :priority: 1 -Administrators will be installing, maintaining, and supporting existing applications. +Administrators install, maintain, and support existing applications. Use this section to prepare, install, configure, run, and monitor a ${branding}. diff --git a/distribution/docs/src/main/resources/content/_metadataReference/complete-list-file-types.adoc b/distribution/docs/src/main/resources/content/_metadataReference/complete-list-file-types.adoc index e1bc19dd2066..b5631d5ee381 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/complete-list-file-types.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/complete-list-file-types.adoc @@ -13,7 +13,7 @@ If adding or removing items, be sure to add or subtract empty cells at the end o .Supported File Types Using the various input transformers, ${branding} supports ingest of the following MIME types. -While ingest is possible for these files, metadata will be limited unless otherwise noted. +While ingest is possible for these files, metadata is limited unless otherwise noted. .Application File Types [cols="3"] diff --git a/distribution/docs/src/main/resources/content/_metadataReference/security-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/security-attributes-table.adoc index 0bb1acb2253c..070d5b1a3866 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/security-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/security-attributes-table.adoc @@ -19,28 +19,28 @@ |[[security.access-groups]]security.access-groups |Attribute name for storing groups to enforce access -controls upon that will enable a user to read and write a metacard. +controls upon that enable a user to read and write a metacard. |List of Strings |< 1024 characters per entry | |[[security.access-individuals]]security.access-individuals |Attribute name for storing the email addresses of users to -enforce access controls upon that will enable the ability to read and write a metacard. +enforce access controls upon that enable the ability to read and write a metacard. |List of Strings |A valid email address per RFC 5322. -|  +| |[[security.access-individuals-read]]security.access-individuals-read |Attribute name for storing the email addresses of users to enforce access controls upon that can read, but not explicitly write to a metacard. |List of Strings |A valid email address per RFC 5322. -|  +| |[[security.access-groups-read]]security.access-groups-read |Attribute name for storing groups to enforce access -controls upon that will enable a user to read, but not necessarily write to a metacard. +controls upon that enable a user to read, but not necessarily write to a metacard. |List of Strings |< 1024 characters per entry | diff --git a/distribution/docs/src/main/resources/content/_metadataReference/supported-file-formats.adoc b/distribution/docs/src/main/resources/content/_metadataReference/supported-file-formats.adoc index f16538716a2c..0d2ca72f2206 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/supported-file-formats.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/supported-file-formats.adoc @@ -14,7 +14,7 @@ Many of these file types support additional <<_file_format_specific_attributes,f [NOTE] ==== -These attributes will be available in all the specified file formats; however, values will only be present if present in the original document/resource. +These attributes are available in all the specified file formats; however, values are only present if present in the original document/resource. ==== These attributes are supported by any file type ingested into ${branding}: diff --git a/distribution/docs/src/main/resources/content/_quickstart/quickstart-certificates.adoc b/distribution/docs/src/main/resources/content/_quickstart/quickstart-certificates.adoc index 38bbf53ff768..4e43a2322f85 100644 --- a/distribution/docs/src/main/resources/content/_quickstart/quickstart-certificates.adoc +++ b/distribution/docs/src/main/resources/content/_quickstart/quickstart-certificates.adoc @@ -14,12 +14,12 @@ ${branding} comes with a default keystore that contains certificates. This allows the distribution to be unzipped and run immediately. If these certificates are sufficient for testing purposes, proceed to <<{quickstart-prefix}configuring_quick_start,Configuring (Quick Start)>>. -To test federation using 2-way TLS, the default keystore certificates will need to be replaced, using either the included <<{quickstart-prefix}demo_certificate_authority_ca,Demo Certificate Authority>> or by <<{quickstart-prefix}creating_self_signed_certificates,Creating Self-signed Certificates>>. +To test federation using 2-way TLS, the default keystore certificates needs to be replaced, using either the included <<{quickstart-prefix}demo_certificate_authority_ca,Demo Certificate Authority>> or by <<{quickstart-prefix}creating_self_signed_certificates,Creating Self-signed Certificates>>. -If the installer was used to install the ${branding} and a hostname other than "localhost" was given, the user will be prompted to upload new trust/key stores. +If the installer was used to install the ${branding} and a hostname other than "localhost" was given, the user is prompted to upload new trust/key stores. -If the hostname is `localhost` or, if the hostname was changed _after_ installation, the default certificates will not allow access to the ${branding} instance from another machine over HTTPS (now the default for many services). -The Demo Certificate Authority will need to be replaced with certificates that use the fully qualified hostname of the server running the ${branding} instance. +If the hostname is `localhost` or, if the hostname was changed _after_ installation, the default certificates do not allow access to the ${branding} instance from another machine over HTTPS (now the default for many services). +The Demo Certificate Authority needs to be replaced with certificates that use the fully qualified hostname of the server running the ${branding} instance. === Demo Certificate Authority (CA) @@ -45,9 +45,9 @@ For *NIX, use the `CertNew.sh` script. where: -* `` represents a fully qualified common name (such as "", where could be something like cluster.yoyo.com) -* `` represents a distinguished name as a comma-delimited string (such as "c=US, st=California, o=Yoyodyne, l=San Narciso, cn=") -* `` represents optional subject alternative names to be added to the generated certificate (such as "DNS:,DNS:node1.,DNS:node2."). The format for subject alternative names is similar to the OpenSSL X509 configuration format. Supported tags are: +* `` represents a fully qualified common name (such as `""`, where `` could be something like `cluster.yoyo.com`) +* `` represents a distinguished name as a comma-delimited string (such as `"c=US, st=California, o=Yoyodyne, l=San Narciso, cn="`) +* `` represents optional subject alternative names to be added to the generated certificate (such as `"DNS:,DNS:node1.,DNS:node2."`). The format for subject alternative names is similar to the OpenSSL X509 configuration format. Supported tags are: ** `email` - email subject ** `URI` - uniformed resource identifier ** `RID` - registered id @@ -66,9 +66,9 @@ For Windows, use the `CertNew.cmd` script. where: -* `` represents a fully qualified common name (such as"", where could be something like cluster.yoyo.com) -* `` represents a distinguished name as a comma-delimited string (such as "c=US, st=California, o=Yoyodyne, l=San Narciso, cn=") -* `` represents optional subject alternative names to be added to the generated certificate (such as "DNS:,DNS:node1.,DNS:node2."). The format for subject alternative names is similar to the OpenSSL X509 configuration format. Supported tags are: +* `` represents a fully qualified common name (such as `""`, where `` could be something like `cluster.yoyo.com`) +* `` represents a distinguished name as a comma-delimited string (such as `"c=US, st=California, o=Yoyodyne, l=San Narciso, cn="`) +* `` represents optional subject alternative names to be added to the generated certificate (such as `"DNS:,DNS:node1.,DNS:node2."`). The format for subject alternative names is similar to the OpenSSL X509 configuration format. Supported tags are: ** `email` - email subject ** `URI` - uniformed resource identifier ** `RID` - registered id @@ -82,7 +82,7 @@ The `CertNew` scripts: * Create a new entry in the server keystore. * Use the hostname as the fully qualified domain name (FQDN) when creating the certificate. * Adds the specified subject alternative names if any. -* Use the Demo Certificate Authority to sign the certificate so that it will be trusted by the default configuration. +* Use the Demo Certificate Authority to sign the certificate so that it is trusted by the default configuration. To install a certificate signed by a different Certificate Authority, see <<{managing-prefix}managing_keystores,Managing Keystores>>. @@ -95,9 +95,9 @@ If the server's fully qualified domain name is not recognized, the name may need ==== Dealing with Lack of DNS -In some cases DNS may not be available and the system will need to be configured to work with IP addresses. +In some cases DNS may not be available, and the system needs to be configured to work with IP addresses. -Options can be given to the CertNew Scripts to generate certs that will work in this scenario. +Options can be given to the `CertNew` Scripts to generate certs that work in this scenario. .*NIX **** @@ -150,11 +150,11 @@ The following steps demonstrate signing a certificate for the `tokenissuer` user . Sign the certificate by the CA. + `$> openssl ca -out tokenissuer.crt -infiles tokenissuer.req` -These certificates will be used during system configuration to replace the default certificates. +These certificates are used during system configuration to replace the default certificates. === Updating Settings After Changing Certificates -After changing the certificates it will be necessary to update the system user and the `org.codice.ddf.system.hostname` property with the value of either the FQDN or the IP. +After changing the certificates, it is necessary to update the system user and the `org.codice.ddf.system.hostname` property with the value of either the FQDN or the IP. FQDNs should be used wherever possible. In the absence of DNS, however, IP addresses can be used. diff --git a/distribution/docs/src/main/resources/content/_quickstart/quickstart-configuring.adoc b/distribution/docs/src/main/resources/content/_quickstart/quickstart-configuring.adoc index 9049b494327d..6ba642a19cd2 100644 --- a/distribution/docs/src/main/resources/content/_quickstart/quickstart-configuring.adoc +++ b/distribution/docs/src/main/resources/content/_quickstart/quickstart-configuring.adoc @@ -19,9 +19,9 @@ Set the configurations needed to run ${branding}. .. Click start to begin the setup process. .. Configure <<{managing-prefix}guest_interceptor,guest claims attributes>> or use defaults. ... See <<{managing-prefix}configuring_guest_access,Configuring Guest Access>> for more information about the Guest user. -... *All users will be automatically granted these permissions.* -... *Guest users will not be able to ingest data with more restrictive markings than the guest claims.* -... *Any data ingested that has more restrictive markings than these guest claims will not be visible to Guest users.* +... *All users are automatically granted these permissions.* +... *Guest users are not able to ingest data with more restrictive markings than the guest claims.* +... *Any data ingested that has more restrictive markings than these guest claims is not visible to Guest users.* .. Select *Standard Installation*. ... This step may take several minutes to complete. .. On the System Configuration page, configure any port or protocol changes desired and add any keystores/truststores needed. diff --git a/distribution/docs/src/main/resources/content/_quickstart/quickstart-installing.adoc b/distribution/docs/src/main/resources/content/_quickstart/quickstart-installing.adoc index 3ba98265ac65..703aba3efad3 100644 --- a/distribution/docs/src/main/resources/content/_quickstart/quickstart-installing.adoc +++ b/distribution/docs/src/main/resources/content/_quickstart/quickstart-installing.adoc @@ -13,14 +13,14 @@ These are the basic requirements to set up the environment to run a ${branding}. [WARNING] ==== -For security reasons, ${branding} cannot be started from a user's home directory. If attempted, the system will automatically shut down. +For security reasons, ${branding} cannot be started from a user's home directory. If attempted, the system automatically shuts down. ==== === Quick Install Prerequisites (((Quick Install Prerequisites))) .Hardware Requirements (Quick Install) -* At least 4096MB of memory for ${branding}. +* At least 4096 MB of memory for ${branding}. ** This amount can be increased to support memory-intensive applications. See <<{managing-prefix}jvm_memory_configuration, Memory Considerations>>. .Java Requirements (Quick Install) @@ -47,7 +47,7 @@ Prior to installing ${branding}, ensure the system time is accurate to prevent f === Quick Install of ${branding} (((Quick Install of ${branding}))) -WARNING: The ${branding} installation will not succeed unless SolrCloud is running. +WARNING: The ${branding} installation cannot succeed unless SolrCloud is running. See <<_quick_install_of_solrcloud>> for instructions. . Download the ${branding} {download-url}[zip file] {external-link}. @@ -68,14 +68,14 @@ NOTE: If and only if a JDK is installed, the jar command may be used; otherwise, ---- ==== + -. This will create an installation directory, which is typically created with the name and version of the application. -This installation directory will be referred to as `${home_directory}`. +. This creates an installation directory, which is typically created with the name and version of the application. +This installation directory is referred to as `${home_directory}`. (Substitute the actual directory name.) . Edit `${home_directory}/etc/custom.system.properties` and update `solr.cloud.zookeeper=localhost:2181` to `solr.cloud.zookeeper=localhost:9994` . Start ${branding} by running the `${home_directory}/bin/${branding-lowercase}` script (or `${branding-lowercase}.bat` on Windows). . Startup may take a few minutes. .. Optionally, a `system:wait-for-ready` command (aliased to `wfr`) can be used to wait for startup to complete. -. The ${command-console} will display. +. The ${command-console} displays. .${command-console} Prompt ---- @@ -86,7 +86,7 @@ ${branding-lowercase}${at-symbol}local> === Quick Install of ${branding} on a remote headless server (((Quick Install of ${branding} on a remote headless server))) -If ${branding} is being installed on a remote server that has no user interface, the hostname will need to be updated in the configuration files and certificates. +If ${branding} is being installed on a remote server that has no user interface, the hostname must be updated in the configuration files and certificates. [NOTE] ==== @@ -96,7 +96,7 @@ Do not replace _all_ instances of `localhost`, only those specified. .Configuring with a new hostname . Update the ${home_directory}/etc/custom.system.properties file. The entry `org.codice.ddf.system.hostname=localhost` should be updated to `org.codice.ddf.system.hostname=`. . Update the ${home_directory}/etc/users.properties file. Change the `localhost=localhost[...]` entry to =. (Keep the rest of the line as is.) -. Update the ${home_directory}/etc/users.attributes file. Change the "localhost" entry to "". +. Update the ${home_directory}/etc/users.attributes file. Change the `"localhost"` entry to `""`. . From the console go to ${home_directory}/etc/certs and run the appropriate script. .. *NIX: `sh CertNew.sh -cn -san "DNS:"`. .. Windows: `CertNew -cn -san "DNS:"`. @@ -104,8 +104,8 @@ Do not replace _all_ instances of `localhost`, only those specified. .Configuring with an IP address . Update the ${home_directory}/etc/custom.system.properties file. The entry `org.codice.ddf.system.hostname=localhost` should be updated to `org.codice.ddf.system.hostname=`. -. Update the ${home_directory}/etc/users.properties file. Change the `localhost=localhost[...]` entry to =. (Keep the rest of the line as is.) -. Update the ${home_directory}/etc/users.attributes file. Change the "localhost" entry to "". +. Update the ${home_directory}/etc/users.properties file. Change the `localhost=localhost[...]` entry to `=`. (Keep the rest of the line as is.) +. Update the ${home_directory}/etc/users.attributes file. Change the `"localhost"` entry to `""`. . From the console go to ${home_directory}/etc/certs and run the appropriate script. .. *NIX: `sh CertNew.sh -cn -san "IP:"`. .. Windows: `CertNew -cn -san "IP:"`. diff --git a/distribution/docs/src/main/resources/content/_quickstart/quickstart-intro.adoc b/distribution/docs/src/main/resources/content/_quickstart/quickstart-intro.adoc index e3335d661bcf..9f7d906a0b40 100644 --- a/distribution/docs/src/main/resources/content/_quickstart/quickstart-intro.adoc +++ b/distribution/docs/src/main/resources/content/_quickstart/quickstart-intro.adoc @@ -9,7 +9,7 @@ == {title} -(((Quick start guide)))This quick tutorial will enable installation, configuration, and usage of a basic instance of ${branding}. +(((Quick start guide)))This quick tutorial enables installation, configuration, and usage of a basic instance of ${branding}. [NOTE] ==== @@ -17,7 +17,7 @@ This tutorial is intended for setting up a test, demonstration, or trial install For complete installation and configuration steps, see <<{managing-prefix}installing,Installing>>. ==== -These steps will demonstrate: +These steps demonstrate: - [*] <<{quickstart-prefix}quick_install_prerequisites,Prerequisites>>. - [*] <<{quickstart-prefix}quick_install_of_solrcloud,Quick Install of SolrCloud>>. diff --git a/distribution/docs/src/main/resources/content/_reference/_appReferences/mg-spatial.adoc b/distribution/docs/src/main/resources/content/_reference/_appReferences/mg-spatial.adoc index 9d2a9edd7660..a1c3e02eb219 100644 --- a/distribution/docs/src/main/resources/content/_reference/_appReferences/mg-spatial.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_appReferences/mg-spatial.adoc @@ -14,7 +14,7 @@ The ${ddf-spatial} Application provides KML transformer and a KML network link e In the ${ddf-spatial} Application, the `offline-gazetteer` is installed by default. This feature enables you to use an offline source of GeoNames data (as an alternative to the GeoNames Web service enabled by the `webservice-gazetteer` feature) to perform searches via the gazetteer search box in the Search UI. -Installing the `offline-gazetteer-index` feature will provide a small set of GeoNames data to use with the offline gazetteer. The GeoNames data is stored as metacards in the core catalog and are tagged with `geonames` and `gazetteer`. This collection of GeoNames metacards can be expanded or updated by using the `gazetteer:update` command. +Installing the `offline-gazetteer-index` feature provides a small set of GeoNames data to use with the offline gazetteer. The GeoNames data is stored as metacards in the core catalog and are tagged with `geonames` and `gazetteer`. This collection of GeoNames metacards can be expanded or updated by using the `gazetteer:update` command. ==== ${ddf-spatial} Gazetteer Console Commands @@ -31,12 +31,12 @@ The `gazetteer` commands provide the ability to interact with the local GeoNames The resource argument can be one of three types: -* a local file path to a `.txt`, `.zip`, or `.geo.json` GeoNames data file. If a path to a file ends in .geo.json, it will processed as a geoJSON feature collection and imported as supplementary shape data for GeoNames entries. +* a local file path to a `.txt`, `.zip`, or `.geo.json` GeoNames data file. If a path to a file ends in .geo.json, it is processed as a geoJSON feature collection and imported as supplementary shape data for GeoNames entries. * a URL to a `.txt` or `.zip` GeoNames data file. GeoJSON URLs are not supported. * a keyword to automatically process a GeoNames file from from http://download.geonames.org/export/dump. Valid keywords include - ** a country code, which will add the country as GeoNames metacards in the core catalog. The full list of country codes available can be found in http://download.geonames.org/export/dump/countryInfo.txt. - ** `cities1000`, `cities5000`, and `cities15000`, which will add cities to the index that have at least 1000, 5000, or 15000 people, respectively. - ** `all`, which will download all of the current country codes. This process may take some time. + ** a country code, which adds the country as GeoNames metacards in the core catalog. The full list of country codes available can be found in http://download.geonames.org/export/dump/countryInfo.txt. + ** `cities1000`, `cities5000`, and `cities15000`, which adds cities to the index that have at least 1000, 5000, or 15000 people, respectively. + ** `all`, which downloads all of the current country codes. This process may take some time. The `-c` or `--create` flag can be used to clear out the existing gazetteer metacards before adding new entries. @@ -59,27 +59,27 @@ much quicker than for the entire catalog collection. ==== Installing Standalone Solr Offline Gazetteer The Standalone Solr Offline Gazetteer is not installed by default but can be installed by running -`feature:install catalog-solr-offline-gazetteer`. This will install: +`feature:install catalog-solr-offline-gazetteer`. This installs: * The plugin that intercepts gazetteer metacard creates/updates/deletes to the catalog collection (and stores them in the standalone solr gazetteer collection) * The gazetteer query service which registers the Query component that responds to requests from the UI gazetteer search box -* The `offline-solr-gazetteer:removeall` command which will delete all records in the gazetteer +* The `offline-solr-gazetteer:removeall` command which deletes all records in the gazetteer collection. -* The `offline-solr-gazetteer:synccatalog` command which will sync with the catalog and update all +* The `offline-solr-gazetteer:synccatalog` command which syncs with the catalog and updates all records in the gazetteer collection to reflect it (or add them if they are not yet created) ==== Special Note Regarding Installation If the Spatial Geocoding Offline Catalog bundle and the bundle using the Gazetteer query service -(for example, Intrigue) are both already running, you will need to restart the bundles consuming the service +(for example, Intrigue) are both already running, you must restart the bundles consuming the service (for example, Intrigue) in order to pick up the correct one. ==== Building the suggester index on Standalone Solr Offline Gazetteer -The suggester index will be built when any of the other methods of building the catalog gazetteer +The suggester index is built when any of the other methods of building the catalog gazetteer are run, along with on initial install. So you can run `gazetteer:build-suggester-index` or `offline-solr-gazetteer:build-suggester-index` to build the suggester. diff --git a/distribution/docs/src/main/resources/content/_reference/_dependencyList/ddf-dependency-list.adoc b/distribution/docs/src/main/resources/content/_reference/_dependencyList/ddf-dependency-list.adoc index ce4e6e00bdc7..88b6cc695b87 100644 --- a/distribution/docs/src/main/resources/content/_reference/_dependencyList/ddf-dependency-list.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_dependencyList/ddf-dependency-list.adoc @@ -7,340 +7,340 @@ == {summary} ((({title}))) -* c3p0:c3p0:jar:0.9.1.1 -* ca.juliusdavies:not-yet-commons-ssl:jar:0.3.11 -* ch.qos.logback:logback-access:jar:1.2.3 -* ch.qos.logback:logback-classic:jar:1.2.3 -* ch.qos.logback:logback-core:jar:1.2.3 -* com.auth0:java-jwt:jar:3.8.1 -* com.codahale.metrics:metrics-core:jar:3.0.1 -* com.connexta.arbitro:arbitro-core:jar:1.0.0 -* com.fasterxml.jackson.core:jackson-annotations:jar:2.9.8 -* com.fasterxml.jackson.core:jackson-core:jar:2.9.8 -* com.fasterxml.jackson.core:jackson-databind:jar:2.9.8 -* com.fasterxml.woodstox:woodstox-core:jar:5.3.0 -* com.github.drapostolos:type-parser:jar:0.5.0 -* com.github.jai-imageio:jai-imageio-core:jar:1.3.1 -* com.github.jai-imageio:jai-imageio-jpeg2000:jar:1.3.1_CODICE_3 -* com.github.jknack:handlebars:jar:2.0.0 -* com.github.lookfirst:sardine:jar:5.7 -* com.google.code.gson:gson:jar:2.8.5 -* com.google.crypto.tink:tink:jar:1.2.2 -* com.google.guava:guava:jar:25.1-jre -* com.google.http-client:google-http-client:jar:1.22.0 -* com.google.protobuf:protobuf-java:jar:3.6.1 -* com.googlecode.json-simple:json-simple:jar:1.1.1 -* com.googlecode.owasp-java-html-sanitizer:owasp-java-html-sanitizer:jar:20171016.1 -* com.hazelcast:hazelcast:jar:3.2.1 -* com.jayway.restassured:rest-assured:jar:2.9.0 -* com.jhlabs:filters:jar:2.0.235-1 -* com.nimbusds:lang-tag:jar:1.4.4 -* com.nimbusds:nimbus-jose-jwt:jar:6.5 -* com.nimbusds:oauth2-oidc-sdk:jar:6.5 -* com.rometools:rome-utils:jar:1.9.0 -* com.rometools:rome:jar:1.9.0 -* com.sparkjava:spark-core:jar:2.5.5 -* com.sun.xml.bind:jaxb-core:jar:2.2.11 -* com.sun.xml.bind:jaxb-impl:jar:2.2.11 -* com.thoughtworks.xstream:xstream:jar:1.4.9 -* com.unboundid:unboundid-ldapsdk:jar:3.2.1 -* com.vividsolutions:jts-core:jar:1.14.0 -* com.vividsolutions:jts-io:jar:1.14.0 -* com.xebialabs.restito:restito:jar:0.8.2 -* com.zensols.jrtf:tutego.jrtf:jar:0.1.0 -* commons-beanutils:commons-beanutils:jar:1.9.4 -* commons-codec:commons-codec:jar:1.12 -* commons-collections:commons-collections:jar:3.2.2 -* commons-configuration:commons-configuration:jar:1.10 -* commons-digester:commons-digester:jar:1.8.1 -* commons-fileupload:commons-fileupload:jar:1.3.3 -* commons-io:commons-io:jar:2.1 -* commons-io:commons-io:jar:2.4 -* commons-io:commons-io:jar:2.6 -* commons-lang:commons-lang:jar:2.6 -* commons-logging:commons-logging:jar:1.2 -* commons-net:commons-net:jar:3.5 -* commons-validator:commons-validator:jar:1.6 -* de.micromata.jak:JavaAPIforKml:jar:2.2.0 -* de.micromata.jak:JavaAPIforKml:jar:2.2.1_CODICE_1 -* io.dropwizard.metrics:metrics-core:jar:3.2.6 -* io.sgr:s2-geometry-library-java:jar:1.0.0 -* javax.annotation:javax.annotation-api:jar:1.2 -* javax.inject:javax.inject:jar:1 -* javax.mail:javax.mail-api:jar:1.6.2 -* javax.servlet:javax.servlet-api:jar:3.1.0 -* javax.servlet:servlet-api:jar:2.5 -* javax.validation:validation-api:jar:1.1.0.Final -* javax.ws.rs:javax.ws.rs-api:jar:2.1 -* javax.xml.bind:jaxb-api:jar:2.2.11 -* joda-time:joda-time:jar:2.10.3 -* junit:junit:jar:4.12 -* log4j:log4j:jar:1.2.17 -* net.jodah:failsafe:jar:0.9.3 -* net.jodah:failsafe:jar:0.9.5 -* net.jodah:failsafe:jar:1.0.0 -* net.minidev:accessors-smart:jar:1.2 -* net.minidev:asm:jar:1.0.2 -* net.minidev:json-smart:jar:2.3 -* net.sf.saxon:Saxon-HE:jar:9.5.1-3 -* net.sf.saxon:Saxon-HE:jar:9.6.0-4 -* org.antlr:antlr4-runtime:jar:4.3 -* org.apache.abdera:abdera-extensions-geo:jar:1.1.3 -* org.apache.abdera:abdera-extensions-opensearch:jar:1.1.3 -* org.apache.ant:ant-launcher:jar:1.9.7 -* org.apache.ant:ant:jar:1.9.7 -* org.apache.aries.jmx:org.apache.aries.jmx.api:jar:1.1.5 -* org.apache.aries.jmx:org.apache.aries.jmx.core:jar:1.1.8 -* org.apache.aries.proxy:org.apache.aries.proxy:jar:1.1.4 -* org.apache.aries:org.apache.aries.util:jar:1.1.3 -* org.apache.camel:camel-aws:jar:2.24.2 -* org.apache.camel:camel-blueprint:jar:2.24.2 -* org.apache.camel:camel-context:jar:2.24.2 -* org.apache.camel:camel-core-osgi:jar:2.24.2 -* org.apache.camel:camel-core:jar:2.24.2 -* org.apache.camel:camel-http-common:jar:2.24.2 -* org.apache.camel:camel-http4:jar:2.24.2 -* org.apache.camel:camel-http:jar:2.24.2 -* org.apache.camel:camel-quartz:jar:2.24.2 -* org.apache.camel:camel-saxon:jar:2.24.2 -* org.apache.camel:camel-servlet:jar:2.24.2 -* org.apache.commons:commons-collections4:jar:4.1 -* org.apache.commons:commons-compress:jar:1.18 -* org.apache.commons:commons-csv:jar:1.4 -* org.apache.commons:commons-exec:jar:1.3 -* org.apache.commons:commons-lang3:jar:3.0 -* org.apache.commons:commons-lang3:jar:3.3.2 -* org.apache.commons:commons-lang3:jar:3.4 -* org.apache.commons:commons-lang3:jar:3.9 -* org.apache.commons:commons-math3:jar:3.6.1 -* org.apache.commons:commons-math:jar:2.2 -* org.apache.commons:commons-pool2:jar:2.5.0 -* org.apache.commons:commons-text:jar:1.6 -* org.apache.cxf:cxf-core:jar:3.2.9 -* org.apache.cxf:cxf-rt-frontend-jaxrs:jar:3.2.9 -* org.apache.cxf:cxf-rt-frontend-jaxws:jar:3.2.9 -* org.apache.cxf:cxf-rt-rs-client:jar:3.2.9 -* org.apache.cxf:cxf-rt-rs-security-jose-jaxrs:jar:3.2.9 -* org.apache.cxf:cxf-rt-rs-security-jose:jar:3.2.9 -* org.apache.cxf:cxf-rt-rs-security-sso-saml:jar:3.2.9 -* org.apache.cxf:cxf-rt-rs-security-xml:jar:3.2.9 -* org.apache.cxf:cxf-rt-transports-http:jar:3.2.9 -* org.apache.cxf:cxf-rt-ws-policy:jar:3.2.9 -* org.apache.cxf:cxf-rt-ws-security:jar:3.2.9 -* org.apache.felix:org.apache.felix.configadmin:jar:1.9.14 -* org.apache.felix:org.apache.felix.fileinstall:jar:3.6.4 -* org.apache.felix:org.apache.felix.framework:jar:5.6.12 -* org.apache.felix:org.apache.felix.scr:jar:2.0.14 -* org.apache.felix:org.apache.felix.utils:jar:1.11.2 -* org.apache.ftpserver:ftplet-api:jar:1.0.6 -* org.apache.ftpserver:ftpserver-core:jar:1.0.6 -* org.apache.httpcomponents:httpclient:jar:4.5.3 -* org.apache.httpcomponents:httpclient:jar:4.5.6 -* org.apache.httpcomponents:httpcore:jar:4.4.10 -* org.apache.httpcomponents:httpmime:jar:4.5.3 -* org.apache.httpcomponents:httpmime:jar:4.5.6 -* org.apache.karaf.bundle:org.apache.karaf.bundle.core:jar:4.2.6 -* org.apache.karaf.features:org.apache.karaf.features.core:jar:4.2.6 -* org.apache.karaf.features:standard:xml:features:4.2.6 -* org.apache.karaf.itests:common:jar:4.2.6 -* org.apache.karaf.jaas:org.apache.karaf.jaas.boot:jar:4.2.6 -* org.apache.karaf.jaas:org.apache.karaf.jaas.config:jar:4.2.6 -* org.apache.karaf.jaas:org.apache.karaf.jaas.modules:jar:4.2.6 -* org.apache.karaf.log:org.apache.karaf.log.core:jar:4.2.6 -* org.apache.karaf.shell:org.apache.karaf.shell.console:jar:4.2.6 -* org.apache.karaf.shell:org.apache.karaf.shell.core:jar:4.2.6 -* org.apache.karaf.system:org.apache.karaf.system.core:jar:4.2.6 -* org.apache.karaf:apache-karaf:tar.gz:4.2.6 -* org.apache.karaf:apache-karaf:zip:4.2.6 -* org.apache.karaf:org.apache.karaf.util:jar:4.2.6 -* org.apache.logging.log4j:log4j-1.2-api:jar:2.11.0 -* org.apache.logging.log4j:log4j-api:jar:2.11.0 -* org.apache.logging.log4j:log4j-api:jar:2.8.2 -* org.apache.logging.log4j:log4j-core:jar:2.11.0 -* org.apache.logging.log4j:log4j-slf4j-impl:jar:2.11.0 -* org.apache.lucene:lucene-analyzers-common:jar:7.7.2 -* org.apache.lucene:lucene-core:jar:3.0.2 -* org.apache.lucene:lucene-core:jar:7.7.2 -* org.apache.lucene:lucene-queries:jar:7.7.2 -* org.apache.lucene:lucene-queryparser:jar:7.7.2 -* org.apache.lucene:lucene-sandbox:jar:7.7.2 -* org.apache.lucene:lucene-spatial-extras:jar:7.7.2 -* org.apache.lucene:lucene-spatial3d:jar:7.7.2 -* org.apache.lucene:lucene-spatial:jar:7.7.2 -* org.apache.mina:mina-core:jar:2.0.6 -* org.apache.pdfbox:fontbox:jar:2.0.11 -* org.apache.pdfbox:pdfbox-tools:jar:2.0.11 -* org.apache.pdfbox:pdfbox:jar:2.0.11 -* org.apache.poi:poi-ooxml:jar:3.17 -* org.apache.poi:poi-scratchpad:jar:3.17 -* org.apache.poi:poi:jar:3.17 -* org.apache.servicemix.bundles:org.apache.servicemix.bundles.poi:jar:3.17_1 -* org.apache.servicemix.specs:org.apache.servicemix.specs.jsr339-api-2.0:jar:2.6.0 -* org.apache.shiro:shiro-core:jar:1.4.0 -* org.apache.solr:solr-core:jar:7.7.2 -* org.apache.solr:solr-solrj:jar:7.7.2 -* org.apache.tika:tika-core:jar:1.18 -* org.apache.tika:tika-parsers:jar:1.18 -* org.apache.ws.commons.axiom:axiom-api:jar:1.2.14 -* org.apache.ws.xmlschema:xmlschema-core:jar:2.2.2 -* org.apache.ws.xmlschema:xmlschema-core:jar:2.2.3 -* org.apache.wss4j:wss4j-bindings:jar:2.2.3 -* org.apache.wss4j:wss4j-policy:jar:2.2.3 -* org.apache.wss4j:wss4j-ws-security-common:jar:2.2.3 -* org.apache.wss4j:wss4j-ws-security-dom:jar:2.2.3 -* org.apache.wss4j:wss4j-ws-security-policy-stax:jar:2.2.3 -* org.apache.wss4j:wss4j-ws-security-stax:jar:2.2.3 -* org.apache.zookeeper:zookeeper:jar:3.4.14 -* org.asciidoctor:asciidoctorj-diagram:jar:1.5.4.1 -* org.asciidoctor:asciidoctorj:jar:1.5.6 -* org.assertj:assertj-core:jar:2.1.0 -* org.awaitility:awaitility:jar:3.1.5 -* org.bouncycastle:bcmail-jdk15on:jar:1.61 -* org.bouncycastle:bcpkix-jdk15on:jar:1.61 -* org.bouncycastle:bcprov-jdk15on:jar:1.61 -* org.codehaus.woodstox:stax2-api:jar:4.2 -* org.codice.acdebugger:acdebugger-api:jar:1.7 -* org.codice.acdebugger:acdebugger-backdoor:jar:1.7 -* org.codice.countrycode:converter:jar:0.1.8 -* org.codice.httpproxy:proxy-camel-route:jar:2.21.0-SNAPSHOT -* org.codice.httpproxy:proxy-camel-servlet:jar:2.21.0-SNAPSHOT -* org.codice.opendj.embedded:opendj-embedded-app:xml:features:1.3.3 -* org.codice.pro-grade:pro-grade:jar:1.1.3 -* org.codice.thirdparty:commons-httpclient:jar:3.1.0_1 -* org.codice.thirdparty:ffmpeg:zip:bin:4.0_2 -* org.codice.thirdparty:geotools-suite:jar:19.1_2 -* org.codice.thirdparty:gt-opengis:jar:19.1_1 -* org.codice.thirdparty:jts:jar:1.14.0_1 -* org.codice.thirdparty:lucene-core:jar:3.0.2_1 -* org.codice.thirdparty:ogc-filter-v_1_1_0-schema:jar:1.1.0_5 -* org.codice.thirdparty:picocontainer:jar:1.3_1 -* org.codice.thirdparty:tika-bundle:jar:1.18.0_5 -* org.codice.usng4j:usng4j-api:jar:0.4 -* org.codice.usng4j:usng4j-impl:jar:0.4 -* org.codice:lux:jar:1.2 -* org.cryptomator:siv-mode:jar:1.2.2 -* org.eclipse.jetty:jetty-http:jar:9.4.18.v20190429 -* org.eclipse.jetty:jetty-security:jar:9.4.18.v20190429 -* org.eclipse.jetty:jetty-server:jar:9.4.18.v20190429 -* org.eclipse.jetty:jetty-servlet:jar:9.4.18.v20190429 -* org.eclipse.jetty:jetty-servlets:jar:9.2.19.v20160908 -* org.eclipse.jetty:jetty-util:jar:9.4.18.v20190429 -* org.eclipse.platform:org.eclipse.osgi:jar:3.13.0 -* org.forgerock.commons:forgerock-util:jar:3.0.2 -* org.forgerock.commons:i18n-core:jar:1.4.2 -* org.forgerock.commons:i18n-slf4j:jar:1.4.2 -* org.forgerock.opendj:opendj-core:jar:3.0.0 -* org.forgerock.opendj:opendj-grizzly:jar:3.0.0 -* org.fusesource.jansi:jansi:jar:1.18 -* org.geotools.xsd:gt-xsd-gml3:jar:19.1 -* org.geotools:gt-cql:jar:19.1 -* org.geotools:gt-epsg-hsql:jar:19.1 -* org.geotools:gt-jts-wrapper:jar:19.1 -* org.geotools:gt-main:jar:19.1 -* org.geotools:gt-opengis:jar:19.1 -* org.geotools:gt-referencing:jar:19.1 -* org.geotools:gt-shapefile:jar:19.1 -* org.geotools:gt-xml:jar:19.1 -* org.glassfish.grizzly:grizzly-framework:jar:2.3.30 -* org.glassfish.grizzly:grizzly-http-server:jar:2.3.25 -* org.hamcrest:hamcrest-all:jar:1.3 -* org.hisrc.w3c:xlink-v_1_0:jar:1.4.0 -* org.hisrc.w3c:xmlschema-v_1_0:jar:1.4.0 -* org.imgscalr:imgscalr-lib:jar:4.2 -* org.jasypt:jasypt:jar:1.9.0 -* org.jasypt:jasypt:jar:1.9.2 -* org.jcodec:jcodec:jar:0.2.0_1 -* org.jdom:jdom2:jar:2.0.6 -* org.joda:joda-convert:jar:1.2 -* org.jolokia:jolokia-osgi:jar:1.2.3 -* org.jruby:jruby-complete:jar:9.0.4.0 -* org.jscience:jscience:jar:4.3.1 -* org.json:json:jar:20170516 -* org.jsoup:jsoup:jar:1.11.3 -* org.jvnet.jaxb2_commons:jaxb2-basics-runtime:jar:0.10.0 -* org.jvnet.jaxb2_commons:jaxb2-basics-runtime:jar:0.11.0 -* org.jvnet.jaxb2_commons:jaxb2-basics-runtime:jar:0.6.0 -* org.jvnet.ogc:filter-v_1_1_0:jar:2.6.1 -* org.jvnet.ogc:filter-v_2_0:jar:2.6.1 -* org.jvnet.ogc:filter-v_2_0_0-schema:jar:1.1.0 -* org.jvnet.ogc:gml-v_3_1_1-schema:jar:1.1.0 -* org.jvnet.ogc:gml-v_3_1_1:jar:2.6.1 -* org.jvnet.ogc:gml-v_3_2_1-schema:jar:1.1.0 -* org.jvnet.ogc:gml-v_3_2_1:pom:1.1.0 -* org.jvnet.ogc:ogc-tools-gml-jts:jar:1.0.3 -* org.jvnet.ogc:ows-v_1_0_0-schema:jar:1.1.0 -* org.jvnet.ogc:ows-v_1_0_0:jar:2.6.1 -* org.jvnet.ogc:ows-v_1_1_0-schema:jar:1.1.0 -* org.jvnet.ogc:ows-v_2_0:jar:2.6.1 -* org.jvnet.ogc:wcs-v_1_0_0-schema:jar:1.1.0 -* org.jvnet.ogc:wfs-v_1_1_0:jar:2.6.1 -* org.la4j:la4j:jar:0.6.0 -* org.locationtech.jts:jts-core:jar:1.15.0 -* org.locationtech.spatial4j:spatial4j:jar:0.6 -* org.locationtech.spatial4j:spatial4j:jar:0.7 -* org.mindrot:jbcrypt:jar:0.4 -* org.mockito:mockito-core:jar:1.10.19 -* org.objenesis:objenesis:jar:2.5.1 -* org.opensaml:opensaml-core:jar:3.3.0 -* org.opensaml:opensaml-messaging-api:jar:3.3.0 -* org.opensaml:opensaml-profile-api:jar:3.3.0 -* org.opensaml:opensaml-saml-api:jar:3.3.0 -* org.opensaml:opensaml-saml-impl:jar:3.3.0 -* org.opensaml:opensaml-security-api:jar:3.3.0 -* org.opensaml:opensaml-security-impl:jar:3.3.0 -* org.opensaml:opensaml-soap-api:jar:3.3.0 -* org.opensaml:opensaml-soap-impl:jar:3.3.0 -* org.opensaml:opensaml-storage-api:jar:3.3.0 -* org.opensaml:opensaml-xacml-api:jar:3.3.0 -* org.opensaml:opensaml-xacml-impl:jar:3.3.0 -* org.opensaml:opensaml-xacml-saml-api:jar:3.3.0 -* org.opensaml:opensaml-xacml-saml-impl:jar:3.3.0 -* org.opensaml:opensaml-xmlsec-api:jar:3.3.0 -* org.opensaml:opensaml-xmlsec-impl:jar:3.3.0 -* org.ops4j.pax.exam:pax-exam-container-karaf:jar:4.13.2.CODICE -* org.ops4j.pax.exam:pax-exam-features:xml:4.13.2.CODICE -* org.ops4j.pax.exam:pax-exam-junit4:jar:4.13.2.CODICE -* org.ops4j.pax.exam:pax-exam-link-mvn:jar:4.13.2.CODICE -* org.ops4j.pax.exam:pax-exam:jar:4.13.2.CODICE -* org.ops4j.pax.swissbox:pax-swissbox-extender:jar:1.8.2 -* org.ops4j.pax.tinybundles:tinybundles:jar:2.1.1 -* org.ops4j.pax.url:pax-url-aether:jar:2.4.5 -* org.ops4j.pax.url:pax-url-wrap:jar:2.4.5 -* org.ops4j.pax.web:pax-web-api:jar:7.2.11 -* org.ops4j.pax.web:pax-web-jsp:jar:7.2.11 -* org.osgi:org.osgi.compendium:jar:4.3.1 -* org.osgi:org.osgi.compendium:jar:5.0.0 -* org.osgi:org.osgi.core:jar:5.0.0 -* org.osgi:org.osgi.enterprise:jar:5.0.0 -* org.ow2.asm:asm-analysis:jar:6.2.1 -* org.ow2.asm:asm-tree:jar:6.2.1 -* org.ow2.asm:asm:jar:5.2 -* org.ow2.asm:asm:jar:6.2.1 -* org.pac4j:pac4j-core:jar:3.8.2 -* org.pac4j:pac4j-jwt:jar:3.8.2 -* org.pac4j:pac4j-oauth:jar:3.8.2 -* org.pac4j:pac4j-oidc:jar:3.8.2 -* org.parboiled:parboiled-core:jar:1.2.0 -* org.parboiled:parboiled-java:jar:1.2.0 -* org.quartz-scheduler:quartz-jobs:jar:2.2.3 -* org.quartz-scheduler:quartz:jar:2.1.7 -* org.quartz-scheduler:quartz:jar:2.2.3 -* org.rrd4j:rrd4j:jar:3.3.1 -* org.slf4j:jcl-over-slf4j:jar:1.7.24 -* org.slf4j:jul-to-slf4j:jar:1.7.24 -* org.slf4j:slf4j-api:jar:1.7.1 -* org.slf4j:slf4j-api:jar:1.7.24 -* org.slf4j:slf4j-ext:jar:1.7.1 -* org.slf4j:slf4j-log4j12:jar:1.7.24 -* org.slf4j:slf4j-simple:jar:1.7.1 -* org.springframework.ldap:spring-ldap-core:jar:2.3.2.RELEASE -* org.springframework.osgi:spring-osgi-core:jar:1.2.1 -* org.springframework:spring-core:jar:5.1.7.RELEASE -* org.taktik:mpegts-streamer:jar:0.1.0_2 -* org.xmlunit:xmlunit-matchers:jar:2.5.1 -* xalan:serializer:jar:2.7.2 -* xalan:xalan:jar:2.7.2 -* xerces:xercesImpl:jar:2.11.0 -* xerces:xercesImpl:jar:2.9.1 -* xml-apis:xml-apis:jar:1.4.01 -* xpp3:xpp3:jar:1.1.4c +* `c3p0:c3p0:jar:0.9.1.1` +* `ca.juliusdavies:not-yet-commons-ssl:jar:0.3.11` +* `ch.qos.logback:logback-access:jar:1.2.3` +* `ch.qos.logback:logback-classic:jar:1.2.3` +* `ch.qos.logback:logback-core:jar:1.2.3` +* `com.auth0:java-jwt:jar:3.8.1` +* `com.codahale.metrics:metrics-core:jar:3.0.1` +* `com.connexta.arbitro:arbitro-core:jar:1.0.0` +* `com.fasterxml.jackson.core:jackson-annotations:jar:2.9.8` +* `com.fasterxml.jackson.core:jackson-core:jar:2.9.8` +* `com.fasterxml.jackson.core:jackson-databind:jar:2.9.8` +* `com.fasterxml.woodstox:woodstox-core:jar:5.3.0` +* `com.github.drapostolos:type-parser:jar:0.5.0` +* `com.github.jai-imageio:jai-imageio-core:jar:1.3.1` +* `com.github.jai-imageio:jai-imageio-jpeg2000:jar:1.3.1_CODICE_3` +* `com.github.jknack:handlebars:jar:2.0.0` +* `com.github.lookfirst:sardine:jar:5.7` +* `com.google.code.gson:gson:jar:2.8.5` +* `com.google.crypto.tink:tink:jar:1.2.2` +* `com.google.guava:guava:jar:25.1-jre` +* `com.google.http-client:google-http-client:jar:1.22.0` +* `com.google.protobuf:protobuf-java:jar:3.6.1` +* `com.googlecode.json-simple:json-simple:jar:1.1.1` +* `com.googlecode.owasp-java-html-sanitizer:owasp-java-html-sanitizer:jar:20171016.1` +* `com.hazelcast:hazelcast:jar:3.2.1` +* `com.jayway.restassured:rest-assured:jar:2.9.0` +* `com.jhlabs:filters:jar:2.0.235-1` +* `com.nimbusds:lang-tag:jar:1.4.4` +* `com.nimbusds:nimbus-jose-jwt:jar:6.5` +* `com.nimbusds:oauth2-oidc-sdk:jar:6.5` +* `com.rometools:rome-utils:jar:1.9.0` +* `com.rometools:rome:jar:1.9.0` +* `com.sparkjava:spark-core:jar:2.5.5` +* `com.sun.xml.bind:jaxb-core:jar:2.2.11` +* `com.sun.xml.bind:jaxb-impl:jar:2.2.11` +* `com.thoughtworks.xstream:xstream:jar:1.4.9` +* `com.unboundid:unboundid-ldapsdk:jar:3.2.1` +* `com.vividsolutions:jts-core:jar:1.14.0` +* `com.vividsolutions:jts-io:jar:1.14.0` +* `com.xebialabs.restito:restito:jar:0.8.2` +* `com.zensols.jrtf:tutego.jrtf:jar:0.1.0` +* `commons-beanutils:commons-beanutils:jar:1.9.4` +* `commons-codec:commons-codec:jar:1.12` +* `commons-collections:commons-collections:jar:3.2.2` +* `commons-configuration:commons-configuration:jar:1.10` +* `commons-digester:commons-digester:jar:1.8.1` +* `commons-fileupload:commons-fileupload:jar:1.3.3` +* `commons-io:commons-io:jar:2.1` +* `commons-io:commons-io:jar:2.4` +* `commons-io:commons-io:jar:2.6` +* `commons-lang:commons-lang:jar:2.6` +* `commons-logging:commons-logging:jar:1.2` +* `commons-net:commons-net:jar:3.5` +* `commons-validator:commons-validator:jar:1.6` +* `de.micromata.jak:JavaAPIforKml:jar:2.2.0` +* `de.micromata.jak:JavaAPIforKml:jar:2.2.1_CODICE_1` +* `io.dropwizard.metrics:metrics-core:jar:3.2.6` +* `io.sgr:s2-geometry-library-java:jar:1.0.0` +* `javax.annotation:javax.annotation-api:jar:1.2` +* `javax.inject:javax.inject:jar:1` +* `javax.mail:javax.mail-api:jar:1.6.2` +* `javax.servlet:javax.servlet-api:jar:3.1.0` +* `javax.servlet:servlet-api:jar:2.5` +* `javax.validation:validation-api:jar:1.1.0.Final` +* `javax.ws.rs:javax.ws.rs-api:jar:2.1` +* `javax.xml.bind:jaxb-api:jar:2.2.11` +* `joda-time:joda-time:jar:2.10.3` +* `junit:junit:jar:4.12` +* `log4j:log4j:jar:1.2.17` +* `net.jodah:failsafe:jar:0.9.3` +* `net.jodah:failsafe:jar:0.9.5` +* `net.jodah:failsafe:jar:1.0.0` +* `net.minidev:accessors-smart:jar:1.2` +* `net.minidev:asm:jar:1.0.2` +* `net.minidev:json-smart:jar:2.3` +* `net.sf.saxon:Saxon-HE:jar:9.5.1-3` +* `net.sf.saxon:Saxon-HE:jar:9.6.0-4` +* `org.antlr:antlr4-runtime:jar:4.3` +* `org.apache.abdera:abdera-extensions-geo:jar:1.1.3` +* `org.apache.abdera:abdera-extensions-opensearch:jar:1.1.3` +* `org.apache.ant:ant-launcher:jar:1.9.7` +* `org.apache.ant:ant:jar:1.9.7` +* `org.apache.aries.jmx:org.apache.aries.jmx.api:jar:1.1.5` +* `org.apache.aries.jmx:org.apache.aries.jmx.core:jar:1.1.8` +* `org.apache.aries.proxy:org.apache.aries.proxy:jar:1.1.4` +* `org.apache.aries:org.apache.aries.util:jar:1.1.3` +* `org.apache.camel:camel-aws:jar:2.24.2` +* `org.apache.camel:camel-blueprint:jar:2.24.2` +* `org.apache.camel:camel-context:jar:2.24.2` +* `org.apache.camel:camel-core-osgi:jar:2.24.2` +* `org.apache.camel:camel-core:jar:2.24.2` +* `org.apache.camel:camel-http-common:jar:2.24.2` +* `org.apache.camel:camel-http4:jar:2.24.2` +* `org.apache.camel:camel-http:jar:2.24.2` +* `org.apache.camel:camel-quartz:jar:2.24.2` +* `org.apache.camel:camel-saxon:jar:2.24.2` +* `org.apache.camel:camel-servlet:jar:2.24.2` +* `org.apache.commons:commons-collections4:jar:4.1` +* `org.apache.commons:commons-compress:jar:1.18` +* `org.apache.commons:commons-csv:jar:1.4` +* `org.apache.commons:commons-exec:jar:1.3` +* `org.apache.commons:commons-lang3:jar:3.0` +* `org.apache.commons:commons-lang3:jar:3.3.2` +* `org.apache.commons:commons-lang3:jar:3.4` +* `org.apache.commons:commons-lang3:jar:3.9` +* `org.apache.commons:commons-math3:jar:3.6.1` +* `org.apache.commons:commons-math:jar:2.2` +* `org.apache.commons:commons-pool2:jar:2.5.0` +* `org.apache.commons:commons-text:jar:1.6` +* `org.apache.cxf:cxf-core:jar:3.2.9` +* `org.apache.cxf:cxf-rt-frontend-jaxrs:jar:3.2.9` +* `org.apache.cxf:cxf-rt-frontend-jaxws:jar:3.2.9` +* `org.apache.cxf:cxf-rt-rs-client:jar:3.2.9` +* `org.apache.cxf:cxf-rt-rs-security-jose-jaxrs:jar:3.2.9` +* `org.apache.cxf:cxf-rt-rs-security-jose:jar:3.2.9` +* `org.apache.cxf:cxf-rt-rs-security-sso-saml:jar:3.2.9` +* `org.apache.cxf:cxf-rt-rs-security-xml:jar:3.2.9` +* `org.apache.cxf:cxf-rt-transports-http:jar:3.2.9` +* `org.apache.cxf:cxf-rt-ws-policy:jar:3.2.9` +* `org.apache.cxf:cxf-rt-ws-security:jar:3.2.9` +* `org.apache.felix:org.apache.felix.configadmin:jar:1.9.14` +* `org.apache.felix:org.apache.felix.fileinstall:jar:3.6.4` +* `org.apache.felix:org.apache.felix.framework:jar:5.6.12` +* `org.apache.felix:org.apache.felix.scr:jar:2.0.14` +* `org.apache.felix:org.apache.felix.utils:jar:1.11.2` +* `org.apache.ftpserver:ftplet-api:jar:1.0.6` +* `org.apache.ftpserver:ftpserver-core:jar:1.0.6` +* `org.apache.httpcomponents:httpclient:jar:4.5.3` +* `org.apache.httpcomponents:httpclient:jar:4.5.6` +* `org.apache.httpcomponents:httpcore:jar:4.4.10` +* `org.apache.httpcomponents:httpmime:jar:4.5.3` +* `org.apache.httpcomponents:httpmime:jar:4.5.6` +* `org.apache.karaf.bundle:org.apache.karaf.bundle.core:jar:4.2.6` +* `org.apache.karaf.features:org.apache.karaf.features.core:jar:4.2.6` +* `org.apache.karaf.features:standard:xml:features:4.2.6` +* `org.apache.karaf.itests:common:jar:4.2.6` +* `org.apache.karaf.jaas:org.apache.karaf.jaas.boot:jar:4.2.6` +* `org.apache.karaf.jaas:org.apache.karaf.jaas.config:jar:4.2.6` +* `org.apache.karaf.jaas:org.apache.karaf.jaas.modules:jar:4.2.6` +* `org.apache.karaf.log:org.apache.karaf.log.core:jar:4.2.6` +* `org.apache.karaf.shell:org.apache.karaf.shell.console:jar:4.2.6` +* `org.apache.karaf.shell:org.apache.karaf.shell.core:jar:4.2.6` +* `org.apache.karaf.system:org.apache.karaf.system.core:jar:4.2.6` +* `org.apache.karaf:apache-karaf:tar.gz:4.2.6` +* `org.apache.karaf:apache-karaf:zip:4.2.6` +* `org.apache.karaf:org.apache.karaf.util:jar:4.2.6` +* `org.apache.logging.log4j:log4j-1.2-api:jar:2.11.0` +* `org.apache.logging.log4j:log4j-api:jar:2.11.0` +* `org.apache.logging.log4j:log4j-api:jar:2.8.2` +* `org.apache.logging.log4j:log4j-core:jar:2.11.0` +* `org.apache.logging.log4j:log4j-slf4j-impl:jar:2.11.0` +* `org.apache.lucene:lucene-analyzers-common:jar:7.7.2` +* `org.apache.lucene:lucene-core:jar:3.0.2` +* `org.apache.lucene:lucene-core:jar:7.7.2` +* `org.apache.lucene:lucene-queries:jar:7.7.2` +* `org.apache.lucene:lucene-queryparser:jar:7.7.2` +* `org.apache.lucene:lucene-sandbox:jar:7.7.2` +* `org.apache.lucene:lucene-spatial-extras:jar:7.7.2` +* `org.apache.lucene:lucene-spatial3d:jar:7.7.2` +* `org.apache.lucene:lucene-spatial:jar:7.7.2` +* `org.apache.mina:mina-core:jar:2.0.6` +* `org.apache.pdfbox:fontbox:jar:2.0.11` +* `org.apache.pdfbox:pdfbox-tools:jar:2.0.11` +* `org.apache.pdfbox:pdfbox:jar:2.0.11` +* `org.apache.poi:poi-ooxml:jar:3.17` +* `org.apache.poi:poi-scratchpad:jar:3.17` +* `org.apache.poi:poi:jar:3.17` +* `org.apache.servicemix.bundles:org.apache.servicemix.bundles.poi:jar:3.17_1` +* `org.apache.servicemix.specs:org.apache.servicemix.specs.jsr339-api-2.0:jar:2.6.0` +* `org.apache.shiro:shiro-core:jar:1.4.0` +* `org.apache.solr:solr-core:jar:7.7.2` +* `org.apache.solr:solr-solrj:jar:7.7.2` +* `org.apache.tika:tika-core:jar:1.18` +* `org.apache.tika:tika-parsers:jar:1.18` +* `org.apache.ws.commons.axiom:axiom-api:jar:1.2.14` +* `org.apache.ws.xmlschema:xmlschema-core:jar:2.2.2` +* `org.apache.ws.xmlschema:xmlschema-core:jar:2.2.3` +* `org.apache.wss4j:wss4j-bindings:jar:2.2.3` +* `org.apache.wss4j:wss4j-policy:jar:2.2.3` +* `org.apache.wss4j:wss4j-ws-security-common:jar:2.2.3` +* `org.apache.wss4j:wss4j-ws-security-dom:jar:2.2.3` +* `org.apache.wss4j:wss4j-ws-security-policy-stax:jar:2.2.3` +* `org.apache.wss4j:wss4j-ws-security-stax:jar:2.2.3` +* `org.apache.zookeeper:zookeeper:jar:3.4.14` +* `org.asciidoctor:asciidoctorj-diagram:jar:1.5.4.1` +* `org.asciidoctor:asciidoctorj:jar:1.5.6` +* `org.assertj:assertj-core:jar:2.1.0` +* `org.awaitility:awaitility:jar:3.1.5` +* `org.bouncycastle:bcmail-jdk15on:jar:1.61` +* `org.bouncycastle:bcpkix-jdk15on:jar:1.61` +* `org.bouncycastle:bcprov-jdk15on:jar:1.61` +* `org.codehaus.woodstox:stax2-api:jar:4.2` +* `org.codice.acdebugger:acdebugger-api:jar:1.7` +* `org.codice.acdebugger:acdebugger-backdoor:jar:1.7` +* `org.codice.countrycode:converter:jar:0.1.8` +* `org.codice.httpproxy:proxy-camel-route:jar:2.21.0-SNAPSHOT` +* `org.codice.httpproxy:proxy-camel-servlet:jar:2.21.0-SNAPSHOT` +* `org.codice.opendj.embedded:opendj-embedded-app:xml:features:1.3.3` +* `org.codice.pro-grade:pro-grade:jar:1.1.3` +* `org.codice.thirdparty:commons-httpclient:jar:3.1.0_1` +* `org.codice.thirdparty:ffmpeg:zip:bin:4.0_2` +* `org.codice.thirdparty:geotools-suite:jar:19.1_2` +* `org.codice.thirdparty:gt-opengis:jar:19.1_1` +* `org.codice.thirdparty:jts:jar:1.14.0_1` +* `org.codice.thirdparty:lucene-core:jar:3.0.2_1` +* `org.codice.thirdparty:ogc-filter-v_1_1_0-schema:jar:1.1.0_5` +* `org.codice.thirdparty:picocontainer:jar:1.3_1` +* `org.codice.thirdparty:tika-bundle:jar:1.18.0_5` +* `org.codice.usng4j:usng4j-api:jar:0.4` +* `org.codice.usng4j:usng4j-impl:jar:0.4` +* `org.codice:lux:jar:1.2` +* `org.cryptomator:siv-mode:jar:1.2.2` +* `org.eclipse.jetty:jetty-http:jar:9.4.18.v20190429` +* `org.eclipse.jetty:jetty-security:jar:9.4.18.v20190429` +* `org.eclipse.jetty:jetty-server:jar:9.4.18.v20190429` +* `org.eclipse.jetty:jetty-servlet:jar:9.4.18.v20190429` +* `org.eclipse.jetty:jetty-servlets:jar:9.2.19.v20160908` +* `org.eclipse.jetty:jetty-util:jar:9.4.18.v20190429` +* `org.eclipse.platform:org.eclipse.osgi:jar:3.13.0` +* `org.forgerock.commons:forgerock-util:jar:3.0.2` +* `org.forgerock.commons:i18n-core:jar:1.4.2` +* `org.forgerock.commons:i18n-slf4j:jar:1.4.2` +* `org.forgerock.opendj:opendj-core:jar:3.0.0` +* `org.forgerock.opendj:opendj-grizzly:jar:3.0.0` +* `org.fusesource.jansi:jansi:jar:1.18` +* `org.geotools.xsd:gt-xsd-gml3:jar:19.1` +* `org.geotools:gt-cql:jar:19.1` +* `org.geotools:gt-epsg-hsql:jar:19.1` +* `org.geotools:gt-jts-wrapper:jar:19.1` +* `org.geotools:gt-main:jar:19.1` +* `org.geotools:gt-opengis:jar:19.1` +* `org.geotools:gt-referencing:jar:19.1` +* `org.geotools:gt-shapefile:jar:19.1` +* `org.geotools:gt-xml:jar:19.1` +* `org.glassfish.grizzly:grizzly-framework:jar:2.3.30` +* `org.glassfish.grizzly:grizzly-http-server:jar:2.3.25` +* `org.hamcrest:hamcrest-all:jar:1.3` +* `org.hisrc.w3c:xlink-v_1_0:jar:1.4.0` +* `org.hisrc.w3c:xmlschema-v_1_0:jar:1.4.0` +* `org.imgscalr:imgscalr-lib:jar:4.2` +* `org.jasypt:jasypt:jar:1.9.0` +* `org.jasypt:jasypt:jar:1.9.2` +* `org.jcodec:jcodec:jar:0.2.0_1` +* `org.jdom:jdom2:jar:2.0.6` +* `org.joda:joda-convert:jar:1.2` +* `org.jolokia:jolokia-osgi:jar:1.2.3` +* `org.jruby:jruby-complete:jar:9.0.4.0` +* `org.jscience:jscience:jar:4.3.1` +* `org.json:json:jar:20170516` +* `org.jsoup:jsoup:jar:1.11.3` +* `org.jvnet.jaxb2_commons:jaxb2-basics-runtime:jar:0.10.0` +* `org.jvnet.jaxb2_commons:jaxb2-basics-runtime:jar:0.11.0` +* `org.jvnet.jaxb2_commons:jaxb2-basics-runtime:jar:0.6.0` +* `org.jvnet.ogc:filter-v_1_1_0:jar:2.6.1` +* `org.jvnet.ogc:filter-v_2_0:jar:2.6.1` +* `org.jvnet.ogc:filter-v_2_0_0-schema:jar:1.1.0` +* `org.jvnet.ogc:gml-v_3_1_1-schema:jar:1.1.0` +* `org.jvnet.ogc:gml-v_3_1_1:jar:2.6.1` +* `org.jvnet.ogc:gml-v_3_2_1-schema:jar:1.1.0` +* `org.jvnet.ogc:gml-v_3_2_1:pom:1.1.0` +* `org.jvnet.ogc:ogc-tools-gml-jts:jar:1.0.3` +* `org.jvnet.ogc:ows-v_1_0_0-schema:jar:1.1.0` +* `org.jvnet.ogc:ows-v_1_0_0:jar:2.6.1` +* `org.jvnet.ogc:ows-v_1_1_0-schema:jar:1.1.0` +* `org.jvnet.ogc:ows-v_2_0:jar:2.6.1` +* `org.jvnet.ogc:wcs-v_1_0_0-schema:jar:1.1.0` +* `org.jvnet.ogc:wfs-v_1_1_0:jar:2.6.1` +* `org.la4j:la4j:jar:0.6.0` +* `org.locationtech.jts:jts-core:jar:1.15.0` +* `org.locationtech.spatial4j:spatial4j:jar:0.6` +* `org.locationtech.spatial4j:spatial4j:jar:0.7` +* `org.mindrot:jbcrypt:jar:0.4` +* `org.mockito:mockito-core:jar:1.10.19` +* `org.objenesis:objenesis:jar:2.5.1` +* `org.opensaml:opensaml-core:jar:3.3.0` +* `org.opensaml:opensaml-messaging-api:jar:3.3.0` +* `org.opensaml:opensaml-profile-api:jar:3.3.0` +* `org.opensaml:opensaml-saml-api:jar:3.3.0` +* `org.opensaml:opensaml-saml-impl:jar:3.3.0` +* `org.opensaml:opensaml-security-api:jar:3.3.0` +* `org.opensaml:opensaml-security-impl:jar:3.3.0` +* `org.opensaml:opensaml-soap-api:jar:3.3.0` +* `org.opensaml:opensaml-soap-impl:jar:3.3.0` +* `org.opensaml:opensaml-storage-api:jar:3.3.0` +* `org.opensaml:opensaml-xacml-api:jar:3.3.0` +* `org.opensaml:opensaml-xacml-impl:jar:3.3.0` +* `org.opensaml:opensaml-xacml-saml-api:jar:3.3.0` +* `org.opensaml:opensaml-xacml-saml-impl:jar:3.3.0` +* `org.opensaml:opensaml-xmlsec-api:jar:3.3.0` +* `org.opensaml:opensaml-xmlsec-impl:jar:3.3.0` +* `org.ops4j.pax.exam:pax-exam-container-karaf:jar:4.13.2.CODICE` +* `org.ops4j.pax.exam:pax-exam-features:xml:4.13.2.CODICE` +* `org.ops4j.pax.exam:pax-exam-junit4:jar:4.13.2.CODICE` +* `org.ops4j.pax.exam:pax-exam-link-mvn:jar:4.13.2.CODICE` +* `org.ops4j.pax.exam:pax-exam:jar:4.13.2.CODICE` +* `org.ops4j.pax.swissbox:pax-swissbox-extender:jar:1.8.2` +* `org.ops4j.pax.tinybundles:tinybundles:jar:2.1.1` +* `org.ops4j.pax.url:pax-url-aether:jar:2.4.5` +* `org.ops4j.pax.url:pax-url-wrap:jar:2.4.5` +* `org.ops4j.pax.web:pax-web-api:jar:7.2.11` +* `org.ops4j.pax.web:pax-web-jsp:jar:7.2.11` +* `org.osgi:org.osgi.compendium:jar:4.3.1` +* `org.osgi:org.osgi.compendium:jar:5.0.0` +* `org.osgi:org.osgi.core:jar:5.0.0` +* `org.osgi:org.osgi.enterprise:jar:5.0.0` +* `org.ow2.asm:asm-analysis:jar:6.2.1` +* `org.ow2.asm:asm-tree:jar:6.2.1` +* `org.ow2.asm:asm:jar:5.2` +* `org.ow2.asm:asm:jar:6.2.1` +* `org.pac4j:pac4j-core:jar:3.8.2` +* `org.pac4j:pac4j-jwt:jar:3.8.2` +* `org.pac4j:pac4j-oauth:jar:3.8.2` +* `org.pac4j:pac4j-oidc:jar:3.8.2` +* `org.parboiled:parboiled-core:jar:1.2.0` +* `org.parboiled:parboiled-java:jar:1.2.0` +* `org.quartz-scheduler:quartz-jobs:jar:2.2.3` +* `org.quartz-scheduler:quartz:jar:2.1.7` +* `org.quartz-scheduler:quartz:jar:2.2.3` +* `org.rrd4j:rrd4j:jar:3.3.1` +* `org.slf4j:jcl-over-slf4j:jar:1.7.24` +* `org.slf4j:jul-to-slf4j:jar:1.7.24` +* `org.slf4j:slf4j-api:jar:1.7.1` +* `org.slf4j:slf4j-api:jar:1.7.24` +* `org.slf4j:slf4j-ext:jar:1.7.1` +* `org.slf4j:slf4j-log4j12:jar:1.7.24` +* `org.slf4j:slf4j-simple:jar:1.7.1` +* `org.springframework.ldap:spring-ldap-core:jar:2.3.2.RELEASE` +* `org.springframework.osgi:spring-osgi-core:jar:1.2.1` +* `org.springframework:spring-core:jar:5.1.7.RELEASE` +* `org.taktik:mpegts-streamer:jar:0.1.0_2` +* `org.xmlunit:xmlunit-matchers:jar:2.5.1` +* `xalan:serializer:jar:2.7.2` +* `xalan:xalan:jar:2.7.2` +* `xerces:xercesImpl:jar:2.11.0` +* `xerces:xercesImpl:jar:2.9.1` +* `xml-apis:xml-apis:jar:1.4.01` +* `xpp3:xpp3:jar:1.1.4c` diff --git a/distribution/docs/src/main/resources/content/_reference/_dependencyList/js-dependency-list.adoc b/distribution/docs/src/main/resources/content/_reference/_dependencyList/js-dependency-list.adoc index 99319593a5c3..f6029d22ba40 100644 --- a/distribution/docs/src/main/resources/content/_reference/_dependencyList/js-dependency-list.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_dependencyList/js-dependency-list.adoc @@ -7,500 +7,500 @@ == {summary} ((({title}))) -* amdefine: 1.0.1 -* are-we-there-yet: 1.1.5 -* asn1: 0.2.4 -* atob: 2.1.2 -* base: 0.11.2 -* bcrypt-pbkdf: 1.0.2 -* builtins: 1.0.3 -* byline: 5.0.0 -* caller-path: 2.0.0 -* co: 4.6.0 -* code-point-at: 1.1.0 -* copy-descriptor: 0.1.1 -* cyclist: 1.0.1 -* dashdash: 1.14.1 -* debuglog: 1.0.1 -* decode-uri-component: 0.2.0 -* deep-is: 0.1.3 -* defaults: 1.0.3 -* define-properties: 1.1.3 -* dependency-tree: 7.0.2 -* detect-indent: 5.0.0 -* detective-amd: 3.0.0 -* detective-cjs: 3.1.1 -* detective-es6: 2.1.0 -* detective-less: 1.0.2 -* detective-postcss: 3.0.1 -* detective-sass: 3.0.1 -* detective-scss: 2.0.1 -* detective-stylus: 1.0.0 -* detective-typescript: 5.6.1 -* dezalgo: 1.0.3 -* doctrine: 1.5.0 -* duplexer: 0.1.1 -* ecc-jsbn: 0.1.2 -* err-code: 1.1.2 -* es-abstract: 1.16.0 -* es6-set: 0.1.5 -* es6-weak-map: 2.0.3 -* espree: 3.5.4 -* esrecurse: 4.2.1 -* exit-hook: 1.1.1 -* fast-levenshtein: 2.0.6 -* figures: 2.0.0 -* find-up: 2.1.0 -* flat-cache: 1.3.0 -* flatten: 1.0.2 -* front-matter: 2.1.2 -* fs-minipass: 1.2.6 -* gauge: 2.7.4 -* generate-function: 2.3.1 -* generate-object-property: 1.2.0 -* genfun: 5.0.0 -* get-own-enumerable-property-symbols: 3.0.1 -* getpass: 0.1.7 -* gonzales-pe-sl: 4.2.3 -* ignore: 4.0.6 -* ignore-walk: 3.0.3 -* indent-string: 2.1.0 -* indexes-of: 1.0.1 -* ip: 1.1.5 -* is-finite: 1.0.2 -* is-fullwidth-code-point: 2.0.0 -* is-my-ip-valid: 1.0.0 -* is-promise: 2.1.0 -* is-regexp: 1.0.0 -* is-resolvable: 1.1.0 -* isexe: 2.0.0 -* js-base64: 2.4.3 -* jsonify: 0.0.0 -* jsonpointer: 4.0.1 -* known-css-properties: 0.3.0 -* lcid: 1.0.0 -* levn: 0.3.0 -* lodash.capitalize: 4.2.1 -* lodash.kebabcase: 4.1.1 -* macos-release: 2.3.0 -* make-dir: 1.3.0 -* map-age-cleaner: 0.1.3 -* merge: 1.2.0 -* mimic-fn: 1.2.0 -* minizlib: 1.2.1 -* node-gyp: 3.8.0 -* bootstrap-sass: 3.3.6 -* bootswatch: 3.3.7 -* compass-mixins: 0.12.10 -* cpr: 3.0.1 -* lerna: 3.16.4 -* node-sass: 4.12.0 -* npm: 6.11.3 -* react: 16.8.6 -* react-dom: 16.8.6 -* graceful-fs: 4.1.11 -* minimist: 1.2.0 -* mkdirp: 0.5.1 -* rimraf: 2.6.2 -* : octokit/request-error -* import-local: 2.0.0 -* npmlog: 0 -* dedent: 0.7.0 -* npm-package-arg: 6.1.0 -* p-map: 2.1.0 -* semver: 2 -* glob: 7.1.2 -* safe-buffer: 5.1.2 -* bluebird: 3.7.1 -* cacache: 12.0.3 -* chownr: 1.1.3 -* figgy-pudding: 3.5.1 -* get-stream: 4.1.0 -* infer-owner: 1.0.4 -* lru-cache: 4.1.5 -* make-fetch-happen: 5.0.1 -* minimatch: 3.0.4 -* minipass: 2.9.0 -* mississippi: 3.0.0 -* normalize-package-data: 2.5.0 -* npm-packlist: 1.4.4 -* npm-pick-manifest: 3.0.0 -* osenv: 0 -* promise-inflight: 1.0.1 -* promise-retry: 1.1.1 -* protoduck: 5.0.1 -* ssri: 6.0.1 -* tar: 4.4.10 -* unique-filename: 1.1.1 -* which: 1.3.1 -* fs.realpath: 1.0.0 -* inflight: 1.0.6 -* inherits: 2.0.3 -* once: 1.3.0 -* path-is-absolute: 1.0.0 -* move-concurrently: 1.0.1 -* y18n: 4.0.0 -* aproba: 2.0.0 -* copy-concurrently: 1.0.5 -* fs-write-stream-atomic: 1.0.10 -* run-queue: 1.0.0 -* iferr: 0.1.5 -* imurmurhash: 0.1.4 -* readable-stream: 3.4.0 -* pump: 3.0.0 -* yallist: 3.0.0 -* agentkeepalive: 3.5.2 -* http-cache-semantics: 3.8.1 -* http-proxy-agent: 2.1.0 -* https-proxy-agent: 2.2.3 -* node-fetch-npm: 2.0.2 -* socks-proxy-agent: 4.0.0 -* humanize-ms: 1.2.1 -* ms: 2.0.0 -* agent-base: 4.3.0 -* debug: 2.6.9 -* es6-promisify: 5.0.0 -* es6-promise: 4.2.8 -* encoding: 0.1.12 -* json-parse-better-errors: 1.0.2 -* iconv-lite: 0.4.24 -* concat-stream: 2.0.0 -* duplexify: 3.7.1 -* end-of-stream: 1.4.4 -* flush-write-stream: 1.1.1 -* from2: 2.3.0 -* parallel-transform: 1.1.0 -* pumpify: 1.3.3 -* stream-each: 1.1.0 -* through2: 2.0.0 -* buffer-from: 1.1.1 -* typedarray: 0.0.6 -* stream-shift: 1.0.0 -* core-util-is: 1.0.2 -* isarray: 1.0.0 -* process-nextick-args: 2.0.0 -* string_decoder: 1.1.1 -* util-deprecate: 1.0.1 -* is-ci: 1.1.0 -* execa: 1.0.0 -* lodash: 4.17.15 -* ci-info: 2.0.0 -* globby: 9.2.0 -* cosmiconfig: 5.2.1 -* dot-prop: 3.0.0 -* glob-parent: 3.1.0 -* load-json-file: 1.1.0 -* resolve-from: 4.0.0 -* write-json-file: 3.2.0 -* dir-glob: 2.2.2 -* array-union: 1.0.2 -* fast-glob: 2.2.7 -* pify: 2.3.0 -* slash: 1.0.0 -* path-type: 1.1.0 -* js-yaml: 3.13.1 -* import-fresh: 2.0.0 -* is-directory: 0.3.1 -* parse-json: 2.2.0 -* argparse: 1.0.10 -* esprima: 4.0.1 -* sprintf-js: 1.0.3 -* caller-callsite: 2.0.0 -* callsites: 2.0.0 -* is-obj: 1.0.1 -* is-glob: 3.1.0 -* strip-bom: 2.0.0 -* type-fest: 0.3.0 -* write-file-atomic: 2.3.0 -* cross-spawn: 3.0.1 -* is-stream: 1.1.0 -* npm-run-path: 2.0.0 -* p-finally: 1.0.0 -* signal-exit: 3.0.0 -* strip-eof: 1.0.0 -* nice-try: 1.0.5 -* path-key: 2.0.1 -* shebang-command: 1.2.0 -* multimatch: 3.0.0 -* array-differ: 2.1.0 -* arrify: 1.0.1 -* config-chain: 1.1.12 -* ini: 1.3.5 -* proto-list: 1.2.1 -* get-port: 4.2.0 -* p-map-series: 1.0.0 -* p-waterfall: 1.0.0 -* read-package-tree: 5.1.6 -* array-uniq: 1.0.3 -* fs-extra: 8.1.0 -* write-pkg: 3.1.0 -* path-exists: 2.1.0 -* npm-lifecycle: 3.1.2 -* is-windows: 1.0.2 -* mkdirp-promise: 5.0.1 -* mz: 2.7.0 -* any-promise: 1.3.0 -* object-assign: 4.0.1 -* thenify-all: 1.0.0 -* read-cmd-shim: 1.0.1 -* chalk: 1.1.3 -* columnify: 1.5.4 -* strip-ansi: 3.0.0 -* wcwidth: 1.0.0 -* inquirer: 6.5.2 -* ansi-escapes: 3.2.0 -* cli-cursor: 2.1.0 -* cli-width: 2.2.0 -* external-editor: 3.1.0 -* rxjs: 6.5.3 -* string-width: 2.1.1 -* mute-stream: 0.0.7 -* run-async: 2.2.0 -* through: >=2.2.7 -* restore-cursor: 2.0.0 -* chardet: 0.7.0 -* tmp: 0.0.33 -* safer-buffer: >= -* escape-string-regexp: 1.0.5 -* tslib: 1.9.0 -* ansi-regex: 2.1.1 -* yargs: 11.0.0 -* yargs-parser: 11.1.1 -* cliui: 4.1.0 -* decamelize: 1.2.0 -* get-caller-file: 1.0.2 -* os-locale: 2.1.0 -* require-directory: 2.1.1 -* require-main-filename: 1.0.1 -* set-blocking: 2.0.0 -* which-module: 2.0.0 -* locate-path: 3.0.0 -* p-locate: 3.0.0 -* p-limit: 2.2.1 -* p-try: 2.2.0 -* camelcase: 2.1.1 -* wrap-ansi: 2.0.0 -* whatwg-url: 7.1.0 -* init-package-json: 1.10.3 -* p-reduce: 1.0.0 -* validate-npm-package-license: 3.0.3 -* validate-npm-package-name: 3.0.0 -* strong-log-transformer: 2.0.0 -* merge2: 1.3.0 -* micromatch: 3.1.10 -* call-me-maybe: 1.0.1 -* glob-to-regexp: 0.3.0 -* path-dirname: 1.0.0 -* is-extglob: 2.1.1 -* arr-diff: 4.0.0 -* array-unique: 0.3.2 -* braces: 2.3.2 -* define-property: 2.0.2 -* extend-shallow: 3.0.2 -* extglob: 2.0.4 -* fragment-cache: 0.2.1 -* kind-of: 6.0.2 -* nanomatch: 1.2.13 -* object.pick: 1.3.0 -* regex-not: 1.0.0 -* snapdragon: 0.8.1 -* to-regex: 3.0.1 -* arr-flatten: 1.1.0 -* fill-range: 4.0.0 -* isobject: 4.0.0 -* repeat-element: 1.1.2 -* snapdragon-node: 2.0.1 -* split-string: 3.0.2 -* is-extendable: 0.1.1 -* is-number: 3.0.0 -* repeat-string: 1.6.1 -* to-regex-range: 2.1.0 -* is-buffer: 1.1.6 -* is-descriptor: 1.0.2 -* is-accessor-descriptor: 1.0.0 -* is-data-descriptor: 1.0.0 -* assign-symbols: 1.0.0 -* is-plain-object: 3.0.0 -* expand-brackets: 2.1.4 -* posix-character-classes: 0.1.0 -* map-cache: 0.2.2 -* lodash.sortby: 4.7.0 -* tr46: 1.0.1 -* webidl-conversions: 4.0.2 -* jsonfile: 4.0.0 -* universalify: 0.1.0 -* promzard: 0.3.0 -* read: 1.0.1 -* read-package-json: 2.0.13 -* p-queue: 4.0.0 -* p-pipe: 1.2.0 -* JSONStream: 1.3.5 -* jsonparse: 1.3.1 -* byte-size: 5.0.1 -* has-unicode: 2.0.1 -* lodash.clonedeep: 4.5.0 -* temp-write: 3.4.0 -* conventional-changelog-angular: 5.0.5 -* conventional-changelog-core: 3.2.3 -* conventional-recommended-bump: 5.0.1 -* lodash.template: 4.5.0 -* compare-func: 1.3.2 -* q: 1.5.1 -* array-ify: 1.0.0 -* conventional-changelog-writer: 4.0.9 -* conventional-commits-parser: 3.0.5 -* dateformat: 3.0.3 -* get-pkg-repo: 1.4.0 -* git-raw-commits: 2.0.0 -* git-remote-origin-url: 2.0.0 -* git-semver-tags: 2.0.3 -* read-pkg: 1.1.0 -* read-pkg-up: 1.0.1 -* split: 1.0.1 -* conventional-commits-filter: 2.0.2 -* handlebars: 4.4.5 -* json-stringify-safe: 5.0.1 -* meow: 3.7.0 -* neo-async: 2.6.1 -* optimist: 0.6.1 -* source-map: 0.6.1 -* uglify-js: 3.1.4 -* is-text-path: 2.0.0 -* split2: 2.0.0 -* trim-off-newlines: 1.0.0 -* text-extensions: 2.0.0 -* hosted-git-info: 2.6.0 -* parse-github-repo-url: 1.3.0 -* camelcase-keys: 2.1.0 -* map-obj: 1.0.1 -* redent: 1.0.0 -* trim-newlines: 1.0.0 -* loud-rejection: 1.6.0 -* pinkie-promise: 2.0.0 -* error-ex: 1.3.2 -* is-utf8: 0.2.1 -* strip-indent: 1.0.1 -* repeating: 2.0.0 -* get-stdin: 4.0.1 -* dargs: 4.1.0 -* number-is-nan: 1.0.0 -* gitconfiglocal: 1.0.0 -* conventional-changelog-preset-loader: 2.2.0 -* lodash.ismatch: 4.4.0 -* modify-values: 1.0.1 -* decamelize-keys: 1.1.0 -* minimist-options: 3.0.2 -* quick-lru: 1.0.0 -* is-plain-obj: 1.1.0 -* lodash._reinterpolate: 3.0.0 -* lodash.templatesettings: 4.2.0 -* git-url-parse: 11.1.2 -* atob-lite: 2.0.0 -* before-after-hook: 2.1.0 -* btoa-lite: 1.0.0 -* deprecation: 2.3.1 -* lodash.get: 4.4.2 -* lodash.set: 4.3.2 -* lodash.uniq: 4.5.0 -* octokit-pagination-methods: 1.1.0 -* universal-user-agent: 4.0.0 -* node-fetch: 2.6.0 -* git-up: 4.0.1 -* is-ssh: 1.3.1 -* parse-url: 5.0.0 -* protocols: 1.1.0 -* ansi-styles: 2.2.1 -* supports-color: 2.0.0 -* color-convert: 1.9.3 -* color-name: 1.1.3 -* brace-expansion: 1.1.11 -* balanced-match: 1.0.0 -* concat-map: 0.0.1 -* pkg-dir: 3.0.0 -* resolve-cwd: 2.0.0 -* async-foreach: 0.1.3 -* gaze: 1.1.2 -* in-publish: 2.0.0 -* nan: 2.14.0 -* request: 2.88.0 -* sass-graph: 2.2.4 -* stdout-stream: 1.4.0 -* true-case-path: 1.0.2 -* globule: 1.2.0 -* has-ansi: 2.0.0 -* pseudomap: 1.0.2 -* wrappy: 1 -* currently-unhandled: 0.4.1 -* array-find-index: 1.0.2 -* is-arrayish: 0.2.1 -* resolve: 1.10.0 -* fstream: 1.0.12 -* nopt: 3.0.6 -* block-stream: 0.0.9 -* abbrev: 1.1.1 -* aws-sign2: 0.7.0 -* aws4: 1.8.0 -* caseless: 0.12.0 -* combined-stream: 1.0.8 -* extend: 3.0.2 -* forever-agent: 0.6.1 -* form-data: 2.3.3 -* http-signature: 1.2.0 -* is-typedarray: 1.0.0 -* isstream: 0.1.2 -* mime-types: 2.1.18 -* har-validator: 5.1.3 -* qs: 6.5.2 -* uuid: 3.3.2 -* oauth-sign: 0.9.0 -* performance-now: 2.1.0 -* tough-cookie: 2.4.3 -* tunnel-agent: 0.6.0 -* delayed-stream: 1.0.0 -* asynckit: 0.4.0 -* assert-plus: 1.0.0 -* jsprim: 1.4.1 -* sshpk: 1.7.0 -* extsprintf: 1.3.0 -* json-schema: 0.2.3 -* verror: 1.10.0 -* mime-db: 1.33.0 -* ajv: 6.10.2 -* har-schema: 2.0.0 -* fast-deep-equal: 2.0.1 -* fast-json-stable-stringify: 2.0.0 -* json-schema-traverse: 0.4.1 -* uri-js: 4.2.2 -* retry: 0.12.0 -* sha: 3.0.0 -* slide: 1.1.3 -* sorted-object: 2.0.1 -* sorted-union-stream: 2.1.3 -* stringify-package: 1.0.0 -* text-table: 0.2.0 -* tiny-relative-date: 1.3.0 -* uid-number: 0.0.6 -* umask: 1.1.0 -* unpipe: 1.0.0 -* update-notifier: 2.3.0 -* worker-farm: 1.6.0 -* boxen: 1.3.0 -* configstore: 3.1.2 -* crypto-random-string: 1.0.0 -* errno: 0.1.7 -* has-flag: 3.0.0 -* import-lazy: 2.1.0 -* is-installed-globally: 0.1.0 -* is-npm: 1.0.0 -* latest-version: 3.1.0 -* object.getownpropertydescriptors: 2.0.3 -* prepend-http: 1.0.4 -* psl: 1.1.29 -* punycode: 1.4.1 -* spdx-correct: 3.0.0 -* spdx-expression-parse: 3.0.0 -* wide-align: 1.1.0 -* split-on-first: 1.0.0 -* strict-uri-encode: 2.0.0 -* util-extend: 1.0.1 -* util-promisify: 2.1.0 +* `amdefine: 1.0.1` +* `are-we-there-yet: 1.1.5` +* `asn1: 0.2.4` +* `atob: 2.1.2` +* `base: 0.11.2` +* `bcrypt-pbkdf: 1.0.2` +* `builtins: 1.0.3` +* `byline: 5.0.0` +* `caller-path: 2.0.0` +* `co: 4.6.0` +* `code-point-at: 1.1.0` +* `copy-descriptor: 0.1.1` +* `cyclist: 1.0.1` +* `dashdash: 1.14.1` +* `debuglog: 1.0.1` +* `decode-uri-component: 0.2.0` +* `deep-is: 0.1.3` +* `defaults: 1.0.3` +* `define-properties: 1.1.3` +* `dependency-tree: 7.0.2` +* `detect-indent: 5.0.0` +* `detective-amd: 3.0.0` +* `detective-cjs: 3.1.1` +* `detective-es6: 2.1.0` +* `detective-less: 1.0.2` +* `detective-postcss: 3.0.1` +* `detective-sass: 3.0.1` +* `detective-scss: 2.0.1` +* `detective-stylus: 1.0.0` +* `detective-typescript: 5.6.1` +* `dezalgo: 1.0.3` +* `doctrine: 1.5.0` +* `duplexer: 0.1.1` +* `ecc-jsbn: 0.1.2` +* `err-code: 1.1.2` +* `es-abstract: 1.16.0` +* `es6-set: 0.1.5` +* `es6-weak-map: 2.0.3` +* `espree: 3.5.4` +* `esrecurse: 4.2.1` +* `exit-hook: 1.1.1` +* `fast-levenshtein: 2.0.6` +* `figures: 2.0.0` +* `find-up: 2.1.0` +* `flat-cache: 1.3.0` +* `flatten: 1.0.2` +* `front-matter: 2.1.2` +* `fs-minipass: 1.2.6` +* `gauge: 2.7.4` +* `generate-function: 2.3.1` +* `generate-object-property: 1.2.0` +* `genfun: 5.0.0` +* `get-own-enumerable-property-symbols: 3.0.1` +* `getpass: 0.1.7` +* `gonzales-pe-sl: 4.2.3` +* `ignore: 4.0.6` +* `ignore-walk: 3.0.3` +* `indent-string: 2.1.0` +* `indexes-of: 1.0.1` +* `ip: 1.1.5` +* `is-finite: 1.0.2` +* `is-fullwidth-code-point: 2.0.0` +* `is-my-ip-valid: 1.0.0` +* `is-promise: 2.1.0` +* `is-regexp: 1.0.0` +* `is-resolvable: 1.1.0` +* `isexe: 2.0.0` +* `js-base64: 2.4.3` +* `jsonify: 0.0.0` +* `jsonpointer: 4.0.1` +* `known-css-properties: 0.3.0` +* `lcid: 1.0.0` +* `levn: 0.3.0` +* `lodash.capitalize: 4.2.1` +* `lodash.kebabcase: 4.1.1` +* `macos-release: 2.3.0` +* `make-dir: 1.3.0` +* `map-age-cleaner: 0.1.3` +* `merge: 1.2.0` +* `mimic-fn: 1.2.0` +* `minizlib: 1.2.1` +* `node-gyp: 3.8.0` +* `bootstrap-sass: 3.3.6` +* `bootswatch: 3.3.7` +* `compass-mixins: 0.12.10` +* `cpr: 3.0.1` +* `lerna: 3.16.4` +* `node-sass: 4.12.0` +* `npm: 6.11.3` +* `react: 16.8.6` +* `react-dom: 16.8.6` +* `graceful-fs: 4.1.11` +* `minimist: 1.2.0` +* `mkdirp: 0.5.1` +* `rimraf: 2.6.2` +* `: octokit/request-error` +* `import-local: 2.0.0` +* `npmlog: 0` +* `dedent: 0.7.0` +* `npm-package-arg: 6.1.0` +* `p-map: 2.1.0` +* `semver: 2` +* `glob: 7.1.2` +* `safe-buffer: 5.1.2` +* `bluebird: 3.7.1` +* `cacache: 12.0.3` +* `chownr: 1.1.3` +* `figgy-pudding: 3.5.1` +* `get-stream: 4.1.0` +* `infer-owner: 1.0.4` +* `lru-cache: 4.1.5` +* `make-fetch-happen: 5.0.1` +* `minimatch: 3.0.4` +* `minipass: 2.9.0` +* `mississippi: 3.0.0` +* `normalize-package-data: 2.5.0` +* `npm-packlist: 1.4.4` +* `npm-pick-manifest: 3.0.0` +* `osenv: 0` +* `promise-inflight: 1.0.1` +* `promise-retry: 1.1.1` +* `protoduck: 5.0.1` +* `ssri: 6.0.1` +* `tar: 4.4.10` +* `unique-filename: 1.1.1` +* `which: 1.3.1` +* `fs.realpath: 1.0.0` +* `inflight: 1.0.6` +* `inherits: 2.0.3` +* `once: 1.3.0` +* `path-is-absolute: 1.0.0` +* `move-concurrently: 1.0.1` +* `y18n: 4.0.0` +* `aproba: 2.0.0` +* `copy-concurrently: 1.0.5` +* `fs-write-stream-atomic: 1.0.10` +* `run-queue: 1.0.0` +* `iferr: 0.1.5` +* `imurmurhash: 0.1.4` +* `readable-stream: 3.4.0` +* `pump: 3.0.0` +* `yallist: 3.0.0` +* `agentkeepalive: 3.5.2` +* `http-cache-semantics: 3.8.1` +* `http-proxy-agent: 2.1.0` +* `https-proxy-agent: 2.2.3` +* `node-fetch-npm: 2.0.2` +* `socks-proxy-agent: 4.0.0` +* `humanize-ms: 1.2.1` +* `ms: 2.0.0` +* `agent-base: 4.3.0` +* `debug: 2.6.9` +* `es6-promisify: 5.0.0` +* `es6-promise: 4.2.8` +* `encoding: 0.1.12` +* `json-parse-better-errors: 1.0.2` +* `iconv-lite: 0.4.24` +* `concat-stream: 2.0.0` +* `duplexify: 3.7.1` +* `end-of-stream: 1.4.4` +* `flush-write-stream: 1.1.1` +* `from2: 2.3.0` +* `parallel-transform: 1.1.0` +* `pumpify: 1.3.3` +* `stream-each: 1.1.0` +* `through2: 2.0.0` +* `buffer-from: 1.1.1` +* `typedarray: 0.0.6` +* `stream-shift: 1.0.0` +* `core-util-is: 1.0.2` +* `isarray: 1.0.0` +* `process-nextick-args: 2.0.0` +* `string_decoder: 1.1.1` +* `util-deprecate: 1.0.1` +* `is-ci: 1.1.0` +* `execa: 1.0.0` +* `lodash: 4.17.15` +* `ci-info: 2.0.0` +* `globby: 9.2.0` +* `cosmiconfig: 5.2.1` +* `dot-prop: 3.0.0` +* `glob-parent: 3.1.0` +* `load-json-file: 1.1.0` +* `resolve-from: 4.0.0` +* `write-json-file: 3.2.0` +* `dir-glob: 2.2.2` +* `array-union: 1.0.2` +* `fast-glob: 2.2.7` +* `pify: 2.3.0` +* `slash: 1.0.0` +* `path-type: 1.1.0` +* `js-yaml: 3.13.1` +* `import-fresh: 2.0.0` +* `is-directory: 0.3.1` +* `parse-json: 2.2.0` +* `argparse: 1.0.10` +* `esprima: 4.0.1` +* `sprintf-js: 1.0.3` +* `caller-callsite: 2.0.0` +* `callsites: 2.0.0` +* `is-obj: 1.0.1` +* `is-glob: 3.1.0` +* `strip-bom: 2.0.0` +* `type-fest: 0.3.0` +* `write-file-atomic: 2.3.0` +* `cross-spawn: 3.0.1` +* `is-stream: 1.1.0` +* `npm-run-path: 2.0.0` +* `p-finally: 1.0.0` +* `signal-exit: 3.0.0` +* `strip-eof: 1.0.0` +* `nice-try: 1.0.5` +* `path-key: 2.0.1` +* `shebang-command: 1.2.0` +* `multimatch: 3.0.0` +* `array-differ: 2.1.0` +* `arrify: 1.0.1` +* `config-chain: 1.1.12` +* `ini: 1.3.5` +* `proto-list: 1.2.1` +* `get-port: 4.2.0` +* `p-map-series: 1.0.0` +* `p-waterfall: 1.0.0` +* `read-package-tree: 5.1.6` +* `array-uniq: 1.0.3` +* `fs-extra: 8.1.0` +* `write-pkg: 3.1.0` +* `path-exists: 2.1.0` +* `npm-lifecycle: 3.1.2` +* `is-windows: 1.0.2` +* `mkdirp-promise: 5.0.1` +* `mz: 2.7.0` +* `any-promise: 1.3.0` +* `object-assign: 4.0.1` +* `thenify-all: 1.0.0` +* `read-cmd-shim: 1.0.1` +* `chalk: 1.1.3` +* `columnify: 1.5.4` +* `strip-ansi: 3.0.0` +* `wcwidth: 1.0.0` +* `inquirer: 6.5.2` +* `ansi-escapes: 3.2.0` +* `cli-cursor: 2.1.0` +* `cli-width: 2.2.0` +* `external-editor: 3.1.0` +* `rxjs: 6.5.3` +* `string-width: 2.1.1` +* `mute-stream: 0.0.7` +* `run-async: 2.2.0` +* `through: >=2.2.7` +* `restore-cursor: 2.0.0` +* `chardet: 0.7.0` +* `tmp: 0.0.33` +* `safer-buffer: >=` +* `escape-string-regexp: 1.0.5` +* `tslib: 1.9.0` +* `ansi-regex: 2.1.1` +* `yargs: 11.0.0` +* `yargs-parser: 11.1.1` +* `cliui: 4.1.0` +* `decamelize: 1.2.0` +* `get-caller-file: 1.0.2` +* `os-locale: 2.1.0` +* `require-directory: 2.1.1` +* `require-main-filename: 1.0.1` +* `set-blocking: 2.0.0` +* `which-module: 2.0.0` +* `locate-path: 3.0.0` +* `p-locate: 3.0.0` +* `p-limit: 2.2.1` +* `p-try: 2.2.0` +* `camelcase: 2.1.1` +* `wrap-ansi: 2.0.0` +* `whatwg-url: 7.1.0` +* `init-package-json: 1.10.3` +* `p-reduce: 1.0.0` +* `validate-npm-package-license: 3.0.3` +* `validate-npm-package-name: 3.0.0` +* `strong-log-transformer: 2.0.0` +* `merge2: 1.3.0` +* `micromatch: 3.1.10` +* `call-me-maybe: 1.0.1` +* `glob-to-regexp: 0.3.0` +* `path-dirname: 1.0.0` +* `is-extglob: 2.1.1` +* `arr-diff: 4.0.0` +* `array-unique: 0.3.2` +* `braces: 2.3.2` +* `define-property: 2.0.2` +* `extend-shallow: 3.0.2` +* `extglob: 2.0.4` +* `fragment-cache: 0.2.1` +* `kind-of: 6.0.2` +* `nanomatch: 1.2.13` +* `object.pick: 1.3.0` +* `regex-not: 1.0.0` +* `snapdragon: 0.8.1` +* `to-regex: 3.0.1` +* `arr-flatten: 1.1.0` +* `fill-range: 4.0.0` +* `isobject: 4.0.0` +* `repeat-element: 1.1.2` +* `snapdragon-node: 2.0.1` +* `split-string: 3.0.2` +* `is-extendable: 0.1.1` +* `is-number: 3.0.0` +* `repeat-string: 1.6.1` +* `to-regex-range: 2.1.0` +* `is-buffer: 1.1.6` +* `is-descriptor: 1.0.2` +* `is-accessor-descriptor: 1.0.0` +* `is-data-descriptor: 1.0.0` +* `assign-symbols: 1.0.0` +* `is-plain-object: 3.0.0` +* `expand-brackets: 2.1.4` +* `posix-character-classes: 0.1.0` +* `map-cache: 0.2.2` +* `lodash.sortby: 4.7.0` +* `tr46: 1.0.1` +* `webidl-conversions: 4.0.2` +* `jsonfile: 4.0.0` +* `universalify: 0.1.0` +* `promzard: 0.3.0` +* `read: 1.0.1` +* `read-package-json: 2.0.13` +* `p-queue: 4.0.0` +* `p-pipe: 1.2.0` +* `JSONStream: 1.3.5` +* `jsonparse: 1.3.1` +* `byte-size: 5.0.1` +* `has-unicode: 2.0.1` +* `lodash.clonedeep: 4.5.0` +* `temp-write: 3.4.0` +* `conventional-changelog-angular: 5.0.5` +* `conventional-changelog-core: 3.2.3` +* `conventional-recommended-bump: 5.0.1` +* `lodash.template: 4.5.0` +* `compare-func: 1.3.2` +* `q: 1.5.1` +* `array-ify: 1.0.0` +* `conventional-changelog-writer: 4.0.9` +* `conventional-commits-parser: 3.0.5` +* `dateformat: 3.0.3` +* `get-pkg-repo: 1.4.0` +* `git-raw-commits: 2.0.0` +* `git-remote-origin-url: 2.0.0` +* `git-semver-tags: 2.0.3` +* `read-pkg: 1.1.0` +* `read-pkg-up: 1.0.1` +* `split: 1.0.1` +* `conventional-commits-filter: 2.0.2` +* `handlebars: 4.4.5` +* `json-stringify-safe: 5.0.1` +* `meow: 3.7.0` +* `neo-async: 2.6.1` +* `optimist: 0.6.1` +* `source-map: 0.6.1` +* `uglify-js: 3.1.4` +* `is-text-path: 2.0.0` +* `split2: 2.0.0` +* `trim-off-newlines: 1.0.0` +* `text-extensions: 2.0.0` +* `hosted-git-info: 2.6.0` +* `parse-github-repo-url: 1.3.0` +* `camelcase-keys: 2.1.0` +* `map-obj: 1.0.1` +* `redent: 1.0.0` +* `trim-newlines: 1.0.0` +* `loud-rejection: 1.6.0` +* `pinkie-promise: 2.0.0` +* `error-ex: 1.3.2` +* `is-utf8: 0.2.1` +* `strip-indent: 1.0.1` +* `repeating: 2.0.0` +* `get-stdin: 4.0.1` +* `dargs: 4.1.0` +* `number-is-nan: 1.0.0` +* `gitconfiglocal: 1.0.0` +* `conventional-changelog-preset-loader: 2.2.0` +* `lodash.ismatch: 4.4.0` +* `modify-values: 1.0.1` +* `decamelize-keys: 1.1.0` +* `minimist-options: 3.0.2` +* `quick-lru: 1.0.0` +* `is-plain-obj: 1.1.0` +* `lodash._reinterpolate: 3.0.0` +* `lodash.templatesettings: 4.2.0` +* `git-url-parse: 11.1.2` +* `atob-lite: 2.0.0` +* `before-after-hook: 2.1.0` +* `btoa-lite: 1.0.0` +* `deprecation: 2.3.1` +* `lodash.get: 4.4.2` +* `lodash.set: 4.3.2` +* `lodash.uniq: 4.5.0` +* `octokit-pagination-methods: 1.1.0` +* `universal-user-agent: 4.0.0` +* `node-fetch: 2.6.0` +* `git-up: 4.0.1` +* `is-ssh: 1.3.1` +* `parse-url: 5.0.0` +* `protocols: 1.1.0` +* `ansi-styles: 2.2.1` +* `supports-color: 2.0.0` +* `color-convert: 1.9.3` +* `color-name: 1.1.3` +* `brace-expansion: 1.1.11` +* `balanced-match: 1.0.0` +* `concat-map: 0.0.1` +* `pkg-dir: 3.0.0` +* `resolve-cwd: 2.0.0` +* `async-foreach: 0.1.3` +* `gaze: 1.1.2` +* `in-publish: 2.0.0` +* `nan: 2.14.0` +* `request: 2.88.0` +* `sass-graph: 2.2.4` +* `stdout-stream: 1.4.0` +* `true-case-path: 1.0.2` +* `globule: 1.2.0` +* `has-ansi: 2.0.0` +* `pseudomap: 1.0.2` +* `wrappy: 1` +* `currently-unhandled: 0.4.1` +* `array-find-index: 1.0.2` +* `is-arrayish: 0.2.1` +* `resolve: 1.10.0` +* `fstream: 1.0.12` +* `nopt: 3.0.6` +* `block-stream: 0.0.9` +* `abbrev: 1.1.1` +* `aws-sign2: 0.7.0` +* `aws4: 1.8.0` +* `caseless: 0.12.0` +* `combined-stream: 1.0.8` +* `extend: 3.0.2` +* `forever-agent: 0.6.1` +* `form-data: 2.3.3` +* `http-signature: 1.2.0` +* `is-typedarray: 1.0.0` +* `isstream: 0.1.2` +* `mime-types: 2.1.18` +* `har-validator: 5.1.3` +* `qs: 6.5.2` +* `uuid: 3.3.2` +* `oauth-sign: 0.9.0` +* `performance-now: 2.1.0` +* `tough-cookie: 2.4.3` +* `tunnel-agent: 0.6.0` +* `delayed-stream: 1.0.0` +* `asynckit: 0.4.0` +* `assert-plus: 1.0.0` +* `jsprim: 1.4.1` +* `sshpk: 1.7.0` +* `extsprintf: 1.3.0` +* `json-schema: 0.2.3` +* `verror: 1.10.0` +* `mime-db: 1.33.0` +* `ajv: 6.10.2` +* `har-schema: 2.0.0` +* `fast-deep-equal: 2.0.1` +* `fast-json-stable-stringify: 2.0.0` +* `json-schema-traverse: 0.4.1` +* `uri-js: 4.2.2` +* `retry: 0.12.0` +* `sha: 3.0.0` +* `slide: 1.1.3` +* `sorted-object: 2.0.1` +* `sorted-union-stream: 2.1.3` +* `stringify-package: 1.0.0` +* `text-table: 0.2.0` +* `tiny-relative-date: 1.3.0` +* `uid-number: 0.0.6` +* `umask: 1.1.0` +* `unpipe: 1.0.0` +* `update-notifier: 2.3.0` +* `worker-farm: 1.6.0` +* `boxen: 1.3.0` +* `configstore: 3.1.2` +* `crypto-random-string: 1.0.0` +* `errno: 0.1.7` +* `has-flag: 3.0.0` +* `import-lazy: 2.1.0` +* `is-installed-globally: 0.1.0` +* `is-npm: 1.0.0` +* `latest-version: 3.1.0` +* `object.getownpropertydescriptors: 2.0.3` +* `prepend-http: 1.0.4` +* `psl: 1.1.29` +* `punycode: 1.4.1` +* `spdx-correct: 3.0.0` +* `spdx-expression-parse: 3.0.0` +* `wide-align: 1.1.0` +* `split-on-first: 1.0.0` +* `strict-uri-encode: 2.0.0` +* `util-extend: 1.0.1` +* `util-promisify: 2.1.0` diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/AdminConfigPolicy.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/AdminConfigPolicy.adoc index 5b81e9b2a57d..c80ac9c777a6 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/AdminConfigPolicy.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/AdminConfigPolicy.adoc @@ -19,7 +19,7 @@ |Feature and App Permissions |featurePolicies |String -|When enabled, the desired features or apps will only be modifiable and viewable to users with the set attributes. +|When enabled, the desired features or apps are only modifiable and viewable to users with the set attributes. The entry should be the format of: `feature name/app name = "user attribute name=user attribute value"` | |false @@ -27,7 +27,7 @@ The entry should be the format of: `feature name/app name = "user attribute name |Configuration Permissions |servicePolicies |String -|When enabled, the desired service will only be modifiable and viewable to users with the set attributes. +|When enabled, the desired service is only modifiable and viewable to users with the set attributes. The entry should be the format of: `configuration ID = "user attribute name=user attribute value"` |null |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/CachingFederationStrategy.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/CachingFederationStrategy.adoc index f0d38b336ecd..95fa1258feba 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/CachingFederationStrategy.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/CachingFederationStrategy.adoc @@ -19,7 +19,7 @@ |Maximum start index |maxStartIndex |Integer -|Sets a limit on the number of results this sorted federation strategy can handle from each federated source. A large start index in conjunction with several federated sources could yield a large result set, which the sorted federation strategy has a limited ability to do. The admin can make a rough calculation to decide what maximum start index to use based on the amount of memory in the system, the amount of federated sources, the number of threads, and the expected amount of query results requested ( (average # of threads) * (maximum # of federated sources) * (maxStartIndex + maximumQueryResults) ) must fit into the allocated memory of the running distribution. This field will be removed when sorted federation strategy has the ability to sort a larger amount of results. +|Sets a limit on the number of results this sorted federation strategy can handle from each federated source. A large start index in conjunction with several federated sources could yield a large result set, which the sorted federation strategy has a limited ability to do. The admin can make a rough calculation to decide what maximum start index to use based on the amount of memory in the system, the amount of federated sources, the number of threads, and the expected amount of query results requested ( (average # of threads) * (maximum # of federated sources) * (maxStartIndex + maximumQueryResults) ) must fit into the allocated memory of the running distribution. This field may be deprecated and removed when sorted federation strategy has the ability to sort a larger amount of results. |50000 |true @@ -33,7 +33,7 @@ |Expiration Age |expirationAgeInMinutes |Long -|The number of minutes a document will remain in the cache before it will expire. Default is 7 days. +|The number of minutes a document remains in the cache before it expires . Default is 7 days. |10080 |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/CatalogBackupPlugin.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/CatalogBackupPlugin.adoc index 88ecddb74939..f71273c8b519 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/CatalogBackupPlugin.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/CatalogBackupPlugin.adoc @@ -26,7 +26,7 @@ |Subdirectory levels |subDirLevels |Integer -|Number of subdirectory levels to create. Two characters from the ID will be used to name each subdirectory level. +|Number of subdirectory levels to create. Two characters from the ID are used to name each subdirectory level. |2 |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/CatalogFrameworkImpl.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/CatalogFrameworkImpl.adoc index b26c29bd5c71..47c9b86489d2 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/CatalogFrameworkImpl.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/CatalogFrameworkImpl.adoc @@ -34,7 +34,7 @@ |Fanout tag blacklist |fanoutTagBlacklist |String -|Ingest operations with tags in this list will be rejected. +|Ingest operations with tags in this list are rejected. | |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/Claims_Handler_Manager.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/Claims_Handler_Manager.adoc index 0342d3a0dfd7..f3bd7541eb11 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/Claims_Handler_Manager.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/Claims_Handler_Manager.adoc @@ -67,7 +67,7 @@ |Override User Certificate DN |overrideCertDn |Boolean -|When checked, this setting will ignore the DN of a user and instead use the LDAP Base User DN value. +|When checked, this setting ignores the DN of a user and instead uses the LDAP Base User DN value. |`false` |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/Confluence_Federated_Source.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/Confluence_Federated_Source.adoc index 67f378d24c16..9c2a6435f20f 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/Confluence_Federated_Source.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/Confluence_Federated_Source.adoc @@ -74,14 +74,14 @@ |Confluence Spaces |confluenceSpaces |String cardinality=1000 -|The confluence spaces to include/exclude from searches. If no spaces are specified, all visible spaces will be searched. +|The confluence spaces to include/exclude from searches. If no spaces are specified, all visible spaces are searched. | |No |Attribute Overrides |additionalAttributes |String cardinality=100 -|Attribute Overrides - Optional: Metacard attribute overrides (Key-Value pairs) that can be set on the results comming from this source. If an attribute is specified here, it will overwrite the metacard’s attribute that was created from the Confluence source. The format should be 'key=value'. The maximum allowed size of an attribute override is 65,535 bytes. All attributes in the <<{metadata-prefix}catalog_taxonomy_definitions, catalog taxonomy tables>> are injected into all metacards by default and can be overridden. +|Attribute Overrides - Optional: Metacard attribute overrides (Key-Value pairs) that can be set on the results comming from this source. If an attribute is specified here, it overwrites the metacard’s attribute that was created from the Confluence source. The format should be 'key=value'. The maximum allowed size of an attribute override is 65,535 bytes. All attributes in the <<{metadata-prefix}catalog_taxonomy_definitions, catalog taxonomy tables>> are injected into all metacards by default and can be overridden. | |No diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/ContentDirectoryMonitor.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/ContentDirectoryMonitor.adoc index 45f0b97725dc..f00a81ba6acb 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/ContentDirectoryMonitor.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/ContentDirectoryMonitor.adoc @@ -26,7 +26,7 @@ |Maximum Concurrent Files |numThreads |Integer -|Specifies the maximum number of concurrent files to be processed within a directory (maximum of 8). If this number exceeds 8, 8 will be used in order to preserve system resources. Make sure that your system has enough memory to support the number of concurrent processing threads across all directory monitors. +|Specifies the maximum number of concurrent files to be processed within a directory (maximum of 8). If this number exceeds 8, 8 is used in order to preserve system resources. Make sure that your system has enough memory to support the number of concurrent processing threads across all directory monitors. |1 |true @@ -40,14 +40,14 @@ |Processing Mechanism |processingMechanism |String -|Choose what happens to the content item after it is ingested. Delete will remove the original file after storing it in the content store. Move will store the item in the content store, and a copy under ./ingested, then remove the original file. (NOTE: this will double the amount of disk space used.) Monitor in place will index the file and serve it from its original location. If in place is used, then the URLResourceReader root resource directories configuration must be updated to allow downloading from the monitored directory (See <<{developing-prefix}url_resource_reader, URL Resource Reader>>). +|Choose what happens to the content item after it is ingested. Delete removes the original file after storing it in the content store. Move stores the item in the content store, and a copy under ./ingested, then removes the original file. (NOTE: this doubles the amount of disk space used.) Monitor in place indexes the file and serves it from its original location. If in place is used, then the URLResourceReader root resource directories configuration must be updated to allow downloading from the monitored directory (See <<{developing-prefix}url_resource_reader, URL Resource Reader>>). |in_place |false |Attribute Overrides |attributeOverrides |String -|Optional: Metacard attribute overrides (Key-Value pairs) that can be set on the content monitor. If an attribute is specified here, it will overwrite the metacard's attribute that was created from the content directory. The format should be 'key=value'. The maximum allowed size of an attribute override is 65,535 bytes. All attributes in the <<{metadata-prefix}catalog_taxonomy_definitions, catalog taxonomy tables>> are injected into all metacards by default and can be overridden. +|Optional: Metacard attribute overrides (Key-Value pairs) that can be set on the content monitor. If an attribute is specified here, it overwrited the metacard's attribute that was created from the content directory. The format should be 'key=value'. The maximum allowed size of an attribute override is 65,535 bytes. All attributes in the <<{metadata-prefix}catalog_taxonomy_definitions, catalog taxonomy tables>> are injected into all metacards by default and can be overridden. |null |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/ContentFileSystemStorageProvider.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/ContentFileSystemStorageProvider.adoc index 8f2262f70e91..eea0ef43517c 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/ContentFileSystemStorageProvider.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/ContentFileSystemStorageProvider.adoc @@ -19,7 +19,7 @@ |Content Repository File Path |baseContentDirectory |String -|Specifies the directory to use for the content repository. A shutdown of the server is necessary for this property to take effect. If a filepath is provided with directories that don't exist, File System Provider will attempt to create them. +|Specifies the directory to use for the content repository. A shutdown of the server is necessary for this property to take effect. If a filepath is provided with directories that don't exist, File System Provider attempts to create them. |${home_directory}/data/content/store |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/FacetWhitelist.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/FacetWhitelist.adoc index 6239ce8d8dde..3f1fd0ca481b 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/FacetWhitelist.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/FacetWhitelist.adoc @@ -20,8 +20,8 @@ |facetAttributeWhitelist |String |Attributes that can be faceted against through the catalog framework. -Caution: Suggestion values are not protected by any security. Only choose attributes whose values will be safe for all users to view. +Caution: Suggestion values are not protected by any security. Only choose attributes whose values are safe for all users to view. | |false -|=== \ No newline at end of file +|=== diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/GuestInterceptor.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/GuestInterceptor.adoc index 5a66dcb3bcc8..a71e4e176ddb 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/GuestInterceptor.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/GuestInterceptor.adoc @@ -19,7 +19,7 @@ |Deny Guest Access |guestAccessDenied |Boolean -|If set to true, no guest access will be allowed via this guest interceptor. If set to false, this interceptor will generate guest tokens for incoming requests that lack a WS-Security header. +|If set to true, no guest access is allowed via this guest interceptor. If set to false, this interceptor generates guest tokens for incoming requests that lack a WS-Security header. |false |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/IdpMetadata.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/IdpMetadata.adoc index d3695cb776f9..f76eea25701c 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/IdpMetadata.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/IdpMetadata.adoc @@ -24,7 +24,7 @@ |Perform User-Agent Check |userAgentCheck |Boolean -|If selected, this will allow clients that do not support ECP and are not browsers to fall back to PKI, BASIC, and potentially GUEST authentication, if enabled. +|If selected, this allows clients that do not support ECP and are not browsers to fall back to PKI, BASIC, and potentially GUEST authentication, if enabled. |true |=== diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/KmlEndpoint.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/KmlEndpoint.adoc index 4aabec2a3387..ffcf06b797e7 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/KmlEndpoint.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/KmlEndpoint.adoc @@ -19,7 +19,7 @@ |Style Document |styleUrl |String -|KML Document containing custom styling. This will be served up by the KmlEndpoint. (for example, \file:///path/to/kml/style/doc.kml) +|KML Document containing custom styling. This is served up by the KmlEndpoint. (for example, \file:///path/to/kml/style/doc.kml) | |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/LogoutRequestService.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/LogoutRequestService.adoc index 565f876fab34..b4e4cb3ba9f8 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/LogoutRequestService.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/LogoutRequestService.adoc @@ -18,7 +18,7 @@ |Logout Page Time Out |logOutPageTimeOut |Long -|This is the time limit that the SAML client will wait for a user to click log out on the logout page. Any requests that take longer than this time for the user to submit will be rejected."/> +|This is the time limit that the SAML client waits for a user to click log out on the logout page. Any requests that take longer than this time for the user to submit are rejected."/> |3600000 |=== diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/MetacardAttributePlugin.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/MetacardAttributePlugin.adoc index e17e808c1710..12b302fbfba4 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/MetacardAttributePlugin.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/MetacardAttributePlugin.adoc @@ -29,7 +29,7 @@ The strategy for combining the values is intersection, which means only the values common to all source attribute are added to the destination attribute. Note: Do not use the same destination attributes in both the Intersect and Union - rule sets. The plugin will behave unpredictably. + rule sets. The plugin behaves unpredictably. |none |false @@ -46,7 +46,7 @@ The strategy for combining the values is union, which means only all the values of the source attribute are added to the destination attribute (excluding duplicates) Note: Do not use the same destination attributes in both the Intersect and Union - rule sets. The plugin will behave unpredictably. + rule sets. The plugin behaves unpredictably. |none |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/MetacardIngestNetworkPlugin.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/MetacardIngestNetworkPlugin.adoc index 5979cd864068..662a572d6534 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/MetacardIngestNetworkPlugin.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/MetacardIngestNetworkPlugin.adoc @@ -19,7 +19,7 @@ |Criteria |criteriaKey |String -|Specifies the criteria for the test of equality; which value will be tested? IP Address? Hostname? +|Specifies the criteria for the test of equality; which value is tested? IP Address? Hostname? |remoteAddr |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/MetacardValidityFilterPlugin.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/MetacardValidityFilterPlugin.adoc index a8cd4bb8edda..3597e2144156 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/MetacardValidityFilterPlugin.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/MetacardValidityFilterPlugin.adoc @@ -19,7 +19,7 @@ |Attribute map |attributeMap |String -|Mapping of Metacard SECURITY attribute to user attribute. Users with this role will always receive metacards with errors and/or warnings. +|Mapping of Metacard SECURITY attribute to user attribute. Users with this role always receive metacards with errors and/or warnings. |invalid-state=localhost-data-manager |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/MetacardValidityMarkerPlugin.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/MetacardValidityMarkerPlugin.adoc index 19ce65a7c3ad..d2a766589199 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/MetacardValidityMarkerPlugin.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/MetacardValidityMarkerPlugin.adoc @@ -19,7 +19,7 @@ |Enforced Validators |enforcedMetacardValidators |String -|ID of Metacard Validator to enforce. Metacards that fail these validators will NOT be ingested. +|ID of Metacard Validator to enforce. Metacards that fail these validators are NOT ingested. |false |Enforce errors diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/PdfInputTransformer.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/PdfInputTransformer.adoc index df519beab6f6..35b627ff3b98 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/PdfInputTransformer.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/PdfInputTransformer.adoc @@ -14,7 +14,7 @@ |Use PDF Title |usePdfTitleAsTitle |Boolean -|Use the PDF's metadata to determine the metacard title. If this is not enabled, the metacard title will be the file name. +|Use the PDF's metadata to determine the metacard title. If this is not enabled, the metacard title is the file name. |false |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/PolicyManager.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/PolicyManager.adoc index fc1f86cdcb09..60ede5dd9dfe 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/PolicyManager.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/PolicyManager.adoc @@ -19,7 +19,7 @@ |Context Traversal Depth |traversalDepth |Integer -|Depth to which paths will be traversed. Any value greater than 500 will be set to 500. +|Depth to which paths are traversed. Any value greater than 500 is set to 500. |20 |true @@ -61,7 +61,7 @@ |White Listed Contexts |whiteListContexts |String -|List of contexts that will not use security. Note that sub-contexts to ones listed here will also skip security, unless authentication types are provided for it. For example: if /foo is listed here, then /foo/bar will also not require any sort of authentication. However, if /foo is listed and /foo/bar has authentication types provided in the 'Authentication Types' field, then that more specific policy will be used. +|List of contexts that do not use security. Note that sub-contexts to ones listed here also skip security, unless authentication types are provided for it. For example: if /foo is listed here, then /foo/bar also does not require any sort of authentication. However, if /foo is listed and /foo/bar has authentication types provided in the 'Authentication Types' field, then that more specific policy is used. |${variable-prefix}org.codice.ddf.system.rootContext}/SecurityTokenService,${variable-prefix}org.codice.ddf.system.rootContext}/internal/metrics,/proxy,${variable-prefix}org.codice.ddf.system.rootContext}/saml,${variable-prefix}org.codice.ddf.system.rootContext}/idp,/idp,${variable-prefix}org.codice.ddf.system.rootContext}/platform/config/ui,/logout |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/ReliableResourceDownload.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/ReliableResourceDownload.adoc index 670b86e72d8a..1a5e1ada930c 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/ReliableResourceDownload.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/ReliableResourceDownload.adoc @@ -18,10 +18,10 @@ |Product Cache Directory |productCacheDirectory |String -|Directory where retrieved products will be cached for faster, future retrieval. +|Directory where retrieved products are cached for faster, future retrieval. If a directory path is specified with directories that do not exist, -Product Download feature will attempt to create those directories. -Without configuration, the product cache directory is ${home_directory}/data/product-cache. If a relative path is provided it will be relative to the ${home_directory}. It is recommended to enter an absolute directory path such as /opt/product-cache in Linux or C:\product-cache in Windows. +Product Download feature attempts to create those directories. +Without configuration, the product cache directory is ${home_directory}/data/product-cache. If a relative path is provided it must be relative to the ${home_directory}. It is recommended to enter an absolute directory path such as /opt/product-cache in Linux or C:\product-cache in Windows. | |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/Session.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/Session.adoc index 01a7ac314b0a..9a03782c35b3 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/Session.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/Session.adoc @@ -19,7 +19,7 @@ |Session Timeout (in minutes) |expirationTime |Integer -|Specifies the length of inactivity (in minutes) between client requests before the servlet container will invalidate the session (this applies to all client sessions). +|Specifies the length of inactivity (in minutes) between client requests before the servlet container invalidates the session (this applies to all client sessions). This value must be 2 minutes or greater, as users are warned when only 1 minute remains. If a value of less than 2 minutes is used, the timeout is set to the default time of 31 minutes. See also <<_ddf.platform.ui.config,Platform UI Config>>. diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/TikaInputTransformer.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/TikaInputTransformer.adoc index 67b155a56789..39aec7fe43db 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/TikaInputTransformer.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/TikaInputTransformer.adoc @@ -19,7 +19,7 @@ |Use Resource Title |useResourceTitleAsTitle |Boolean -|Use the resource's metadata to determine the metacard title. If this is not enabled, the metacard title will be the file name. +|Use the resource's metadata to determine the metacard title. If this is not enabled, the metacard title is the file name. |false |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/TransformerDescriptors.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/TransformerDescriptors.adoc index 33d0822175e8..29a6897a3a85 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/TransformerDescriptors.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/TransformerDescriptors.adoc @@ -19,15 +19,15 @@ |Metacard Transformer Blacklist |blackListedMetacardTransformerIds |String -|The IDs of all Metacard Transformers services that will not show up as export actions in the UI. Every ID in this set will remove that transformer as an export option in the UI. +|The IDs of all Metacard Transformers services that do not show up as export actions in the UI. Every ID in this set removes that transformer as an export option in the UI. |[] |false |Query Response Transformer Blacklist |blackListedQueryResponseTransformerIds |String -|The IDs of all Query Response Transformers services that will not show up as export actions in the UI. Every ID in this set will remove that transformer as an export option in the UI. +|The IDs of all Query Response Transformers services that do not show up as export actions in the UI. Every ID in this set removes that transformer as an export option in the UI. |[`zipCompression`] |false -|=== \ No newline at end of file +|=== diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v1_1_0_Federated_Source.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v1_1_0_Federated_Source.adoc index 9aede244b6ee..367634f15120 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v1_1_0_Federated_Source.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v1_1_0_Federated_Source.adoc @@ -75,7 +75,7 @@ |Non Queryable Properties |nonQueryableProperties |String -|Properties listed here will NOT be queryable and any attempt to filter on these properties will result in an exception. +|Properties listed here are NOT queryable and any attempt to filter on these properties results in an exception. |null |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v2_0_0_Connected_Source.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v2_0_0_Connected_Source.adoc index ffa0b448af2d..eb85163a8edd 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v2_0_0_Connected_Source.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v2_0_0_Connected_Source.adoc @@ -47,7 +47,7 @@ |Disable Sorting |disableSorting |Boolean -|When selected, the system will not specify sort criteria with the query. This should only be used if the remote source is unable to handle sorting even when the capabilities states 'ImplementsSorting' is supported. +|When selected, the system does not specify sort criteria with the query. This should only be used if the remote source is unable to handle sorting even when the capabilities states 'ImplementsSorting' is supported. |false |true @@ -75,7 +75,7 @@ |Non Queryable Properties |nonQueryableProperties |String -|Properties listed here will NOT be queryable and any attempt to filter on these properties will result in an exception. +|Properties listed here are NOT queryable and any attempt to filter on these properties results in an exception. |null |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v2_0_0_Federated_Source.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v2_0_0_Federated_Source.adoc index 54105f7a252a..88a2335cacf4 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v2_0_0_Federated_Source.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/Wfs_v2_0_0_Federated_Source.adoc @@ -54,7 +54,7 @@ |Disable Sorting |disableSorting |Boolean -|When selected, the system will not specify sort criteria with the query. This should only be used if the remote source is unable to handle sorting even when the capabilities states 'ImplementsSorting' is supported. +|When selected, the system does not specify sort criteria with the query. This should only be used if the remote source is unable to handle sorting even when the capabilities states 'ImplementsSorting' is supported. |false |true @@ -82,7 +82,7 @@ |Non Queryable Properties |nonQueryableProperties |String -|Properties listed here will NOT be queryable and any attempt to filter on these properties will result in an exception. +|Properties listed here are NOT queryable and any attempt to filter on these properties results in an exception. |null |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/WorkspaceQueryService.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/WorkspaceQueryService.adoc index 64045f4e296f..371387396093 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/WorkspaceQueryService.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/WorkspaceQueryService.adoc @@ -27,7 +27,7 @@ |queryTimeInterval |Integer |Set the Relative Time Search (past X minutes up to 24 hours). -Note: This will query for results from the interval to the time the query is sent out. +Note: This queries for results from the interval to the time the query is sent out. |1440 |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/XmlAttributePlugin.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/XmlAttributePlugin.adoc index f2fefbe65a4f..74fa5ff8ec1f 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/XmlAttributePlugin.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/XmlAttributePlugin.adoc @@ -19,21 +19,21 @@ |XML Elements: |xmlElements |String -|XML elements within the metadata that will be searched for security attributes. If these elements contain matching attributes, the values of the attributes will be combined. +|XML elements within the metadata that are searched for security attributes. If these elements contain matching attributes, the values of the attributes are combined. | |true |Security Attributes (union): |securityAttributeUnions |String -|Security Attributes. These attributes, if they exist on any of the XML elements listed above, will have their values extracted and the union of all of the values will be saved to the metacard. For example: if element1 and element2 both contain the attribute 'attr' and that attribute has values X,Y and X,Z, respectively, then the final result will be the union of those values: X,Y,Z. The X,Y,Z value will be the value that is placed within the security attribute on the metacard. +|Security Attributes. These attributes, if they exist on any of the XML elements listed above, have their values extracted and the union of all of the values is saved to the metacard. For example: if element1 and element2 both contain the attribute 'attr' and that attribute has values X,Y and X,Z, respectively, then the final result is the union of those values: X,Y,Z. The X,Y,Z value is the value that is placed within the security attribute on the metacard. | |false |Security Attributes (intersection): |securityAttributeIntersections |String -|Security Attributes. These attributes, if they exist on any of the XML elements listed above, will have their values extracted and the intersection of all of the values will be saved to the metacard. For example: if element1 and element2 both contain the attribute 'attr' and that attribute has values X,Y and X,Z, respectively, then the final result will be the intersection of those values: X. The X value will be the value that is placed within the security attribute on the metacard. +|Security Attributes. These attributes, if they exist on any of the XML elements listed above, have their values extracted and the intersection of all of the values is saved to the metacard. For example: if element1 and element2 both contain the attribute 'attr' and that attribute has values X,Y and X,Z, respectively, then the final result is the intersection of those values: X. The X value is the value that is placed within the security attribute on the metacard. |null |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/admin.ui.configuration.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/admin.ui.configuration.adoc index 6501252d02cc..14324bde6534 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/admin.ui.configuration.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/admin.ui.configuration.adoc @@ -40,14 +40,14 @@ |Show System Usage Message once per session |systemUsageOncePerSession |Boolean -|With this selected,the system usage message will be shown once for each browser session. Uncheck this to have the usage message appear every time the admin page is opened or refreshed. +|With this selected,the system usage message is shown once for each browser session. Uncheck this to have the usage message appear every time the admin page is opened or refreshed. |true |true |Ignored Installer Applications |disabledInstallerApps |String -|Comma delimited list (appName, appName2, ...appNameN) of applications that will be disabled in the installer. +|Comma delimited list (appName, appName2, ...appNameN) of applications that are disabled in the installer. |admin-app,platform-app |null diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/ddf.catalog.transformer.input.pdf.PdfInputTransformer.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/ddf.catalog.transformer.input.pdf.PdfInputTransformer.adoc index a5051e39b442..8a865b564bda 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/ddf.catalog.transformer.input.pdf.PdfInputTransformer.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/ddf.catalog.transformer.input.pdf.PdfInputTransformer.adoc @@ -20,7 +20,7 @@ |Use PDF Title |usePdfTitleAsTitle |Boolean -|Use the PDF's metadata to determine the metacard title. If this is not enabled, the metacard title will be the file name. +|Use the PDF's metadata to determine the metacard title. If this is not enabled, the metacard title is the file name. |false |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/landingpage.properties.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/landingpage.properties.adoc index 704b9f206801..615347114223 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/landingpage.properties.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/landingpage.properties.adoc @@ -47,7 +47,7 @@ |Announcements |announcements |String -|Announcements that will be displayed on the landing page. +|Announcements to display on the landing page. |null |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/org.codice.ddf.transformer.preview.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/org.codice.ddf.transformer.preview.adoc index 482e22007e7d..21420ec90f47 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/org.codice.ddf.transformer.preview.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/org.codice.ddf.transformer.preview.adoc @@ -27,7 +27,7 @@ |Element Names to Preview |previewElements |String -|Specify element names to preview from XML. Will take the text content of the first available element for preview. Note: This list will not be used unless Preview From Metadata is enabled. +|Specify element names to preview from XML. Takes the text content of the first available element for preview. Note: This list is not used unless Preview From Metadata is enabled. |text,TEXT |true -|=== \ No newline at end of file +|=== diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/platform.ui.config.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/platform.ui.config.adoc index 92518b508af4..b87b534fd8e9 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/platform.ui.config.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/platform.ui.config.adoc @@ -40,7 +40,7 @@ |Show System Usage Message once per session |systemUsageOncePerSession |Boolean -|With this selected, the system usage message will be shown once for each browser session. Uncheck this to have the usage message appear every time the search window is opened or refreshed. +|With this selected, the system usage message is shown once for each browser session. Uncheck this to have the usage message appear every time the search window is opened or refreshed. |true |true @@ -75,7 +75,7 @@ |Session Timeout |timeout |Integer -|Specifies the length of inactivity (in minutes) that will cause a user to be logged out automatically. This value must be 2 minutes or greater, as users are warned when only 1 minute remains. If a value of less than 2 minutes is used, the timeout is set to the default time of 15 minutes. +|Specifies the length of inactivity (in minutes) that causes a user to be logged out automatically. This value must be 2 minutes or greater, as users are warned when only 1 minute remains. If a value of less than 2 minutes is used, the timeout is set to the default time of 15 minutes. |15 |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/scheduler.Command.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/scheduler.Command.adoc index e6860a3bef00..c9c0c305b227 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/scheduler.Command.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/scheduler.Command.adoc @@ -26,7 +26,7 @@ |Interval |intervalString |String -|The Interval String for each execution. Based on the Interval Type, this will either be a Cron String or a Second Interval. (e.x. '0 0 0 1/1 * ? *' or '12') +|The Interval String for each execution. Based on the Interval Type, this can be either a Cron String or a Second Interval. (e.x. '0 0 0 1/1 * ? *' or '12') | |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/service.SecurityManager.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/service.SecurityManager.adoc index 0f39e1c9e122..4321a0de6b88 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/service.SecurityManager.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/service.SecurityManager.adoc @@ -19,7 +19,7 @@ |SAML NameID Policy |usernameAttributeList |String -|List of attributes that are considered for replacing the username of the logged in user. If any of these attributes match any of the attributes within the SecurityAssertion, the value of the first matching attribute will be used as the username. (Does not apply when NameIDFormat is of the following: X509, persistent, kerberos or unspecified, and the username is not empty). +|List of attributes that are considered for replacing the username of the logged in user. If any of these attributes match any of the attributes within the SecurityAssertion, the value of the first matching attribute is used as the username. (Does not apply when NameIDFormat is of the following: X509, persistent, kerberos or unspecified, and the username is not empty). |http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier, uid |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/sts.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/sts.adoc index 72fe6c40b7c9..60efd9f0c309 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/sts.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/sts.adoc @@ -19,7 +19,7 @@ |SAML Assertion Lifetime |lifetime |Long -|Set the number of seconds that an issued SAML assertion will be good for. +|Set the number of seconds that an issued SAML assertion is valid. |1800 |true diff --git a/distribution/docs/src/main/resources/content/_using/using-simple-search-ui.adoc b/distribution/docs/src/main/resources/content/_using/using-simple-search-ui.adoc index c7b042456f85..7445af32f103 100644 --- a/distribution/docs/src/main/resources/content/_using/using-simple-search-ui.adoc +++ b/distribution/docs/src/main/resources/content/_using/using-simple-search-ui.adoc @@ -19,7 +19,7 @@ It also allows the user to select the sources to search and the number of result Enter one or more of the available search criteria to execute a query: -Keyword Search:: A text box allowing the user to enter a textual query. This supports the use of (*) wildcards. If blank, the query will contain a contextual component. +Keyword Search:: A text box allowing the user to enter a textual query. This supports the use of (*) wildcards. If blank, the query contains a contextual component. Temporal Query:: Select from *any*, *relative*, or *absolute*. Selecting *Any* results in no temporal restrictions on the query, selecting *relative* allows the user to query a period from some length of time in the past until now, and selecting *absolute* allows the user to specify a *start* and *stop* date range. Spatial Search:: Select from *any*, *point-radius*, and *bounding box*. Selecting *Any* results in no spatial restrictions on the query, selecting *point-radius* allows the user to specify a *lat/lon* and *radius* to search, and selecting a *bounding box* allows the user to specify an *eastern*, *western*, *southern*, and *northern* boundary to search within. Type Search:: Select from *any*, or a specific type. Selecting *Any* results in no type restrictions on the query, and Selecting *Specific Types* shows a list of known content types on the federation, and allows the user to select a specific type to search for. @@ -32,7 +32,7 @@ The table of results shows the details of the results found, as well as a link t ===== Results Summary -Total Results:: Total Number of Results available for this query. If there are more results than the number displayed per page then a page navigation links will appear to the right. +Total Results:: Total Number of Results available for this query. If there are more results than the number displayed per page then a page navigation link appears to the right. Pages:: Provides page navigation, which generate queries for requesting additional pages of results. ===== Results Table @@ -40,7 +40,7 @@ Pages:: Provides page navigation, which generate queries for requesting addition The Results table provides a preview of and links to the results. The table consists of these columns: -Title:: Displays title of the metacard. This will be a link which can clicked to view the metacard in the Metacard View. +Title:: Displays title of the metacard. This is a link which can clicked to view the metacard in the Metacard View. Source:: Displays where the metadata came from, which could be the local provider or a federated source. Location:: Displays the WKT Location of the metacard, if available. Time:: Shows the Received (Created) and Effective times of the metacard, if available.