This API documentation is for Ballerina 1.2.0. View API documentation for the latest release.

Constants - websub

  • WEBSUB_ERROR_CODE string {ballerina/websub}WebSubError
  • The constant used to represent error code of WebSub module.

  • PUBLISH_MODE_DIRECT string PUBLISH_MODE_DIRECT
  • RemotePublishMode indicating direct update content notification (fat-ping). The payload of the update notification request from the publisher to the hub would include be the update content.

  • PUBLISH_MODE_FETCH string PUBLISH_MODE_FETCH
  • RemotePublishMode indicating that once the publisher notifies the hub that an update is available, the hub needs to fetch the topic URL to identify the update content.

  • SHA1 string SHA1
  • The constant used to represent SHA-1 cryptographic hash algorithm

  • SHA256 string SHA256
  • The constant used to represent SHA-256 cryptographic hash algorithm

  • TOPIC_ID_HEADER string TOPIC_ID_HEADER
  • TopicIdentifier indicating dispatching based solely on a header of the request.

  • TOPIC_ID_PAYLOAD_KEY string TOPIC_ID_PAYLOAD_KEY
  • TopicIdentifier indicating dispatching based solely on a value for a key in the JSON payload of the request.

  • TOPIC_ID_HEADER_AND_PAYLOAD string TOPIC_ID_HEADER_AND_PAYLOAD
  • TopicIdentifier indicating dispatching based on a combination of header and values specified for a key/key(s) in the JSON payload of the request.

  • FAILURE_REASON_SUBSCRIPTION_GONE string SUBSCRIPTION_GONE
  • Represents subscription delivery failure due to the subscriber's callback URL replying with a HTTP 410 Gone status code.

  • FAILURE_REASON_FAILURE_STATUS_CODE string FAILURE_STATUS_CODE
  • Represents subscription delivery failures related to HTTP failure status codes except 410 Gone.

  • FAILURE_REASON_DELIVERY_FAILURE string DELIVERY_FAILURE
  • Represents subscription delivery failures related to network issues.

  • LISTENER_STARTUP_ERROR string {ballerina/websub}ListenerStartupError
  • Represents the reason string for the websub:ListenerStartupError.

  • HUB_STARTUP_ERROR_REASON string {ballerina/websub}HubStartupError
  • Represents the reason string for the websub:HubStartupError.