com.xebialabs.deployit.engine.api

Interface RepositoryService

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

Provides access to the XL Deploy repository.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ConfigurationItemId>	candidateValues(java.lang.String propertyName, java.lang.String namePattern, long page, long resultPerPage, com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci) Find candidate values for a property of a ConfigurationItem.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	copy(java.lang.String ID, java.lang.String newLocation) Copy a configuration item in the repository.
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	create(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> configurationItems) Creates multiple configuration items.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	create(java.lang.String ID, ArtifactAndData artifactAndData) Creates a new artifact CI with data.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	create(java.lang.String ID, com.xebialabs.deployit.plugin.api.udm.ConfigurationItem configurationItem) Creates a new configuration item.
void	delete(java.lang.String ID) Deletes a configuration item.
void	deleteList(java.util.List<java.lang.String> ids) Deletes multiple configuration items from the repository.
java.lang.Boolean	exists(java.lang.String ID) Checks if a configuration item exists.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	move(java.lang.String ID, java.lang.String newLocation) Moves a configuration item in the repository.
java.util.List<ConfigurationItemId>	query(com.xebialabs.deployit.plugin.api.reflect.Type type, java.lang.String parent, java.lang.String ancestor, java.lang.String namePattern, org.joda.time.DateTime lastModifiedBefore, org.joda.time.DateTime lastModifiedAfter, long page, long resultPerPage) Retrieves configuration items by way of a query.
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	read(java.util.List<java.lang.String> ids) Reads multiple configuration items from the repository.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	read(java.lang.String ID) Reads a configuration item from the repository.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	rename(java.lang.String ID, java.lang.String newName) Changes the name of a configuration item in the repository.
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	update(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> configurationItems) Modifies multiple configuration items.
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	update(java.lang.String ID, ArtifactAndData artifactAndData) Modifies an artifact (upload new data) and returns the updated artifact if the the update was successful
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	update(java.lang.String ID, com.xebialabs.deployit.plugin.api.udm.ConfigurationItem configurationItem) Modifies a configuration item and returns the updated CI if the the update was successful
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	validate(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> cis) Validate the configuration items, returning any validation errors found.

Method Detail

read

@GET
@Path(value="ci/{ID:.*?}")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem read(@PathParam(value="ID")
                                                                    java.lang.String ID)

Reads a configuration item from the repository.

Parameters:

ID - the ID of the CI

Returns:

the CI, or a 404 error code if not found.

Permission:

read

create

@POST
@Path(value="ci/{ID:.*?}")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem create(@PathParam(value="ID")
                                                                       java.lang.String ID,
                                                                       com.xebialabs.deployit.plugin.api.udm.ConfigurationItem configurationItem)

Creates a new configuration item.

Parameters:

ID - the ID/path of the new CI.

configurationItem - the data of the CI.

Returns:

the newly created CI

Permission:

repo#edit

create

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

Creates a new artifact CI with data.

Parameters:

ID - the ID/path of the new artifact.

artifactAndData - the data of the artifact.

Returns:

the newly created artifact

Permission:

repo#edit

update

@PUT
@Path(value="ci/{ID:.*?}")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem update(@PathParam(value="ID")
                                                                      java.lang.String ID,
                                                                      com.xebialabs.deployit.plugin.api.udm.ConfigurationItem configurationItem)

Modifies a configuration item and returns the updated CI if the the update was successful

Parameters:

ID - the ID of the CI to modify.

configurationItem - the new data of the CI.

Returns:

the updated CI if update was successful

RestDetails:

otherwise returns a 409 error code if the CI has been updated on the server and you are sending modifications on an old version.

Permission:

repo#edit

ApiDetails:

otherwise throws a RuntimeException if the CI has been updated on the server and you are sending modifications on an old version.

update

@PUT
@Path(value="ci/{ID:.*?}")
@Consumes(value="multipart/form-data")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem update(@PathParam(value="ID")
                                                                               java.lang.String ID,
                                                                               ArtifactAndData artifactAndData)

Modifies an artifact (upload new data) and returns the updated artifact if the the update was successful

Parameters:

ID - the ID of the artifact to modify.

artifactAndData - the new data of the artifact.

Returns:

the updated artifact if update was successful

RestDetails:

otherwise returns a 409 error code if the CI has been updated on the server and you are sending modifications on an old version.

Permission:

repo#edit

ApiDetails:

otherwise throws a RuntimeException if the CI has been updated on the server and you are sending modifications on an old version.

delete

@DELETE
@Path(value="ci/{ID:.*?}")
void delete(@PathParam(value="ID")
                      java.lang.String ID)

Deletes a configuration item.

Parameters:

ID - the ID of the CI to delete.

Permission:

repo#edit, import#remove

deleteList

@POST
@Path(value="cis/delete")
void deleteList(java.util.List<java.lang.String> ids)

Deletes multiple configuration items from the repository.

Parameters:

ids - the ids of the CIs

Permission:

repo#edit, import#remove

read

@POST
@Path(value="cis/read")
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> read(java.util.List<java.lang.String> ids)

Reads multiple configuration items from the repository.

Parameters:

ids - the ids of the CIs

Returns:

the CIs

RestDetails:

Returns a 404 error code if one of them was not found.

Permission:

read

ApiDetails:

Throws RuntimeException if one of them was not found.

create

@POST
@Path(value="cis")
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> create(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> configurationItems)

Creates multiple configuration items.

Parameters:

configurationItems - the data of the CIs.

Returns:

the newly created CIs

Permission:

repo#edit

update

@PUT
@Path(value="cis")
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> update(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> configurationItems)

Modifies multiple configuration items.

Parameters:

configurationItems - the new data of the CIs.

Returns:

the updated CIs if the update was successful

RestDetails:

Returns 409 error code if one of the CIs has been updated on the server and you are sending modifications on an old version.

Permission:

repo#edit

ApiDetails:

Throws RuntimeException if one of the CIs has been updated on the server and you are sending modifications on an old version.

exists

@GET
@Path(value="exists/{ID:.*?}")
java.lang.Boolean exists(@PathParam(value="ID")
                                java.lang.String ID)

Checks if a configuration item exists.

Parameters:

ID - the ID of the CI to check

Returns:

true if the CI exists, false if not.

move

@POST
@Path(value="move/{ID:.*?}")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem move(@PathParam(value="ID")
                                                                     java.lang.String ID,
                                                                     @QueryParam(value="newId")
                                                                     java.lang.String newLocation)

Moves a configuration item in the repository.

Parameters:

ID - the ID of the CI to move

newLocation - the new ID of the CI, reflecting the path in the repository.

Returns:

the moved CI

Permission:

repo#edit

copy

@POST
@Path(value="copy/{ID:.*?}")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem copy(@PathParam(value="ID")
                                                                     java.lang.String ID,
                                                                     @QueryParam(value="newId")
                                                                     java.lang.String newLocation)

Copy a configuration item in the repository. The item as well as all its children are copied to the new location. The parent reflected in the new location, must be of the same type as that of the parent of the item being copied.

Parameters:

ID - the ID of the CI to copy

newLocation - the new ID of the copied CI, reflecting the path in the repository.

Returns:

the copied CI

Permission:

repo#edit

rename

@POST
@Path(value="rename/{ID:.*?}")
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem rename(@PathParam(value="ID")
                                                                       java.lang.String ID,
                                                                       @QueryParam(value="newName")
                                                                       java.lang.String newName)

Changes the name of a configuration item in the repository.

Parameters:

ID - the ID of the CI to rename

newName - the new name.

Returns:

the renamed CI

Permission:

repo#edit

query

@GET
@Path(value="query")
java.util.List<ConfigurationItemId> query(@QueryParam(value="type")
                                                 com.xebialabs.deployit.plugin.api.reflect.Type type,
                                                 @QueryParam(value="parent")
                                                 java.lang.String parent,
                                                 @QueryParam(value="ancestor")
                                                 java.lang.String ancestor,
                                                 @QueryParam(value="namePattern")
                                                 java.lang.String namePattern,
                                                 @QueryParam(value="lastModifiedBefore")
                                                 org.joda.time.DateTime lastModifiedBefore,
                                                 @QueryParam(value="lastModifiedAfter")
                                                 org.joda.time.DateTime lastModifiedAfter,
                                                 @QueryParam(value="page")
                                                 long page,
                                                 @QueryParam(value="resultsPerPage")
                                                 long resultPerPage)

Retrieves configuration items by way of a query. All parameters are optional.

Parameters:

type - the type of the CI

parent - the parent ID of the CI. If set, only the direct children of this CI are searched.

ancestor - the ancestor ID of the CI. If set, only the subtree of this CI is searched.

namePattern - a search pattern for the name. This is like the SQL "LIKE" pattern: the character '%' represents any string of zero or more characters, and the character '_' (underscore) represents any single character. Any literal use of these two characters must be escaped with a backslash ('\'). Consequently, any literal instance of a backslash must also be escaped, resulting in a double backslash ('\\').

lastModifiedBefore - look for CIs modified before this date.

lastModifiedAfter - look for CIs modified after this date.

page - the desired page, in case of a paged query.

resultPerPage - the page size, or -1 for no paging.

Returns:

a list of references to CIs

candidateValues

@POST
@Path(value="candidate-values")
java.util.List<ConfigurationItemId> candidateValues(@QueryParam(value="propertyName")
                                                            java.lang.String propertyName,
                                                            @QueryParam(value="namePattern")
                                                            java.lang.String namePattern,
                                                            @QueryParam(value="page")
                                                            long page,
                                                            @QueryParam(value="resultsPerPage")
                                                            long resultPerPage,
                                                            com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)

Find candidate values for a property of a ConfigurationItem.

Parameters:

propertyName - the property name of the ConfigurationItem for which to find candidate values

namePattern - a search pattern for the name. This is like the SQL "LIKE" pattern: the character '%' represents any string of zero or more characters, and the character '_' (underscore) represents any single character. Any literal use of these two characters must be escaped with a backslash ('\'). Consequently, any literal instance of a backslash must also be escaped, resulting in a double backslash ('\\').

page - the desired page, in case of a paged query.

resultPerPage - the page size, or -1 for no paging.

ci - The ConfigurationItem for which to find the candidate values

Returns:

a list of references to CIs

validate

@POST
@Path(value="validate")
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> validate(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> cis)

Validate the configuration items, returning any validation errors found.

Parameters:

cis - The list of configuration items to valdiate.

Returns:

The validated configuration items, including any validation messages.