de.cinovo.cloudconductor.api.interfaces

Interface IPackage

@Path(value="/package")
 @Produces(value="application/json;charset=UTF-8")
 @Consumes(value="application/json;charset=UTF-8")
public interface IPackage

Copyright 2017 Cinovo AG

Author:

psigloch

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	get(int page, int pageSize, javax.ws.rs.core.UriInfo uriInfo)
Package	get(java.lang.String pkgName)
PackageStateChanges	getPackageChanges(java.lang.String hostUuid) Get the package difference between the host and its template
java.util.Map<java.lang.String,java.lang.String>	getUsage(java.lang.String pkgname)
PackageVersion[]	getVersions(java.lang.String pkgname) Get the existing package versions of a package
PackageVersion[]	getVersionsForRepo(java.lang.String repoName) Get the existing package versions of a repo

Method Detail

get

@GET
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS"})
javax.ws.rs.core.Response get(@DefaultValue(value="0") @QueryParam(value="page")
                                                                                                       int page,
                                                                                                       @DefaultValue(value="0") @QueryParam(value="per_page")
                                                                                                       int pageSize,
                                                                                                       @Context
                                                                                                       javax.ws.rs.core.UriInfo uriInfo)

Parameters:

page - the number of the page

pageSize - the number of packages per page

uriInfo - the uri info

Returns:

response including page of packages

get

@GET
 @Path(value="/{pkg}")
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS"})
Package get(@PathParam(value="pkg")
                                                                                                            java.lang.String pkgName)

Parameters:

pkgName - the name of the package

Returns:

the package

getVersions

@GET
 @Path(value="/{pkg}/versions")
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS"})
PackageVersion[] getVersions(@PathParam(value="pkg")
                                                                                                                                      java.lang.String pkgname)

Get the existing package versions of a package

Parameters:

pkgname - the package name

Returns:

collection of package versions

getUsage

@GET
 @Path(value="/{pkg}/usage")
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS"})
java.util.Map<java.lang.String,java.lang.String> getUsage(@PathParam(value="pkg")
                                                                                                                                                                java.lang.String pkgname)

Parameters:

pkgname - the package name

Returns:

map of template-packageVersion pairs

getVersionsForRepo

@GET
 @Path(value="/versions/repo/{repo}")
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS"})
PackageVersion[] getVersionsForRepo(@PathParam(value="repo")
                                                                                                                                                   java.lang.String repoName)

Get the existing package versions of a repo

Parameters:

repoName - the repo name

Returns:

collection of package versions

getPackageChanges

@GET
 @Path(value="/changes/{host}")
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS"})
PackageStateChanges getPackageChanges(@PathParam(value="host")
                                                                                                                                               java.lang.String hostUuid)

Get the package difference between the host and its template

Parameters:

hostUuid - the host uuid

Returns:

collection of package changes