Serialized Form

  • Package com.broadleafcommerce.notification.domain

    • Class com.broadleafcommerce.notification.domain.Recipient

      class Recipient extends Object implements Serializable

      • Serialized Fields

        • bcc
          boolean bcc
          Indicator that this recipient should be BCC'd on the notification.
        • cc
          boolean cc
          Indicator that this recipient should be CC'd on the notification.
        • communicationPreference
          String communicationPreference
          The communication preference of the recipient.
        • emailAddress
          String emailAddress
          The emailAddress for this recipientInfo. Required when sending some notification delivery types (e.g. EMAIL)
        • mobileNumber
          String mobileNumber
          The mobileNumber for this recipientInfo. Required when sending some notification delivery types (e.g. SMS)
        • name
          String name
          The name of the recipient. Optional. Can be used to provide a name in addition to the emailAddress for most EMAIL providers.

    • Class com.broadleafcommerce.notification.domain.Sender

      class Sender extends Object implements Serializable

      • Serialized Fields

        • emailAddress
          String emailAddress
          The emailAddress that this message is from. Required when sending some notification delivery types (e.g. EMAIL)
        • mobileNumber
          String mobileNumber
          The mobileNumber for this sender. Required when sending some notification delivery types (e.g. SMS)
        • name
          String name
          The name of the sender. Optional. Can be used to provide a name in addition to the emailAddress for most EMAIL providers.

  • Package com.broadleafcommerce.notification.exception

  • Package com.broadleafcommerce.notification.provider.jpa.domain

    • Class com.broadleafcommerce.notification.provider.jpa.domain.JpaNotification

      class JpaNotification extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • contextId
          String contextId
          The jpa primary key.
        • createDate
          Instant createDate
          The date that this notification was first created.
        • deliveryType
          String deliveryType
          Delivery Type (EMAIL, SMS) represents how the message will be delivered. The deliveryType typically use along with the notificationType to determine the appropriate provider to build and deliver the message.
        • messageBody
          String messageBody
          The messageBody for the Notification. Required for messages that are not built using a templateName and templateData. This field is typically not populated when using a 3rd party processor to process the template.
        • messageType
          String messageType
          Message Type (RESET_PASSWORD, ORDER_CONFIRMATION) represents the type of notification being sent. The messageType is typically use along with the deliveryType to determine the appropriate provider to build and deliver the message.
        • notificationStatus
          String notificationStatus
          Notification STATUS (NEW, READY_TO_SEND, SENDING, SENT, RETRY, ERROR) The notification status indicates the delivery status of a message. NEW - Notification is being prepared or not ready to send. READY_TO_SEND - Notification can be sent by a provider SENDING - Provider has been requested to send the notification. SENT - Provider responded that the message was sent RETRY - Provider responded with an ERROR that can be retried ERROR - Provider responded with an unknown ERROR or an ERROR that should not be retried. Since there are edge cases that can occur with message sending, providers should take a conservative approach to message sending. A provider should typically be developed to allow AT MOST ONCE delivery. This means that in extreme cases, no message would be sent but that in no case would a user get multiple messages.
        • properties
          Map<String,Object> properties
        • recipients
          List<Recipient> recipients
        • retryCount
          int retryCount
          The number of times this message has been retried.
        • sender
          Sender sender
        • sentDate
          Instant sentDate
          The date that this notification was first created.
        • subject
          String subject
          The subject of the notification. Subject may be required by certain providers (especially EMAIL deliveryType).
        • templateData
          String templateData
          A JSON structure representing the data for the notification template.
        • templateName
          String templateName
          The templateName used by the provider to construct the messageBody. Providers may utilize the templateName and templateData to construct a messageBody if one is not provided. It is typical for a provider to resolve the templateName using the notificationType
        • tracking
          com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking
          See Also:
          • TenantJpaTracking

  • Package com.broadleafcommerce.notification.service.messaging

  • Package com.broadleafcommerce.notification.service.provider.external.domain.tenant

  • Package com.broadleafcommerce.notification.service.provider.external.domain.user

    • Class com.broadleafcommerce.notification.service.provider.external.domain.user.AdditionalPhone

      class AdditionalPhone extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • phone
          com.broadleafcommerce.order.common.domain.Phone phone
        • type
          String type
          The type of the additional phone. For example "FAX", "MOBILE", etc. or "OTHER"

    • Class com.broadleafcommerce.notification.service.provider.external.domain.user.AdminUser

      class AdminUser extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • active
          boolean active
          A flag indicating whether the admin user account is enabled. If false, they will not be able to log in.

          This flag should be used if the admin user needs to be enabled/disabled for administrative reasons.

        • applicationAccess
          boolean applicationAccess
          Indicates whether this user has access at the application level or not.
        • applicationIds
          Set<String> applicationIds
          The ids of applications this user is a member of.
        • changePasswordRequired
          boolean changePasswordRequired
          A flag indicating whether the admin user account requires a password reset. If true, they will not be able to log in until they reset their password.
        • defaultCommunicationPreference
          String defaultCommunicationPreference
          The default communication preference of the user.
        • email
          String email
          The email address of the user.
        • expired
          boolean expired
          A flag indicating whether the admin user account is expired. If false, they will not be able to log in.

          This flag can be used to declare an account as expired and unusable, but currently there is no logic for that. It will always be false.

        • global
          boolean global
          If true, this user is a global user, meaning that they can access the global applications. If not, the user can only access the applications they are assigned to via AdminUser.applicationIds.
        • id
          String id
          The unique identifier for this user.
        • locked
          boolean locked
          A flag indicating whether the admin user account is locked due to too many failed login attempts.
        • name
          String name
          The name of this user.
        • phone
          String phone
          The phone number of the user.
        • tenantAccess
          boolean tenantAccess
          Indicates whether this user has access at the tenant level or not.
        • tenantId
          String tenantId
          The id of the tenant this user is associated with.
        • username
          String username
          The username of this user, used to log into the application. May be the same as AdminUser.email, but that is not necessary.

    • Class com.broadleafcommerce.notification.service.provider.external.domain.user.Customer

      class Customer extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • active
          boolean active
          Is this customer active? Inactive customers can be thought of as "disabled" and will not be able to login. A customer set to inactive must be manually re-activated.

          Note: If manually setting this to false (e.g. via a direct database update), the auth user record (JpaUser#active in the auth database) must also be set to false.

          See also Customer.locked

        • additionalPhones
          List<AdditionalPhone> additionalPhones
          Additional phone numbers associated with the customer.
        • attributes
          Map<String,Object> attributes
          Dynamic attributes that are a part of the customer. This is an admin-entered field.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • defaultAccountId
          String defaultAccountId
          The default account for the customer. If set, the customer will automatically have this account selected on login.
        • defaultCommunicationPreference
          String defaultCommunicationPreference
          The default communication preference of the customer.
        • email
          String email
          The email address of the customer.
        • externalId
          String externalId
          The id that associates this user with an external system.
        • firstName
          String firstName
          The first name of the customer, if the fullName is not being used for the customer.
        • fullName
          String fullName
          The full name of the customer, if the component parts firstName, middleName, and lastName are not being used to comprise the full name.
        • id
          String id
          The context ID of the customer.
        • lastName
          String lastName
          The last name of the customer, if the fullName is not being used for the customer.
        • locked
          boolean locked
          Is this user locked? A user may be locked due to too many failed login attempts. Note that, depending on user lock configuration, this may have no effect. If permanently disabling a customer is desired, the Customer.active flag should be used instead.
        • middleName
          String middleName
          The middle name of the customer, if the fullName is not being used for the customer.
        • phone
          com.broadleafcommerce.order.common.domain.Phone phone
          The main phone number of the customer.
        • specialType
          String specialType
          The type of the customer, if it's in a special circumstance.
        • taxId
          String taxId
          The tax id for this customer
        • username
          String username
          The username of the customer, used to log in.
        • vatRegistrationId
          String vatRegistrationId
          Optional VAT registration ID.