Serialized Form

Package com.broadleafcommerce.tenant.domain

Class com.broadleafcommerce.tenant.domain.Application

class Application extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allowedCurrencies

List<Currency> allowedCurrencies

List of Currencies that are available to be selected for use with this application. All Catalogs that are related to this application should be restricted to this currency set. However, note that this can be empty, in which case, APIs will respond to requests with a list of currencies that the system determines to be the defaults for each locale in Application.allowedLocales.

allowedLocales

List<Locale> allowedLocales

List of Locales that are available to be selected for this application. All Catalogs that are related to this application should be restricted to this locale set.

attributes

Map<String,Object> attributes

Arbitrary attributes associated with this application. May include soft references to related entities, custom fields, or other data.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

customerContextId

String customerContextId

The customer context id that is used to discriminate entities with TrackableBehavior.CUSTOMER_CONTEXT.

If it is null on a newly created application, then the property TenantApplicationProperties.Customer.getContextMethod() is used to default it. If CustomerContextResolverMethod.APPLICATION uses the ID of the Application. If CustomerContextResolverMethod.TENANT, uses the ID of the Tenant.

See Also:

• CustomerContextResolverMethod

deactivated

boolean deactivated

Determines whether this application is active.

defaultCurrency

Currency defaultCurrency

The Currency that this application, by default, assumes all data is within and can drive the default currency selection on a frontend. If not set, the system will use the default currency for Application.defaultLocale in response to API requests.

defaultLocale

Locale defaultLocale

The Locale that this application, by default, assumes all data is within and can drive the default Locale selection as a result.

id

String id

The context id, which is a separate identifier from the database primary key. This may be auto generated, or may be explicitly provided upon entity creation.

identifierType

String identifierType

Defines the type of the application resolution identifier: Whether a domain or a domain prefix.

See Also:

• ResolutionIdentifierType

identifierValue

String identifierValue

Determines how applications are resolved using all or part of their domains or hostnames. Values could be the myapplication.mycompany.com in https://myapplication.mycompany.com/ or the myapplication in https://myapplication.mycompany.com/ depending on Application.identifierType.

See Also:

• Application.identifierType

isMarketplace

boolean isMarketplace

Whether or not the application is a marketplace application. Marketplace applications leverage MarketplaceApplicationCatalog relationships to catalogs, in addition to the explicit relationships declared in Application.getIsolatedCatalogs().

Generally, all relationships to vendor catalogs should be defined exclusively with MarketplaceApplicationCatalog, and any additional relationships to non-vendor catalogs would be in Application.getIsolatedCatalogs().

isolatedCatalogs

List<ApplicationCatalogRef> isolatedCatalogs

Individual catalogs assigned to this application. ApplicationCatalogRefs provide additional control over the mutability and visibility of the entities of the catalogs assigned.

See Also:

• ApplicationCatalogRef

logoAsset

ApplicationAsset logoAsset

The asset information for the application's logo. If populated, this property will be used within the admin to display the logo for the application-level admin. If not populated, the admin will utilize the Tenant.getLogoAsset() if it exists.

name

String name

The general name for the application

portraitAsset

ApplicationAsset portraitAsset

The asset information for the application's portrait. If populated, this property will be used within the admin to display a portrait for this application within the application selector. If not populated, a generic fallback icon will be displayed instead.

robots

String robots

A robots.txt file contents tells search engine crawlers which pages or files the crawler can or can't request from your site. This is used mainly to avoid overloading your site with requests;

token

String token

The token used for API access to this application's data.

Class com.broadleafcommerce.tenant.domain.ApplicationAsset

class ApplicationAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.tenant.domain.ApplicationCatalog

class ApplicationCatalog extends ApplicationCatalogRef implements Serializable

serialVersionUID:

1L

Serialized Fields

catalog

Catalog catalog

Class com.broadleafcommerce.tenant.domain.ApplicationCatalogRef

class ApplicationCatalogRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

catalogStatus

String catalogStatus

The status of the catalog's visibility for this assignment.

excludeFromAdd

boolean excludeFromAdd

Determines whether the admin users of the related Application can select the catalog as a destination for entity add operations.

id

String id

The context id of the Catalog instance.

implicit

String implicit

The context id of the hidden Catalog that is owned by this application and receives any catalog overrides enacted on behalf of this application for the catalog referenced by ApplicationCatalogRef.id.

mutabilityType

String mutabilityType

The modifiability of the entities inherited from the catalogs.

For catalogs created by this application itself, the value should always be MutabilityType.CUSTOMIZABLE.

See Also:

• MutabilityType

name

String name

See Also:

• Catalog.getName()

type

String type

The type of the related catalog.

See Also:

• Catalog.getType()

visibleAsAssigned

boolean visibleAsAssigned

Determines whether the catalog is visible to the admin users of the related Application as being assigned.

Class com.broadleafcommerce.tenant.domain.MarketplaceApplicationCatalog

class MarketplaceApplicationCatalog extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

application

String application

The id of the related Application

catalog

String catalog

The id of the related Catalog

See Also:

• MarketplaceApplicationCatalog.getHydratedCatalog()

catalogStatus

String catalogStatus

The status of the catalog's visibility for this assignment.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

hydratedCatalog

Catalog hydratedCatalog

In specific circumstances, the system may need to return a 'hydrated' response to an API caller and will set this value to the full Catalog instance corresponding to MarketplaceApplicationCatalog.getCatalog().

This should never be accepted by the system in requests, and will be null in situations where hydration does not apply.

See Also:

• MarketplaceApplicationCatalogService.hydrate(MarketplaceApplicationCatalog, ContextInfo)
• MarketplaceApplicationCatalogService.hydrate(Collection, ContextInfo)

id

String id

The context id of the MarketplaceApplicationCatalog instance.

implicit

String implicit

The id of the implicit catalog for the application that will contain the application's overrides of items from MarketplaceApplicationCatalog.catalog.

propagationType

String propagationType

The PropagationType of the how changes from a vendor will be received into the marketplace application. The default is PropagationType.DIRECT.

vendorRef

String vendorRef

The vendor ref that this relationship is for. This is always auto-set by the system to match Catalog.getVendorRef() at the time of creation and is not intended to be mutable.

Any value for this provided in requests should be ignored.

Class com.broadleafcommerce.tenant.domain.Tenant

class Tenant extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allowedCurrencies

List<Currency> allowedCurrencies

List of Currencies that are available to be selected for use with this tenant. All Catalogs that are related to this tenant should be restricted to this currency set. However, note that this can be empty, in which case, APIs will respond to requests with a list of currencies that the system determines to be the defaults for each locale in Tenant.allowedLocales.

allowedLocales

List<Locale> allowedLocales

List of Locales that are available to be selected for this tenant.

attributes

Map<String,Object> attributes

Arbitrary attributes associated with this tenant. May include soft references to related entities, custom fields, or other data.

defaultCurrency

Currency defaultCurrency

The Currency that this tenant, by default, assumes all data is within and can drive the default currency selection on a frontend. If not set, the system will use the default currency for Tenant.defaultLocale in response to API requests.

defaultLocale

Locale defaultLocale

The Locale that this tenant, by default, assumes all data is within and can drive the default Locale selection as a result.

id

String id

The tenant identifier, which might be the same as the database primary key.

identifierType

String identifierType

Defines the type of the tenant resolution identifier: Whether a domain or a domain prefix.

See Also:

• ResolutionIdentifierType

identifierValue

String identifierValue

Determines how tenants are resolved using all or part of their domains or hostnames. Values could be the mytenant.mycompany.com in https://mytenant.mycompany.com/ or the mytenant in https://mytenant.mycompany.com/ depending on Tenant.identifierType.

See Also:

• Tenant.identifierType

logoAsset

TenantAsset logoAsset

The asset information for the tenant's logo. If populated, this property will be used within the admin to display the logo for the tenant-level admin and any applications without a Application.getLogoAsset().

name

String name

The general name for the tenant

Class com.broadleafcommerce.tenant.domain.TenantAsset

class TenantAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Package com.broadleafcommerce.tenant.provider.jpa.domain

Class com.broadleafcommerce.tenant.provider.jpa.domain.JpaApplicationCatalogRef

class JpaApplicationCatalogRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

catalogStatus

String catalogStatus

The status of the catalog's visibility for this assignment.

contextId

String contextId

See Also:

• ApplicationCatalogRef.getId()

excludeFromAdd

boolean excludeFromAdd

See Also:

• ApplicationCatalogRef.isExcludeFromAdd()

implicit

String implicit

mutabilityType

String mutabilityType

See Also:

• ApplicationCatalogRef.getMutabilityType()

name

String name

type

String type

See Also:

• ApplicationCatalogRef.getType()

visibleAsAssigned

boolean visibleAsAssigned

See Also:

• ApplicationCatalogRef.isVisibleAsAssigned()

Class com.broadleafcommerce.tenant.provider.jpa.domain.JpaTenant

class JpaTenant extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allowedCurrencies

List<Currency> allowedCurrencies

See Also:

• Tenant.getAllowedCurrencies()

allowedLocales

List<Locale> allowedLocales

See Also:

• Tenant.getAllowedLocales()

attributes

Map<String,Object> attributes

See Also:

• Tenant.getAttributes()

defaultCurrency

Currency defaultCurrency

See Also:

• Tenant.getDefaultCurrency()

defaultLocale

Locale defaultLocale

See Also:

• Tenant.getDefaultLocale()

id

String id

identifierType

String identifierType

See Also:

• Tenant.getIdentifierType()

identifierValue

String identifierValue

See Also:

• Tenant.getIdentifierValue()

logoAsset

JpaTenantAsset logoAsset

See Also:

• Tenant.getLogoAsset()

name

String name

See Also:

• Tenant.getName()

timestamp

Instant timestamp

Temporal state describing the time at which this item was last updated. Relates to the Temporal interface and is primarily used during consumption of messages regarding changes in state to this domain. For example, a service consuming a change notification for this domain can compare the current persisted timestamp to this timestamp to determine if it already has a newer version, in which case, it can ignore. This is primarily a measure to ensure that ordering is not required for messages related to state change.

Class com.broadleafcommerce.tenant.provider.jpa.domain.JpaTenantApplication

class JpaTenantApplication extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allowedCurrencies

List<Currency> allowedCurrencies

See Also:

• Application.getAllowedCurrencies()

allowedLocales

List<Locale> allowedLocales

See Also:

• Application.getAllowedLocales()

attributes

Map<String,Object> attributes

contextId

String contextId

customerContextId

String customerContextId

deactivated

boolean deactivated

See Also:

• Application.isDeactivated()

defaultCurrency

Currency defaultCurrency

See Also:

• Application.getDefaultCurrency()

defaultLocale

Locale defaultLocale

See Also:

• Application.getDefaultLocale()

identifierType

String identifierType

See Also:

• Application.getIdentifierType()

identifierValue

String identifierValue

See Also:

• Application.getIdentifierValue()

isMarketplace

boolean isMarketplace

isolatedCatalogs

List<JpaApplicationCatalogRef> isolatedCatalogs

See Also:

• Application.getIsolatedCatalogs()

logoAsset

JpaTenantApplicationAsset logoAsset

See Also:

• Application.getLogoAsset()

name

String name

See Also:

• Application.getName()

portraitAsset

JpaTenantApplicationAsset portraitAsset

See Also:

• Application.getPortraitAsset()

robots

String robots

See Also:

• Application.getRobots()

timestamp

Instant timestamp

Temporal state describing the time at which this item was last updated. Relates to the Temporal interface and is primarily used during consumption of messages regarding changes in state to this domain. For example, a service consuming a change notification for this domain can compare the current persisted timestamp to this timestamp to determine if it already has a newer version, in which case, it can ignore. This is primarily a measure to ensure that ordering is not required for messages related to state change.

token

String token

See Also:

• Application.getToken()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking

Retrieve the tracking information from the entity

Class com.broadleafcommerce.tenant.provider.jpa.domain.JpaTenantApplicationAsset

class JpaTenantApplicationAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.tenant.provider.jpa.domain.JpaTenantAsset

class JpaTenantAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.tenant.provider.jpa.domain.JpaTenantCatalog

class JpaTenantCatalog extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextId

String contextId

defaultCurrency

Currency defaultCurrency

See Also:

• Catalog.getDefaultCurrency()

hidden

boolean hidden

Whether or not this catalog is hidden from selection in the admin.

level

Long level

The level for a catalog in the tree going from least (root nodes) to highest (leaf nodes). This is primarily used for sorting in a given inheritance line. This is a calculated field.

locale

Locale locale

See Also:

• Catalog.getLocale()

name

String name

The name for the catalog

owningApplication

String owningApplication

Soft reference to the application contextId that owns this catalog. This value can be null, in which case, this is a global catalog.

parents

List<JpaTenantCatalogRef> parents

The parent nodes for this catalog, including additional mutability information.

timestamp

Instant timestamp

Temporal state describing the time at which this item was last updated. Relates to the Temporal interface and is primarily used during consumption of messages regarding changes in state to this domain. For example, a service consuming a change notification for this domain can compare the current persisted timestamp to this timestamp to determine if it already has a newer version, in which case, it can ignore. This is primarily a measure to ensure that ordering is not required for messages related to state change.

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking

Retrieve the tracking information from the entity

type

String type

See Also:

• Catalog.getType()

vendorRef

String vendorRef

See Also:

• Catalog.getVendorRef()

Class com.broadleafcommerce.tenant.provider.jpa.domain.JpaTenantCatalogRef

class JpaTenantCatalogRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

childCatalog

JpaTenantCatalog childCatalog

The JpaTenantCatalog to which this parent is associated

contextId

String contextId

exclusionFilters

String exclusionFilters

Filters written in RSQL that further refine what items are excluded from inheritance from this referenced parent catalog

inclusionFilters

String inclusionFilters

level

Long level

Non-persistent field used to track levels temporarily during tree structure calculation.

mutabilityType

String mutabilityType

The editing capabilities for the records inherited from the parent. See MutabilityType for more information.

name

String name

parentCatalogId

String parentCatalogId

The soft reference to the parent catalog contextId

Class com.broadleafcommerce.tenant.provider.jpa.domain.JpaTenantMarketplaceApplicationCatalog

class JpaTenantMarketplaceApplicationCatalog extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

application

String application

The id of the related Application

catalog

String catalog

The id of the related Catalog

catalogStatus

String catalogStatus

The status of the catalog's visibility for this assignment.

contextId

String contextId

implicit

String implicit

The id of the implicit catalog for the application that will contain the application's overrides of items from JpaTenantMarketplaceApplicationCatalog.catalog.

propagationType

String propagationType

The PropagationType of the how changes from a vendor will be received into the marketplace application. The default is PropagationType.DIRECT.

timestamp

Instant timestamp

Temporal state describing the time at which this item was last updated. Relates to the Temporal interface and is primarily used during consumption of messages regarding changes in state to this domain. For example, a service consuming a change notification for this domain can compare the current persisted timestamp to this timestamp to determine if it already has a newer version, in which case, it can ignore. This is primarily a measure to ensure that ordering is not required for messages related to state change.

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking

Retrieve the tracking information from the entity

vendorRef

String vendorRef

See Also:

• Catalog.getVendorRef()

Package com.broadleafcommerce.tenant.service.exception

Exception com.broadleafcommerce.tenant.service.exception.InvalidApplicationContextException

class InvalidApplicationContextException extends Exception implements Serializable

Exception com.broadleafcommerce.tenant.service.exception.UnsupportedCustomerContextResolverMethod

class UnsupportedCustomerContextResolverMethod extends RuntimeException implements Serializable

Package com.broadleafcommerce.tenant.web.endpoint

Class com.broadleafcommerce.tenant.web.endpoint.TenantResolverEndpoint.AdminTenantResolverResponse

class AdminTenantResolverResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

tenant

Tenant tenant

The resolved Tenant.

Class com.broadleafcommerce.tenant.web.endpoint.TenantResolverEndpoint.ApplicationResolverResponse

class ApplicationResolverResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

application

Application application

The resolved Application.

tenant

Tenant tenant

The resolved Tenant.

Package com.broadleafcommerce.tenant.web.endpoint.exception

Exception com.broadleafcommerce.tenant.web.endpoint.exception.TenantResolverMissingParameterException

class TenantResolverMissingParameterException extends RuntimeException implements Serializable