Package org.jclouds.chef.features

Interface OrganizationApi

All Superinterfaces:

AutoCloseable, ChefApi, Closeable

@Consumes("application/json")
public interface OrganizationApi
extends ChefApi

Provides synchronous access to the Enterprise Chef Api.

Method Summary

Modifier and Type	Method	Description
void	createGroup(String name)	Creates a new group.
void	deleteGroup(String name)	Deletes a group.
Group	getGroup(String name)	Retrieves an existing group.
User	getUser(String name)	Retrieves an existing user.
Set<String>	listGroups()	List all existing groups.
void	updateGroup(Group group)	Updates a group.

Methods inherited from interface org.jclouds.chef.ChefApi

chefService, commitSandbox, createClient, createClient, createDatabag, createDatabagItem, createEnvironment, createNode, createRole, createUploadSandboxForChecksums, deleteClient, deleteCookbook, deleteDatabag, deleteDatabagItem, deleteEnvironment, deleteNode, deleteRole, generateKeyForClient, getClient, getCookbook, getCookbookInEnvironment, getCookbookInEnvironment, getDatabagItem, getEnvironment, getNode, getResourceContents, getRole, listClients, listCookbooks, listCookbooksInEnvironment, listCookbooksInEnvironment, listDatabagItems, listDatabags, listEnvironments, listNodes, listNodesInEnvironment, listRecipesInEnvironment, listRoles, listSearchIndexes, listVersionsOfCookbook, organizationApi, searchClients, searchClients, searchDatabagItems, searchDatabagItems, searchEnvironments, searchEnvironments, searchNodes, searchNodes, searchRoles, searchRoles, updateCookbook, updateDatabagItem, updateEnvironment, updateNode, updateRole, uploadContent

Methods inherited from interface java.io.Closeable

close

Method Details

getUser

@Named("user:get")
@GET
@Path("/users/{name}")
User getUser(@PathParam("name")
 String name)

Retrieves an existing user.

Parameters:

name - The name of the user to get.

Returns:

The details of the user or null if not found.

listGroups

@Named("group:list")
@GET
@Path("/groups")
Set<String> listGroups()

List all existing groups.

Returns:

The list of groups.

getGroup

@Named("group:get")
@GET
@Path("/groups/{name}")
Group getGroup(@PathParam("name")
 String name)

Retrieves an existing group.

Parameters:

name - The name of the group to get.

Returns:

The details of the group or null if not found.

createGroup

@Named("group:create")
@POST
@Path("/groups")
void createGroup(String name)

Creates a new group.

Parameters:

name - The name of the group to create.

updateGroup

@Named("group:update")
@PUT
@Path("/groups/{name}")
void updateGroup(@PathParam("name")
 Group group)

Updates a group.

This method can be used to add actors (clients, groups) to the group.

Parameters:

group - The group with the updated information.

deleteGroup

@Named("group:delete")
@DELETE
@Path("/groups/{name}")
void deleteGroup(@PathParam("name")
 String name)

Deletes a group.

Parameters:

name - The name of the group to delete.