Broadleaf Microservices
  • v1.0.0-latest-prod

Configuration

SSL Verification Properties

Property Description

broadleaf.common.ssl-verification.disabled

Dictates whether SSL verification should be disabled. Default is true.

External Application Resolver Properties

Property Description

broadleaf.gateway.tenant.application.resolution.url

The URL where the application resolution endpoint is located.

CORS configuration

The CORS configuration for Commerce gateway to enable cross-origin requests is specified in application-cors.yml. This configuration allows any origins, any headers, and the following request methods: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.

Gateway route properties

The properties as specified in application-default.yml and application-uber.yml.

Headers:

  • Service: the service for which the route is defined

  • Property: the property name for the service referenced under broadleaf.gateway.proxyurls.[service], broadleaf.gateway.predicates.[service], and broadleaf.gateway.filters.[service]

  • Default Proxy URL Port: the port specified for the broadleaf.gateway.proxyurls.[service] property in application-default.yml. Used when the microservice is deployed independently from the stack. Note that by default, the actual full property value is https://localhost:{port}.

  • Uber Override Proxy URL Port: the port specified for the broadleaf.gateway.proxyurls.[service] property in application-uber.yml. Used when the microservice stack is bundled and deployed as a single application. Note that by default, the actual full property value is https://localhost:{port}.

  • Route Predicate Base Path: base matching path for the route as defined for broadleaf.gateway.predicates.[service] in application-default.yml.

Service Property Default Proxy URL Port Uber Override Proxy URL Port Route Predicate Base Path

Asset

asset

8453

8447

/api/asset

Authentication

auth

8443

8443

/auth

Authentication API

authapi

8443

8443

/api/auth

Campaign

campaign

8451

8447

/api/campaign

Cart Operations

cartoperation

8459

8447

/api/cart-operations

Catalog

catalog

8442

8447

/api/catalog

Catalog Browse

catalogbrowse

8468

8447

/api/catalog-browse

Commerce Web

commerceweb

4000

4000

Not applicable

Customer

customer

8463

8447

/api/customer

Inventory

inventory

8471

8447

/api/inventory

Menu

menu

8444

8447

/api/menu

Notification

notification

8469

8447

/api/notification

Offer

offer

8452

8447

/api/offer

Order Operations

orderoperation

8472

8447

/api/order-operations

Personalization

personalization

8460

8447

/api/personalization

Pricing

pricing

8448

8447

/api/pricing

Sandbox

sandbox

8449

8447

/api/sandbox

Search

search

8457

8447

/api/search

Tenant

tenant

8450

8447

/api/tenant

Payment Transaction

paymenttransaction

8476

8447

/api/payment

Access Token Blacklist Filter Properties (since 3.0.0)

These properties are bound to the ReactiveTokenBlacklistProperties object in MicroservicesGateways. They are relevant when using the session token blacklisting feature with access token blacklisting checks enabled.

Property Description Default

broadleaf.gateway.auth.access-token-blacklist-filter.implementation

Configures the active reactive blacklist manager implementation. Supported values are: NONE (bypasses blacklisting checks), LOCAL_MEMORY (transient in-memory store for local testing/development only), and REDIS (production-grade, requires broadleaf.gateway.redis.enabled=true).

NONE

broadleaf.gateway.auth.access-token-blacklist-filter.include-paths

The list of path patterns (Ant-style) that the blacklist filter should apply to.

/**

broadleaf.gateway.auth.access-token-blacklist-filter.exclude-paths

The list of path patterns (Ant-style) that should be explicitly excluded from blacklist checking. If a path matches both an include and an exclude pattern, the exclude wins.

Empty

broadleaf.gateway.auth.access-token-blacklist-filter.blacklist-check-operation-timeout-ms

Configures the strict end-to-end timeout in milliseconds for the reactive blacklist lookup. If this threshold is exceeded, the request will timeout and gracefully fail-open.

2000

broadleaf.gateway.auth.access-token-blacklist-filter.circuit-breaker-failure-rate-threshold

Configures the failure rate threshold (percentage) for the circuit breaker.

50.0

broadleaf.gateway.auth.access-token-blacklist-filter.circuit-breaker-wait-duration-in-open-state-ms

The time in milliseconds that the CircuitBreaker should wait before transitioning from open to half-open.

10000

broadleaf.gateway.auth.access-token-blacklist-filter.circuit-breaker-sliding-window-size

Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.

100

broadleaf.gateway.auth.access-token-blacklist-filter.circuit-breaker-permitted-number-of-calls-in-half-open-state

Configures the number of permitted calls when the CircuitBreaker is half open.

10