com.xebialabs.deployit.engine.api

Interface PackageService

@Path(value="/package")
@Consumes(value={"application/xml","application/json"})
@Produces(value={"application/xml","application/json"})
public interface PackageService

Manages Deployment Packages.

Method Summary

Methods

Modifier and Type	Method and Description
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	fetch(ImportFromUrlParams params) Fetches a package from a URL outside of the XL Deploy Server.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	fetch(java.lang.String url) Deprecated. Use fetch(ImportFromUrlParams)
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	importPackage(java.lang.String file) Imports a package that is present in the importablePackages directory on the XL Deploy Server.
java.util.List<java.lang.String>	list() Lists all packages that are present in the importablePackages directory on the XL Deploy Server.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	upload(java.lang.String file, FileUpload form) Uploads a package to the XL Deploy Server.

Method Detail

list

@GET
@Path(value="import")
java.util.List<java.lang.String> list()

Lists all packages that are present in the importablePackages directory on the XL Deploy Server.

Returns:

List of names of packages that can be imported.

importPackage

@POST
@Path(value="import/{file:.*?}")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem importPackage(@PathParam(value="file")
                                                                              java.lang.String file)

Imports a package that is present in the importablePackages directory on the XL Deploy Server.

Parameters:

file - The name of the package to import

Returns:

The udm.Version CI that is created after importing.

Permission:

import#initial for importing the first version of a package, import#upgrade if another version of the package already exists

fetch

@Deprecated
@POST
@Path(value="fetch")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem fetch(java.lang.String url)

Deprecated. Use fetch(ImportFromUrlParams)

Fetches a package from a URL outside of the XL Deploy Server.

Parameters:

url - The URL to import from

Returns:

The udm.Version CI that is created after importing.

Permission:

import#initial for importing the first version of a package, import#upgrade if another version of the package already exists

fetch

@POST
@Path(value="fetch2")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem fetch(ImportFromUrlParams params)

Fetches a package from a URL outside of the XL Deploy Server. Supports authentication

Parameters:

params - The import URL parameters

Returns:

The udm.Version CI that is created after importing.

Permission:

import#initial for importing the first version of a package, import#upgrade if another version of the package already exists

upload

@POST
@Path(value="upload/{file:.*?}")
@Consumes(value="multipart/form-data")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem upload(@PathParam(value="file")
                                                                                java.lang.String file,
                                                                                FileUpload form)

Uploads a package to the XL Deploy Server.

Parameters:

file - The name of the package to be imported

form - The upload form.

Returns:

The udm.Version CI that is created after importing.

Permission:

import#initial for importing the first version of a package, import#upgrade if another version of the package already exists