org.overlord.sramp.governance.services

Class DeploymentResource

java.lang.Object

org.overlord.sramp.governance.services.DeploymentResource

public class DeploymentResource
extends Object

The JAX-RS resource that handles deployment specific tasks.

Constructor Summary

Constructors

Constructor and Description
DeploymentResource() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,ValueEntity>	deploy(javax.servlet.http.HttpServletRequest request, String targetRef, String uuid) The deployment endpoint - processes can invoke this endpoint to deploy a deployment based on configuration of the provided target.
protected String	deployCLI(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, Target target, org.overlord.sramp.client.SrampAtomApiClient client) Deploys an artifact by deploying to a domain group using the (as7) command line interface (CLI).
protected String	deployCopy(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, Target target, org.overlord.sramp.client.SrampAtomApiClient client) Deploys an artifact by copying it onto the file system.
protected String	deployMaven(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, Target target, org.overlord.sramp.client.SrampAtomApiClient client) Deploys an artifact to a pre-configured maven repository.
protected String	deployRHQ(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, Target target, org.overlord.sramp.client.SrampAtomApiClient client) Deploys an artifact by deploying to an RHQ group.
protected org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType	getCurrentlyDeployedVersion(org.overlord.sramp.client.SrampAtomApiClient client, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, Target target) Finds the currently deployed version of the given artifact.
protected void	recordUndeploymentInfo(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, Target target, Map<String,String> props, org.overlord.sramp.client.SrampAtomApiClient client) Records undeployment information for the given artifact.
protected void	undeploy(org.overlord.sramp.client.SrampAtomApiClient client, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType prevVersionArtifact, Target target) Undeploys the given artifact.
protected void	undeployCLI(org.overlord.sramp.client.SrampAtomApiClient client, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType prevVersionArtifact, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType undeployInfo, Target target) Undeploy using the JBoss AS CLI.
protected void	undeployCopy(org.overlord.sramp.client.SrampAtomApiClient client, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType prevVersionArtifact, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType undeployInfo, Target target) Undeploy an artifact that was simply copied to a file location.
protected void	undeployRHQ(org.overlord.sramp.client.SrampAtomApiClient client, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType prevVersionArtifact, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType undeployInfo, Target target) Undeploy using JBoss RHQ.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentResource

public DeploymentResource()

Constructor.

Method Detail

deploy

public Map<String,ValueEntity> deploy(@Context
                             javax.servlet.http.HttpServletRequest request,
                             String targetRef,
                             String uuid)
                               throws Exception

The deployment endpoint - processes can invoke this endpoint to deploy a deployment based on configuration of the provided target.

Parameters:

request -

targetRef -

uuid -

Throws:

Exception

getCurrentlyDeployedVersion

protected org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType getCurrentlyDeployedVersion(org.overlord.sramp.client.SrampAtomApiClient client,
                                                                                   org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                                                                                   Target target)
                                                                                        throws Exception

Finds the currently deployed version of the given artifact. This basically needs to return the version of the artifact that is currently deployed to the given target. This is important so that we can undeploy that old version prior to deploying the new version.

Parameters:

client -

artifact -

target -

Throws:

Exception

undeploy

protected void undeploy(org.overlord.sramp.client.SrampAtomApiClient client,
            org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType prevVersionArtifact,
            Target target)
                 throws Exception

Undeploys the given artifact. Uses information recorded when that artifact was originally deployed (see recordUndeploymentInfo(BaseArtifactType, Target, Map, SrampAtomApiClient)).

Parameters:

client -

prevVersionArtifact -

target -

Throws:

Exception

deployCopy

protected String deployCopy(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                Target target,
                org.overlord.sramp.client.SrampAtomApiClient client)
                     throws Exception

Deploys an artifact by copying it onto the file system.

Parameters:

artifact -

target -

client -

Throws:

Exception

deployMaven

protected String deployMaven(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                 Target target,
                 org.overlord.sramp.client.SrampAtomApiClient client)
                      throws Exception

Deploys an artifact to a pre-configured maven repository. The maven GAV properties are required to be set on the artifact. This code is preview at best since it has a lot of loose ends: - if this jar has a parent pom then this parent needs to be in the repo. - credentials should be set in a .settings.xml in the .m2 dir of the user that runs the app

Parameters:

artifact -

target -

client -

Throws:

Exception

deployRHQ

protected String deployRHQ(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
               Target target,
               org.overlord.sramp.client.SrampAtomApiClient client)
                    throws Exception

Deploys an artifact by deploying to an RHQ group.

Parameters:

target - - name of the pre-configured server group in RHQ

uuid -

Throws:

org.overlord.sramp.atom.err.SrampAtomException

Exception

deployCLI

protected String deployCLI(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
               Target target,
               org.overlord.sramp.client.SrampAtomApiClient client)
                    throws Exception

Deploys an artifact by deploying to a domain group using the (as7) command line interface (CLI). The target name corresponds to the domain group the artifact will be deployed to.

Parameters:

artifact -

target -

client -

Throws:

Exception

recordUndeploymentInfo

protected void recordUndeploymentInfo(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                          Target target,
                          Map<String,String> props,
                          org.overlord.sramp.client.SrampAtomApiClient client)
                               throws org.overlord.sramp.client.SrampClientException,
                                      org.overlord.sramp.atom.err.SrampAtomException

Records undeployment information for the given artifact. The undeployment information is saved as another artifact in the repository with a relationship back to the deployment artifact.

Parameters:

artifact -

target -

props -

Throws:

org.overlord.sramp.atom.err.SrampAtomException

org.overlord.sramp.client.SrampClientException

undeployCLI

protected void undeployCLI(org.overlord.sramp.client.SrampAtomApiClient client,
               org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType prevVersionArtifact,
               org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType undeployInfo,
               Target target)
                    throws Exception

Undeploy using the JBoss AS CLI.

Parameters:

client -

prevVersionArtifact -

undeployInfo -

target -

Throws:

Exception

undeployCopy

protected void undeployCopy(org.overlord.sramp.client.SrampAtomApiClient client,
                org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType prevVersionArtifact,
                org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType undeployInfo,
                Target target)

Undeploy an artifact that was simply copied to a file location.

Parameters:

client -

prevVersionArtifact -

undeployInfo -

target -

undeployRHQ

protected void undeployRHQ(org.overlord.sramp.client.SrampAtomApiClient client,
               org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType prevVersionArtifact,
               org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType undeployInfo,
               Target target)
                    throws Exception

Undeploy using JBoss RHQ.

Parameters:

client -

prevVersionArtifact -

undeployInfo -

target -

Throws:

Exception