Package com.broadleafcommerce.data.tracking.core.transition

Class WorkflowDeployRequest

  • All Implemented Interfaces:
    com.broadleafcommerce.common.messaging.Securable, TransitionRequest, Serializable
    public class WorkflowDeployRequest
extends Object
implements TransitionRequest
    A request for a deployment operation, moving all changes less than or equal to a requested version from the sandboxable state of an item to production.
    Author:
    Jeff Fischer
    See Also:
    Serialized Form

    • Constructor Detail

      • WorkflowDeployRequest

        public WorkflowDeployRequest​(Map<String,​String> transferTypeIdMap,
                             String contextId,
                             String sandboxId,
                             String author,
                             Integer level,
                             String entity,
                             String version)
        Create a new deployment
        Parameters:
        transferTypeIdMap - loose bag of information required to run the transition, see TransferType
        contextId - the contextId of the item being deployed
        sandboxId - the sandbox that the item is currently in
        author - author of the deployment
        level - the tracking level that the item is in
        className - an alias of the class that should undergo the transition
        version -

    • Method Detail

      • withRemoveTemporaryOverride

        public WorkflowDeployRequest withRemoveTemporaryOverride​(boolean isRemoveTemporaryOverride)

      • isRemoveTemporaryOverride

        public boolean isRemoveTemporaryOverride()
        Whether or not to remove temporary application catalog override state at the edges of sandbox transition. This includes revert or deploy. Temporary application override state can occur during parent catalog deployment propagation. See VendorSandboxPropagationHandler for more information.

      • getVersion

        public String getVersion()
        The maximum version of ChangeDetail instances on an entity to deploy to production.
        Returns:
        The maximum version of ChangeDetail instances

      • setRemoveTemporaryOverride

        public void setRemoveTemporaryOverride​(boolean isRemoveTemporaryOverride)
        Whether or not to remove temporary application catalog override state at the edges of sandbox transition. This includes revert or deploy. Temporary application override state can occur during parent catalog deployment propagation. See VendorSandboxPropagationHandler for more information.

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getTransferTypeIdMap

        public Map<String,​String> getTransferTypeIdMap()
        Description copied from interface: TransitionRequest
        Get the IDs of the transition requested mapped by the TransferType. Could be the ids of a change summary, summary group, or deployment. A single summary could be one of a large group of changes or a deployment thereby leading to the map containing the ID of a the individual summary related to 1 set of changes being transitioned and the ID of the entire group. This is used to clean up state once all of the related transition requests have completed.
        Specified by:
        getTransferTypeIdMap in interface TransitionRequest

      • getSandboxId

        public String getSandboxId()
        Description copied from interface: TransitionRequest
        The id for the sandbox in which the originating item resides.
        Specified by:
        getSandboxId in interface TransitionRequest
        Returns:
        The id for the sandbox in which the originating item resides

      • getAuthor

        public String getAuthor()
        Description copied from interface: TransitionRequest
        The author of the promotion. This is useful when finding originating domain items in a user sandbox for promotion to a subsequent level. User sandbox changes are partially identified by their author.
        Specified by:
        getAuthor in interface TransitionRequest
        Returns:
        The author of the promotion

      • getEntity

        public String getEntity()
        Description copied from interface: TransitionRequest
        The entity's class name for this promotion.
        Specified by:
        getEntity in interface TransitionRequest
        Returns:
        The entity's class name for this promotion

      • getStage

        public String getStage()
        Description copied from interface: TransitionRequest
        The informational stage in which the originating item resides.
        Specified by:
        getStage in interface TransitionRequest
        Returns:
        The informational stage in which the originating item resides.

      • getMessage

        public String getMessage()
        Description copied from interface: TransitionRequest
        A user defined message to go along with the state transition. This is generally descriptive of the purpose served by the transition.
        Specified by:
        getMessage in interface TransitionRequest
        Returns:
        A user defined message to go along with the state transition

      • getToken

        public String getToken()
        Specified by:
        getToken in interface com.broadleafcommerce.common.messaging.Securable

      • setRouteKey

        public void setRouteKey​(String routeKey)

      • setEntity

        public void setEntity​(String entity)

      • setStage

        public void setStage​(String stage)
        Description copied from interface: TransitionRequest
        The informational stage in which the originating item resides.
        Specified by:
        setStage in interface TransitionRequest
        Parameters:
        stage - The informational stage in which the originating item resides.

      • setVisibleFromCatalog

        public void setVisibleFromCatalog​(Set<String> visibleFromCatalog)
        Description copied from interface: TransitionRequest
        Context list of the contextIds for the deep catalog tree parenting the TransitionRequest.getCatalogId(). This is not a value that is generally populated via JSON. Rather, this variable is generally calculated via lookup of catalog using catalogId. This is helpful for identifying inherited targets during a promotion.
        Specified by:
        setVisibleFromCatalog in interface TransitionRequest
        Parameters:
        visibleFromCatalog - list of the contextIds for the deep catalog tree parenting the TransitionRequest.getCatalogId()

      • setMessage

        public void setMessage​(String message)
        Description copied from interface: TransitionRequest
        A user defined message to go along with the state transition. This is generally descriptive of the purpose served by the transition.
        Specified by:
        setMessage in interface TransitionRequest
        Parameters:
        message - A user defined message to go along with the state transition

      • setToken

        public void setToken​(String token)
        Specified by:
        setToken in interface com.broadleafcommerce.common.messaging.Securable