org.kie.remote.services.rest
Class DeploymentResource

java.lang.Object
  org.kie.remote.services.rest.ResourceBase
      org.kie.remote.services.rest.DeploymentResource

@RequestScoped
public class DeploymentResource
extends ResourceBase

If a method in this class is annotated by a @Path annotation, then the name of the method should match the URL specified in the @Path, where "_" characters should be used for all "/" characters in the path.

For example:

Field Summary

 
Fields inherited from class org.kie.remote.services.rest.ResourceBase
PROC_INST_ID_PARAM_NAME, processRequestBean
 



Constructor Summary
DeploymentResource()



           
 



Method Summary




protected  org.jbpm.kie.services.impl.KModuleDeploymentUnit
createDeploymentUnit(String deploymentId,
                     JaxbDeploymentDescriptor descriptor)



          Create a KModuleDeploymentUnit instance using the given information



 javax.ws.rs.core.Response
deploy(JaxbDeploymentDescriptor deployDescriptor)



          Queues a request to deploy the given deployment unit.



 javax.ws.rs.core.Response
getConfig()



          Retrieve the status of the DeploymentUnit specified in the URL.



 javax.ws.rs.core.Response
undeploy()



          Queues a request to undeploy the deployment unit specified in the URL


 
Methods inherited from class org.kie.remote.services.rest.ResourceBase
convertProcAssetDescToJaxbProcDef, convertStringListToStatusList, convertTaskToTaskSummary, createCorrectVariant, createCorrectVariant, extractMapFromParams, getEnum, getLongListParam, getMaxNumResultsNeeded, getNumberParam, getObjectParam, getOrganizationalEntityListFromParams, getPageNumAndPageSize, getRelativePath, getRequestParams, getStringListParam, getStringParam, getVariant, paginate, paginateAndCreateResult, paginateAndCreateResult, restProcessJaxbCommandsRequest
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 





Constructor Detail



DeploymentResource
public DeploymentResource()






Method Detail



createDeploymentUnit
protected org.jbpm.kie.services.impl.KModuleDeploymentUnit createDeploymentUnit(String deploymentId,
                                                                                JaxbDeploymentDescriptor descriptor)

Create a KModuleDeploymentUnit instance using the given information


Parameters:
deploymentId - The deployment id
descriptor - The optional JaxbDeploymentDescriptor instance with additional information
Returns:
The KModuleDeploymentUnit instance





getConfig
public javax.ws.rs.core.Response getConfig()

Retrieve the status of the DeploymentUnit specified in the URL.



Returns:
A JaxbDeploymentUnit instance





deploy
public javax.ws.rs.core.Response deploy(JaxbDeploymentDescriptor deployDescriptor)

Queues a request to deploy the given deployment unit. If the deployment already exist, this
 operation will fail.


Parameters:
deployDescriptor - An optional DeploymentDescriptor instance specifying additional information about how
                         the deployment unit should be deployed.
Returns:
A JaxbDeploymentJobResult instance with the initial status of the job





undeploy
public javax.ws.rs.core.Response undeploy()

Queues a request to undeploy the deployment unit specified in the URL



Returns:
A JaxbDeploymentJobResult instance with the initial status of the job