opencadc_registry_client v0.2.0 OpencadcRegistryClient

IVOA compliant Registry client to lookup service URL endpoints.

Link to this section Summary

Functions

Lookup the URL that can be used to obtain the Capabilities ASCII document. Specify the REGISTRY_ENDPOINT_HOST environment variable as http(s)://myhost.com or leave the default to use the CADC’s Production host address. This assumes that the host will support the /reg/resource-caps endpoint

Lookup the Service URL to be used to issue requests to. This function will navigate the Capabilities XML document and pull the appropriate public (non-secure) service URL

Lookup the Service URL to be used to issue requests to. This function will navigate the Capabilities XML document and pull the appropriate public secure service URL. The

Link to this section Functions

Link to this function lookup_capabilities_url(resource_url)

Lookup the URL that can be used to obtain the Capabilities ASCII document. Specify the REGISTRY_ENDPOINT_HOST environment variable as http(s)://myhost.com or leave the default to use the CADC’s Production host address. This assumes that the host will support the /reg/resource-caps endpoint.

Capability XML document specification here: http://www.ivoa.net/xml/VOSICapabilities/v1.0 Sample CADC document containing Capabilities URLs: http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/resource-caps

Returns a string URL.

## Examples

iex> OpencadcRegistryClient.lookup_capabilities_url("ivo://cadc.nrc.ca/vospace")
"http://www.canfar.phys.uvic.ca/vospace/capabilities"

@param resource_url The Resource URI to use to lookup the URL.

Link to this function lookup_service_url(resource_url, standard_url, xsi_type)

Lookup the Service URL to be used to issue requests to. This function will navigate the Capabilities XML document and pull the appropriate public (non-secure) service URL.

Capability XML document specification here: http://www.ivoa.net/xml/VOSICapabilities/v1.0 Sample CADC document containing Capabilities URLs: http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/resource-caps

Returns a string URL.

## Examples

iex> OpencadcRegistryClient.lookup_service_url("ivo://cadc.nrc.ca/vospace", "ivo://ivoa.net/std/VOSpace/v2.0#nodes", "vs:ParamHTTP")
"http://www.canfar.phys.uvic.ca/vospace/nodes"

@param resource_url The Resource URI to use to lookup the Capabilities URL. @param standard_url The Standard URI identified on the capability. @param xsi_type The XSI value used in the capability’s interface attribute.

Link to this function lookup_service_url(resource_url, standard_url, xsi_type, security_uri)

Lookup the Service URL to be used to issue requests to. This function will navigate the Capabilities XML document and pull the appropriate public secure service URL. The

Capability XML document specification here: http://www.ivoa.net/xml/VOSICapabilities/v1.0 Sample CADC document containing Capabilities URLs: http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/resource-caps

Returns a string URL.

## Examples

iex> OpencadcRegistryClient.lookup_service_url("ivo://cadc.nrc.ca/vospace", "ivo://ivoa.net/std/VOSpace/v2.0#nodes", "vs:ParamHTTP", "ivo://ivoa.net/sso#tls-with-certificate")
"https://www.canfar.phys.uvic.ca/vospace/nodes"

@param resource_url The Resource URI to use to lookup the Capabilities URL. @param standard_url The Standard URI identified on the capability. @param xsi_type The XSI value used in the capability’s interface attribute. @param security_uri The URI identifying what kind of security to use. Valid values are