Contact Us 1-800-596-4880
  1. Homepage
  2. OpenWeatherMap Connector (1.0)

  3. OpenWeatherMap Connector Reference

All Connectors

OpenWeatherMap Connector 1.0 Reference

Configurations

Config

Default configuration.

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Api Key

The connection types to provide to this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

API Key
Parameters
Name Type Description Default Value Required

apiKey

String

API key used to authenticate requests to the OpenWeatherMap API.

x

baseUri

String

Base URI for the OpenWeatherMap API endpoint.

x

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

Get Current Weather

<openweathermap:get-current-weather>

Get Current Weather.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

lat

Number

Latitude coordinate of the location.

x

lon

Number

Longitude coordinate of the location.

x

units

Enumeration, one of:

  • standard

  • metric

  • imperial

Temperature units for the response.

lang

String

Language code for the response text.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENWEATHERMAP:BAD_REQUEST

  • OPENWEATHERMAP:CLIENT_ERROR

  • OPENWEATHERMAP:CONNECTIVITY

  • OPENWEATHERMAP:FORBIDDEN

  • OPENWEATHERMAP:NOT_FOUND

  • OPENWEATHERMAP:SECURITY

  • OPENWEATHERMAP:SERVER_ERROR

  • OPENWEATHERMAP:TIMEOUT

  • OPENWEATHERMAP:TOO_MANY_REQUESTS

  • OPENWEATHERMAP:UNAUTHORIZED

Get Timestamp Data

<openweathermap:get-timestamp-data>

Get Timestamp Data.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

lat

Number

Latitude coordinate of the location.

x

lon

Number

Longitude coordinate of the location.

x

Unix Timestamp

Number

Timestamp (Unix time, UTC time zone). Data is available from January 1st, 1979 till 4 days ahead.

x

units

Enumeration, one of:

  • standard

  • metric

  • imperial

Temperature units for the response.

lang

String

Language code for the response text.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENWEATHERMAP:BAD_REQUEST

  • OPENWEATHERMAP:CLIENT_ERROR

  • OPENWEATHERMAP:CONNECTIVITY

  • OPENWEATHERMAP:FORBIDDEN

  • OPENWEATHERMAP:NOT_FOUND

  • OPENWEATHERMAP:SECURITY

  • OPENWEATHERMAP:SERVER_ERROR

  • OPENWEATHERMAP:TIMEOUT

  • OPENWEATHERMAP:TOO_MANY_REQUESTS

  • OPENWEATHERMAP:UNAUTHORIZED

Get Weather Overview

<openweathermap:get-weather-overview>

Get Weather Overview.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

lat

Number

Latitude coordinate of the location.

x

lon

Number

Longitude coordinate of the location.

x

units

Enumeration, one of:

  • standard

  • metric

  • imperial

Temperature units for the response.

lang

String

Language code for the response text.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENWEATHERMAP:BAD_REQUEST

  • OPENWEATHERMAP:CLIENT_ERROR

  • OPENWEATHERMAP:CONNECTIVITY

  • OPENWEATHERMAP:FORBIDDEN

  • OPENWEATHERMAP:NOT_FOUND

  • OPENWEATHERMAP:SECURITY

  • OPENWEATHERMAP:SERVER_ERROR

  • OPENWEATHERMAP:TIMEOUT

  • OPENWEATHERMAP:TOO_MANY_REQUESTS

  • OPENWEATHERMAP:UNAUTHORIZED

Types

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of store.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of store.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Error source type to map.

Target

String

Target error type to map to.

x
Back to top
View on GitHub