::: header

SSC R2.4 Web Services API

Generated by IDLdoc

:::

Overview Directory File Source [attach.png] {align=“top”} Etc Categories Search Index Help User documentation

single page{target=“_top”} | use frames{target=“_top”} summary class fields routine details file attributes

::: content

./

spdfrest__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class represents the remotely callable interface to NASA’s Space Physics Data Facility (SPDF) RESTful Web services. ::: :::

Author information

Author

: B. Harris

: Copyright (c) 2013-2021 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

::: class-description

Class description for SpdfRest

Subclasses: SpdfSsc

Properties

Properties in SpdfRest

::: details

sslVerifyPeer [init ]{.smaller}

userAgent [init ]{.smaller}

:
::: :::

::: class-description

Class description for SpdfSsc

Inheritance

SpdfRest

Properties

:::

Routines

Methods inherited from SpdfRest

Routines from spdfrest__define.pro

[result]{.var} = SpdfRest::init([endpoint]{.argument}[, version]{.argument}[, currentVersionUrl]{.argument}[ [, userAgent=[string]{.var}]]{.argument}[ [, sslVerifyPeer=[int]{.var}]]{.argument})

: Creates an object representing the SPDF Web service.

SpdfRest::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfRest::getDefaultSslVerifyPeer()

: Gets the default value for the IDLnetURL SSL_VERIFY_PEER property based upon the runtime version of IDL.

[result]{.var} = SpdfRest::getEndpoint()

: Gets the current endpoint value.

[result]{.var} = SpdfRest::getUserAgent()

: Gets the current userAgent value.

[result]{.var} = SpdfSsc::getDefaultDataview()

: Gets the current defaultDataview value.

[result]{.var} = SpdfSsc::getVersion()

: Gets the version of this class.

[result]{.var} = SpdfSsc::getCurrentVersion()

: Gets the most up to date version of this class.

[result]{.var} = SpdfSsc::isUpToDate()

: Compares getVersion() and getCurrentVersion() to determine if this class is up to date.

SpdfRest__define

: Defines the SpdfRest class.

::: {#routine-details}

Routine details

::: {#SpdfRest::init .routine-details .details}

top{.top} source{.top} SpdfRest::init[]{.routine-attributes}

[result]{.var} = SpdfRest::init([endpoint]{.argument}[, version]{.argument}[, currentVersionUrl]{.argument}[[,userAgent=[string]{.var}]]{.argument}[[,sslVerifyPeer=[int]{.var}]]{.argument})

Creates an object representing the SPDF Web service. If access to the Internet is through an HTTP proxy, the caller should ensure that the HTTP_PROXY environment variable is correctly set before this method is called. The HTTP_PROXY value should be of the form http://username:password@hostname:port/. NOTE: Due to support for the HTTP_PROXY environment variable, this class should not be used in a CGI-like environment where HTTP_PROXY can be set by untrusted entities (see httpoxy vulnerability).

Return value

::: small a reference to a SSC object. :::

Parameters

endpoint [in type=string ]{.smaller}

: URL of SPDF web service.

version [in type=string ]{.smaller}

: class version.

currentVersionUrl [in type=string ]{.smaller}

: URL to the file identifying the most up to date version of this class.

Keywords

userAgent [in optional type=string default=SscWs]{.smaller}

: HTTP user-agent value used in communications with SPDF.

sslVerifyPeer [in optional type=int default=1]{.smaller}

: Specifies whether the authenticity of the peer’s SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains. :::

::: {#SpdfRest::cleanup .routine-details .details}

top{.top} source{.top} SpdfRest::cleanup[]{.routine-attributes}

SpdfRest::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfRest::getDefaultSslVerifyPeer .routine-details .details}

top{.top} source{.top} SpdfRest::getDefaultSslVerifyPeer[]{.routine-attributes}

[result]{.var} = SpdfRest::getDefaultSslVerifyPeer()

Gets the default value for the IDLnetURL SSL_VERIFY_PEER property based upon the runtime version of IDL.

Return value

::: small 0 if runtime version of IDL cannot verify new SSL certificates. Otherwise, 1. ::: :::

::: {#SpdfRest::getEndpoint .routine-details .details}

top{.top} source{.top} SpdfRest::getEndpoint[]{.routine-attributes}

[result]{.var} = SpdfRest::getEndpoint()

Gets the current endpoint value.

Return value

::: small current endpoint string value. ::: :::

::: {#SpdfRest::getUserAgent .routine-details .details}

top{.top} source{.top} SpdfRest::getUserAgent[]{.routine-attributes}

[result]{.var} = SpdfRest::getUserAgent()

Gets the current userAgent value.

Return value

::: small current userAgent string value. ::: :::

::: {#SpdfSsc::getDefaultDataview .routine-details .details}

top{.top} source{.top} SpdfSsc::getDefaultDataview[]{.routine-attributes}

[result]{.var} = SpdfSsc::getDefaultDataview()

Gets the current defaultDataview value.

Return value

::: small current defaultDataview string value. ::: :::

::: {#SpdfSsc::getVersion .routine-details .details}

top{.top} source{.top} SpdfSsc::getVersion[]{.routine-attributes}

[result]{.var} = SpdfSsc::getVersion()

Gets the version of this class.

Return value

::: small version of this class. ::: :::

::: {#SpdfSsc::getCurrentVersion .routine-details .details}

top{.top} source{.top} SpdfSsc::getCurrentVersion[]{.routine-attributes}

[result]{.var} = SpdfSsc::getCurrentVersion()

Gets the most up to date version of this class.

Return value

::: small most up to date version of this class. ::: :::

::: {#SpdfSsc::isUpToDate .routine-details .details}

top{.top} source{.top} SpdfSsc::isUpToDate[]{.routine-attributes}

[result]{.var} = SpdfSsc::isUpToDate()

Compares getVersion() and getCurrentVersion() to determine if this class is up to date.

Return value

::: small true if getVersion() >= getCurrentVersion(). Otherwise false. ::: :::

::: {#SpdfRest__define .routine-details .details}

top{.top} source{.top} SpdfRest__define[]{.routine-attributes}

SpdfRest__define

Defines the SpdfRest class.

::: :::

::: {#attributes}

File attributes

Modification date: Fri May 13 08:54:13 2022 Lines: 304

:::

SSC Feedback. :::

::: footer

Produced by IDLdoc 3.6.4 on Mon Apr 8 09:51:01 2024 IDLdoc project information{target=“_top”}

:::