CMR OPeNDAP 1.0.0-SNAPSHOT
Released under the Apache License, Version 2.0
OPeNDAP/CMR Integration.
Installation
To install, add the following dependency to your project or build file:
[gov.nasa.earthdata/cmr-opendap "1.0.0-SNAPSHOT"]
Topics
Namespaces
cmr.opendap.app.handler.cache
This namespace defines the handlers for the cache REST API resources.
Public variables and functions:
cmr.opendap.app.handler.collection
This namespace defines the REST API handlers for collection resources.
Public variables and functions:
cmr.opendap.app.handler.core
This namespace defines the handlers for general resources.
Public variables and functions:
cmr.opendap.app.middleware
Custom ring middleware for CMR OPeNDAP.
cmr.opendap.app.routes.rest.v1
This namespace defines the Version 1 REST routes provided by this service.
cmr.opendap.app.routes.rest.v2
This namespace defines the Version 2 REST routes provided by this service.
cmr.opendap.app.routes.site
This namespace defines the REST routes provided by this service.
cmr.opendap.auth.acls
This namespace is provided for common code needed by the roles and permissions namespaces.
Public variables and functions:
cmr.opendap.auth.core
This namespace represents the authorization API for CMR OPeNDAP. This is where the rest of the application goes when it needs to perform checks on roles or permissions for a given user and/or concept.
Public variables and functions:
cmr.opendap.auth.permissions
Permissions for CMR OPeNDAP are utilized in the application routes when it is necessary to limit access to resources based on the specific capabilities granted to a user.
Public variables and functions:
cmr.opendap.auth.roles
Roles for CMR OPeNDAP are utilized in the application routes when it is necessary to limit access to resources based on the role of a user.
Public variables and functions:
cmr.opendap.auth.token
The functions in this API are responsible for such things as making queries to CMR Access Control to get token-to-user mappings, extracting tokens from request headers, and defining caching keys and related tasks.
Public variables and functions:
cmr.opendap.components.config
Documentation forthcoming
Public variables and functions:
- api-version
- api-version-dotted
- cache-dumpfile
- cache-init
- cache-lru-threshold
- cache-ttl-ms
- cache-type
- cmr-base-url
- cmr-max-pagesize
- create-component
- default-content-type
- get-access-control-url
- get-echo-rest-url
- get-ingest-url
- get-opendap-url
- get-search-url
- get-service
- get-service-url
- http-assets
- http-docs
- http-index-dirs
- http-port
- http-replace-base-url
- http-rest-docs-base-url-template
- http-rest-docs-outdir
- http-rest-docs-source
- http-skip-static
- lifecycle-behaviour
- log-color?
- log-level
- log-nss
- opendap-base-url
- opendap-url
- start
- stop
- streaming-heartbeat
- streaming-timeout
- vendor
cmr.opendap.components.testing.config
A component system setup namespace for use in testing.
Public variables and functions:
cmr.opendap.components.testing.system
A component system setup namespace for use in testing.
Public variables and functions:
cmr.opendap.const
Documentation forthcoming
cmr.opendap.errors
Documentation forthcoming
Public variables and functions:
- any-auth-errors?
- any-client-errors?
- any-erred?
- any-server-errors?
- auth-error-code
- check
- client-error-code
- collect
- default-error-code
- empty-gnl-data-file-url
- empty-gnl-data-files
- empty-query-string
- empty-svc-pattern
- erred?
- get-errors
- granule-metadata
- invalid-lat-params
- invalid-lon-params
- invalid-parameter
- no-matching-service-pattern
- no-permissions
- not-implemented
- problem-granules
- problem-processing-level
- server-error-code
- service-metadata
- status-code
- status-map
- token-required
- unsupported
- unsupported-processing-level
- variable-metadata
cmr.opendap.http.response
This namespace defines a default set of transform functions suitable for use in presenting results to HTTP clients.
cmr.opendap.ous.collection
Documentation forthcoming
cmr.opendap.ous.query.params.core
This namespace defines records for the accepted URL query parameters or, if using HTTP POST, keys in a JSON payload. Additionall, functions for working with these parameters are defined here.
Public variables and functions:
cmr.opendap.ous.util.geog
Documentation forthcoming
cmr.opendap.ous.variable
Documentation forthcoming
Public variables and functions:
- async-get-metadata
- build-query
- create-opendap-bounds
- create-opendap-lookup
- create-opendap-lookup-reversed
- default-dim-stride
- default-lat-lon-stride
- extract-bounding-info
- extract-bounds
- extract-dimensions
- extract-metadata
- format-opendap-bounds
- format-opendap-dim
- format-opendap-dim-lat
- format-opendap-dim-lon
- format-opendap-dims
- format-opendap-lat-lon
- get-lat-lon-format-str
- get-metadata
- lat-reversed-datasets
- lat-reversed?
- normalize-lat-lon
- parse-annotated-bounds
- parse-bounds
- parse-cmr-bounds
- parse-lat-lon
- replace-defaults-lat-lon
cmr.opendap.site.data
The functions of this namespace are specifically responsible for generating data structures to be consumed by site page templates.
Public variables and functions:
cmr.opendap.site.pages
The functions of this namespace are specifically responsible for returning ready-to-serve pages.
Public variables and functions:
cmr.opendap.site.static
The functions of this namespace are specifically responsible for generating the static resources of the top-level and site pages and sitemaps.
Public variables and functions:
cmr.opendap.testing.config
Documentation forthcoming
cmr.opendap.testing.system
Documentation forthcoming