de.cinovo.cloudconductor.api.interfaces

Interface ITemplate

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

Copyright 2017 Cinovo AG

Author:

psigloch

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String templateName)
Template	deletePackage(java.lang.String templateName, java.lang.String packageName)
Template[]	get()
Template	get(java.lang.String templateName)
AgentOption	getAgentOption(java.lang.String templateName)
PackageVersion[]	getPackageVersionsForTemplate(java.lang.String templateName)
Repo[]	getReposForTemplate(java.lang.String templateName)
ServiceDefaultState	getServiceDefaultState(java.lang.String templateName, java.lang.String serviceName)
ServiceDefaultState[]	getServiceDefaultStates(java.lang.String templateName)
Service[]	getServicesForTemplate(java.lang.String templateName)
SimplePackageVersion[]	getSimplePackageVersionsForTemplate(java.lang.String templateName)
SimpleTemplate[]	getSimpleTemplates()
SSHKey[]	getSSHKeysForTemplate(java.lang.String templateName)
PackageDiff[]	packageDiff(java.lang.String templateA, java.lang.String templateB)
Template	replacePackageVersionsForTemplate(java.lang.String templateName, java.util.List<SimplePackageVersion> packageVersions)
void	save(Template template)
AgentOption	saveAgentOption(java.lang.String templateName, AgentOption option)
ServiceDefaultState	saveServiceDefaultState(java.lang.String templateName, java.lang.String serviceName, ServiceDefaultState newDefaultState)
Template	updatePackage(java.lang.String templateName, java.lang.String packageName)

Method Detail

get

@GET
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
Template[] get()

Returns:

set of service objects

getSimpleTemplates

@GET
 @Path(value="/simple")
SimpleTemplate[] getSimpleTemplates()

Returns:

list of simple hosts

save

@PUT
 @RolesAllowed(value="EDIT_TEMPLATE")
void save(Template template)

Parameters:

template - the template to save

delete

@DELETE
 @Path(value="/{template}")
 @RolesAllowed(value="EDIT_TEMPLATE")
void delete(@PathParam(value="template")
                                                                                      java.lang.String templateName)

Parameters:

templateName - the template name

get

@GET
 @Path(value="/{template}")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
Template get(@PathParam(value="template")
                                                                                                      java.lang.String templateName)

Parameters:

templateName - the template name

Returns:

the template

updatePackage

@PUT
 @Path(value="/{template}/package/{pkg}")
 @RolesAllowed(value="EDIT_TEMPLATE")
Template updatePackage(@PathParam(value="template")
                                                                                                            java.lang.String templateName,
                                                                                                            @PathParam(value="pkg")
                                                                                                            java.lang.String packageName)

Parameters:

templateName - the template name

packageName - the package to update

Returns:

the updated template

deletePackage

@DELETE
 @Path(value="/{template}/package/{pkg}")
 @RolesAllowed(value="EDIT_TEMPLATE")
Template deletePackage(@PathParam(value="template")
                                                                                                               java.lang.String templateName,
                                                                                                               @PathParam(value="pkg")
                                                                                                               java.lang.String packageName)

Parameters:

templateName - the template name

packageName - the package to remove

Returns:

the updated template

getAgentOption

@GET
 @Path(value="/{template}/agentoption")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
AgentOption getAgentOption(@PathParam(value="template")
                                                                                                                                java.lang.String templateName)

Parameters:

templateName - the name of the template

Returns:

set of service objects

saveAgentOption

@PUT
 @Path(value="/{template}/agentoption")
 @RolesAllowed(value="EDIT_TEMPLATE")
AgentOption saveAgentOption(@PathParam(value="template")
                                                                                                               java.lang.String templateName,
                                                                                                               AgentOption option)

Parameters:

templateName - the name of the template

option - the agent option to set

Returns:

set of service objects

getSSHKeysForTemplate

@GET
 @Path(value="/{template}/sshkeys")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
SSHKey[] getSSHKeysForTemplate(@PathParam(value="template")
                                                                                                                                java.lang.String templateName)

Parameters:

templateName - the name of the template

Returns:

keys which belong to the given template

getServicesForTemplate

@GET
 @Path(value="/{template}/services")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
Service[] getServicesForTemplate(@PathParam(value="template")
                                                                                                                                   java.lang.String templateName)

Parameters:

templateName - the name of the template

Returns:

services which belong to the given template

getServiceDefaultStates

@GET
 @Path(value="/{template}/servicedefaultstate")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
ServiceDefaultState[] getServiceDefaultStates(@PathParam(value="template")
                                                                                                                                                           java.lang.String templateName)

Parameters:

templateName - the name of the template

Returns:

default states for all services related to the given template

getServiceDefaultState

@GET
 @Path(value="/{template}/servicedefaultstate/{service}")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
ServiceDefaultState getServiceDefaultState(@PathParam(value="template")
                                                                                                                                                                  java.lang.String templateName,
                                                                                                                                                                  @PathParam(value="service")
                                                                                                                                                                  java.lang.String serviceName)

Parameters:

templateName - the name of the template

serviceName - the name of the service

Returns:

the default state of the given service in the template

saveServiceDefaultState

@PUT
 @Path(value="/{template}/servicedefaultstate/{service}")
 @RolesAllowed(value="EDIT_TEMPLATE")
ServiceDefaultState saveServiceDefaultState(@PathParam(value="template")
                                                                                                                                                 java.lang.String templateName,
                                                                                                                                                 @PathParam(value="service")
                                                                                                                                                 java.lang.String serviceName,
                                                                                                                                                 ServiceDefaultState newDefaultState)

Parameters:

templateName - the name of the template

serviceName - the name of the service

newDefaultState - the new default state for the given service and template

Returns:

the updated default state

getReposForTemplate

@GET
 @Path(value="/{template}/repo")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
Repo[] getReposForTemplate(@PathParam(value="template")
                                                                                                                         java.lang.String templateName)

Parameters:

templateName - the name of the template

Returns:

repositories which belong to the given template

getPackageVersionsForTemplate

@GET
 @Path(value="/{template}/package/versions")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
PackageVersion[] getPackageVersionsForTemplate(@PathParam(value="template")
                                                                                                                                                         java.lang.String templateName)

Parameters:

templateName - the name of the template

Returns:

package versions used in the given template

replacePackageVersionsForTemplate

@PUT
 @Path(value="/{template}/package/versions")
 @RolesAllowed(value="EDIT_TEMPLATE")
Template replacePackageVersionsForTemplate(@PathParam(value="template")
                                                                                                                                   java.lang.String templateName,
                                                                                                                                   java.util.List<SimplePackageVersion> packageVersions)

Parameters:

templateName - name of the template to override

packageVersions - new package versions for given template

Returns:

the modified template

getSimplePackageVersionsForTemplate

@GET
 @Path(value="/{template}/package/versions/simple")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
SimplePackageVersion[] getSimplePackageVersionsForTemplate(@PathParam(value="template")
                                                                                                                                                                            java.lang.String templateName)

Parameters:

templateName - the name of the template

Returns:

package versions used in the given template without its dependencies

packageDiff

@GET
 @Path(value="/packagediff/{templateA}/{templateB}")
 @RolesAllowed(value={"VIEW_TEMPLATE","EDIT_TEMPLATE"})
PackageDiff[] packageDiff(@PathParam(value="templateA")
                                                                                                                                            java.lang.String templateA,
                                                                                                                                            @PathParam(value="templateB")
                                                                                                                                            java.lang.String templateB)

Parameters:

templateA - the name of the first template of the diff

templateB - the name of the second template of the diff

Returns:

default states for all services related to the given template