com.crossingchannels.portal.websphere.ci.base.contributor

Class AbstractStepsContributor<D extends com.xebialabs.deployit.plugin.api.udm.Deployed<?,?>>

java.lang.Object

com.crossingchannels.portal.websphere.ci.base.contributor.AbstractStepsContributor<D>

Direct Known Subclasses:

AbstractWasArtifactStepsContributor, PolicyStepsContributor

public abstract class AbstractStepsContributor<D extends com.xebialabs.deployit.plugin.api.udm.Deployed<?,?>>
extends java.lang.Object

Abstract contributor to add additional steps for (un)installation of portlet archives.

Since:

1.1

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStepsContributor(com.xebialabs.deployit.plugin.api.reflect.Type targetCiType, com.xebialabs.deployit.plugin.api.reflect.Type targetContainerType) Initialize new abstract contributor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	callInstall(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context, com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> rawDeployedCi, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta) Perform type conversion and call install method.
protected void	callUninstall(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context, com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> rawPreviousCi, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta) Perform type conversion and call uninstall method.
protected void	callUpdate(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context, com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> rawDeployedCi, com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> rawPreviousCi, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta) Perform type conversion and call update method.
void	contributePortletSteps(com.xebialabs.deployit.plugin.api.deployment.specification.Deltas deltas, com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context)
protected abstract void	install(D ciToInstall, com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta) Method to implement CI installation.
protected boolean	matchesCiTypeCriteria(com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> ciToValidate) Test whether or not the CI is valid.
protected void	processInstallationOfCi(com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta, com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context)
protected void	processUninstallationOfCi(com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta, com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context)
protected void	processUpdateOfCi(com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta, com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context)
protected abstract void	uninstall(D ciToUninstall, com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta) Method to implement CI uninstallation.
protected abstract void	update(D newCi, D oldCi, com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta) Method to implement CI update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractStepsContributor

protected AbstractStepsContributor(com.xebialabs.deployit.plugin.api.reflect.Type targetCiType,
                        com.xebialabs.deployit.plugin.api.reflect.Type targetContainerType)

Initialize new abstract contributor.

Parameters:

targetCiType - Target CI type.

targetContainerType - Target container type.

Method Detail

contributePortletSteps

public void contributePortletSteps(com.xebialabs.deployit.plugin.api.deployment.specification.Deltas deltas,
                          com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context)

processInstallationOfCi

protected void processInstallationOfCi(com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta,
                           com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context)

processUpdateOfCi

protected void processUpdateOfCi(com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta,
                     com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context)

processUninstallationOfCi

protected void processUninstallationOfCi(com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta,
                             com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context)

matchesCiTypeCriteria

protected boolean matchesCiTypeCriteria(com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> ciToValidate)

Test whether or not the CI is valid.

Parameters:

ciToValidate - The CI to validate.

Returns:

TRUE if valid, FALSE otherwise.

callInstall

protected final void callInstall(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context,
               com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> rawDeployedCi,
               com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

Perform type conversion and call install method.

Parameters:

context - The deployment context used to perform install.

rawDeployedCi - The raw CI type to install.

delta - The delta currently processed.

callUpdate

protected final void callUpdate(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context,
              com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> rawDeployedCi,
              com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> rawPreviousCi,
              com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

Perform type conversion and call update method.

Parameters:

context - The deployment context used to perform update.

rawDeployedCi - The raw CI type to install.

rawPreviousCi - The raw CI type to uninstall.

delta - The delta currently processed.

callUninstall

protected final void callUninstall(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context,
                 com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> rawPreviousCi,
                 com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

Perform type conversion and call uninstall method.

Parameters:

context - The deployment context used to perform uninstall.

rawPreviousCi - The raw CI type to uninstall.

delta - The delta currently processed.

install

protected abstract void install(D ciToInstall,
           com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context,
           com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

Method to implement CI installation. Called when a CI is newly installed, or updated to be deployed to a new container.

Parameters:

ciToInstall - The CI to install.

context - The deployment planning context.

delta - The delta currently processed.

update

protected abstract void update(D newCi,
          D oldCi,
          com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context,
          com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

Method to implement CI update. Called when a CI will be updated to the same container.

Parameters:

newCi - The new CI for the container.

oldCi - The old/current CI for the container.

context - The deployment planning context.

delta - The delta currently processed.

uninstall

protected abstract void uninstall(D ciToUninstall,
             com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext context,
             com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

Method to implement CI uninstallation. Called when a CI is removed, or updated to be deployed to a new container.

Parameters:

ciToUninstall - The CI to uninstall.

context - The deployment planning context.

delta - The delta currently processed.