Package de.hybris.platform.core.initialization

Annotation Type SystemSetup

  • @Target({METHOD,TYPE})
@Retention(RUNTIME)
@Documented
public @interface SystemSetup
    The @SystemSetup is an annotation (as a hock-in mechanism) for executing methods during the init/update process for given extensions.

    With the annotation attribute extension you can specify, for which extension those methods should be called. The init/update process will first search for the extension attribute in the method annotations and then in this class annotation. You have to specify one of them. If the given extension does not exist, the method won't be called. If the annotation attributes process or type is not defined at the method nor at the class the default will be ALL then.

    Please make sure that the class is initialized properly (for example via Spring).

    Annotation attributes:

    • extension - annotates in which extension the code will be executed. The default value is an empty String which means the annotated code won't be executed!
    • process - annotates in which process the code will be executed. During INIT, UPDATE or in both (ALL). If at a method annotation no process attribute is defined (or NOTDEFINED is used) the definition from the class annotation is used.
    • type - annotates in which mode the code will be executed. During creation of essencial data (ESSENTIAL), during creation of project data (PROJECT) or in both modes (ALL). If at a method annotation no type attribute is defined (or NOTDEFINED is used) the definition from the class annotation is used.

    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.String ALL_EXTENSIONS
      This constant can be used to tell the collector that the method should be called for every extension!

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      Description of a patch.
      java.lang.String extension
      The default value for parameter extension is an empty String.
      java.lang.String name
      Name of a patch.
      boolean patch
      Marks current SystemSetup as a patch so the logic inside will be executed only once and tracked as SystemSetupAuditModel item.
      SystemSetup.Process process
      The default value parameter process is ALL.
      boolean required
      Indicates whether patch is required to apply or not.
      SystemSetup.Type type
      The default value for parameter type is ALL.

    • Field Detail

      • ALL_EXTENSIONS

        static final java.lang.String ALL_EXTENSIONS
        This constant can be used to tell the collector that the method should be called for every extension!

    • Element Detail

      • extension

        java.lang.String extension
        The default value for parameter extension is an empty String.
        Default:
        ""

      • type

        SystemSetup.Type type
        The default value for parameter type is ALL.
        Default:
        de.hybris.platform.core.initialization.SystemSetup.Type.NOTDEFINED

      • process

        SystemSetup.Process process
        The default value parameter process is ALL.
        Default:
        de.hybris.platform.core.initialization.SystemSetup.Process.NOTDEFINED

      • name

        java.lang.String name
        Name of a patch. Used only if patch() is used. Default is an empty String.
        Default:
        ""

      • description

        java.lang.String description
        Description of a patch. Used only if patch() is used. Default is an empty String.
        Default:
        ""

      • required

        boolean required
        Indicates whether patch is required to apply or not. Used only if patch() is used. Default is an empty String.
        Default:
        false