OrganizationApi (Apache jclouds 2.1.0 API)

All Superinterfaces:

AutoCloseable, ChefApi, Closeable
```
@Consumes(value="application/json")
public interface OrganizationApi
extends ChefApi
```
Provides synchronous access to the Enterprise Chef Api.

Method Summary

Methods
Modifier and Type	Method and 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 Detail

getUser

@Named(value="user:get")
@GET
@Path(value="/users/{name}")
User getUser(@PathParam(value="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(value="group:list")
@GET
@Path(value="/groups")
Set<String> listGroups()

List all existing groups.

Returns:: The list of groups.

getGroup

@Named(value="group:get")
@GET
@Path(value="/groups/{name}")
Group getGroup(@PathParam(value="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(value="group:create")
@POST
@Path(value="/groups")
void createGroup(String name)

Creates a new group.

Parameters:: name - The name of the group to create.

updateGroup

@Named(value="group:update")
@PUT
@Path(value="/groups/{name}")
void updateGroup(@PathParam(value="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(value="group:delete")
@DELETE
@Path(value="/groups/{name}")
void deleteGroup(@PathParam(value="name")
                                 String name)

Deletes a group.

Parameters:: name - The name of the group to delete.

Interface OrganizationApi