de.cinovo.cloudconductor.api.interfaces

Interface IFile

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

Copyright 2013 Cinovo AG

Author:

psigloch

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String name)
ConfigFile[]	get()
ConfigFile	get(java.lang.String name)
ConfigFile[]	getConfigFiles(java.lang.String template)
java.lang.String	getData(java.lang.String name)
void	save(ConfigFile fileToSave)
void	saveData(java.lang.String name, java.lang.String data)

Method Detail

get

@GET
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS","USE_AGENT_API"})
ConfigFile[] get()

Returns:

all configuration files

save

@PUT
 @RolesAllowed(value="EDIT_CONFIGURATIONS")
void save(ConfigFile fileToSave)

Parameters:

fileToSave - the file to be saved

get

@GET
 @Path(value="/{name}")
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS","USE_AGENT_API"})
ConfigFile get(@PathParam(value="name")
                                                                                                                                java.lang.String name)

Parameters:

name - the name of the file

Returns:

the configuration file with the given name

delete

@DELETE
 @Path(value="/{name}")
 @RolesAllowed(value="EDIT_CONFIGURATIONS")
void delete(@PathParam(value="name")
                                                                                        java.lang.String name)

Parameters:

name - the name of the file to be deleted

getData

@GET
 @Path(value="/{name}/data")
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS","USE_AGENT_API"})
java.lang.String getData(@PathParam(value="name")
                                                                                                                                               java.lang.String name)

Parameters:

name - the file name

Returns:

the data of the file

saveData

@PUT
 @Path(value="/{name}/data")
 @RolesAllowed(value="EDIT_CONFIGURATIONS")
 @Consumes(value={"text/plain","application/json;charset=UTF-8"})
void saveData(@PathParam(value="name")
                                                                                                                                                              java.lang.String name,
                                                                                                                                                              java.lang.String data)

Parameters:

name - the file name

data - the file data to save

getConfigFiles

@GET
 @Path(value="/template/{template}")
 @RolesAllowed(value={"VIEW_CONFIGURATIONS","EDIT_CONFIGURATIONS","USE_AGENT_API"})
ConfigFile[] getConfigFiles(@PathParam(value="template")
                                                                                                                                                          java.lang.String template)

Parameters:

template - the name of the template

Returns:

the configuration files for the given template