Package org.openstack4j.api.identity.v3

Interface ProjectService

All Superinterfaces:

RestService

All Known Implementing Classes:

ProjectServiceImpl

public interface ProjectService
extends RestService

Identity Project Service

Method Summary

Modifier and Type	Method	Description
Project	create(String domainId, String name, String description, boolean enabled)	Creates a new Project
Project	create(Project project)	Creates a new Project
ActionResponse	delete(String projectId)	delete a project by id
Project	get(String projectId)	get detailed information on a project
List<? extends Project>	getByName(String projectName)	get detailed information about projects machting specified name across all domains
Project	getByName(String projectName, String domainId)	get detailed information about a project specified by project name and domain id
List<? extends Project>	list()	list all projects the current token has access to
Project	update(Project project)	updates an existing project

Method Detail

create

Project create(Project project)

Creates a new Project

Parameters:

project - the project to create

Returns:

the new Project including it's id

create

Project create(String domainId,
               String name,
               String description,
               boolean enabled)

Creates a new Project

Parameters:

domainId - the domain id

name - the name of the new project

description - the description of the new project

enabled - the enabled status of the new project

Returns:

the newly created project

get

Project get(String projectId)

get detailed information on a project

Parameters:

projectId - the project id

Returns:

the project

getByName

List<? extends Project> getByName(String projectName)

get detailed information about projects machting specified name across all domains

Parameters:

projectName - the project name

Returns:

the list of projects matching the name across all domains

getByName

Project getByName(String projectName,
                  String domainId)

get detailed information about a project specified by project name and domain id

Parameters:

projectName - the project name

domainId - the domain id

Returns:

the project or null if not found

update

Project update(Project project)

updates an existing project

Parameters:

project - the project set to update

Returns:

the updated project

delete

ActionResponse delete(String projectId)

delete a project by id

Parameters:

projectId - the project id

Returns:

the ActionResponse

list

List<? extends Project> list()

list all projects the current token has access to

Returns:

list of projects