Package de.hybris.platform.commercewebservicescommons.annotation

Annotation Interface SiteChannelRestriction

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface SiteChannelRestriction
Annotation for setting allowed site channels for a specific method

SiteChannelRestriction is used to define the property which contains the list of allowed site channels and restrict access to methods based on the channel of the current base site. AccessDeniedException is thrown if the current base site channel is not included in allowed site channels.

Leaving allowedSiteChannelsProperty blank means that the annotated method has no allowed site channels which will cause AccessDeniedException being thrown from any base site channel.

AccessDeniedException will be also thrown if there's no current base site for annotated methods

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    allowedSiteChannelsProperty
    Returns the property which contains the list of allowed site channels (e.g.

  • Element Details

    • allowedSiteChannelsProperty

      String allowedSiteChannelsProperty
      Returns the property which contains the list of allowed site channels (e.g. api.compatibility.b2c.channels).
      Returns:
      SiteChannel[] The allowed site channels
      Default:
      ""