Package com.broadleafcommerce.common.messaging

Interface Securable

  • public interface Securable
    A Spring Cloud Stream message containing a JWT token that can be verified for authenticity and that contains claims about the messages originating user that can be validated for suitability of consumption in the current context.
    Author:
    Jeff Fischer

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getToken()
      A Base64 encoded JWT token generally containing the following claims: user - the user name for the user that generated the message via some action.
      void setToken​(String token)
      A Base64 encoded JWT token generally containing the following claims: user - the user name for the user that generated the message via some action.

    • Method Detail

      • getToken

        String getToken()
        A Base64 encoded JWT token generally containing the following claims:
        • user - the user name for the user that generated the message via some action. This can be a system component name if the message originated via automation.
        • authorities - comma delimited list of authorities available to the user. Not applicable for system components.
        • created date - the date this token was created
        The token should also be signed using a trusted private key and the token should be verifiable with a public key available to services consuming this message.
        Returns:
        A Base64 encoded JWT token

      • setToken

        void setToken​(String token)
        A Base64 encoded JWT token generally containing the following claims:
        • user - the user name for the user that generated the message via some action. This can be a system component name if the message originated via automation.
        • authorities - comma delimited list of authorities available to the user. Not applicable for system components.
        • created date - the date this token was created
        The token should also be signed using a trusted private key and the token should be verifiable with a public key available to services consuming this message.
        Parameters:
        token - A Base64 encoded JWT token