org.hawkular.accounts.backend.boundary

Class OrganizationEndpoint

java.lang.Object

org.hawkular.accounts.backend.boundary.OrganizationEndpoint

@Path(value="/organizations")
 @PermitAll
public class OrganizationEndpoint
extends Object

REST service responsible for managing Organization.

Author:

Juraci Paixão Kröhling

Constructor Summary

Constructors

Constructor and Description
OrganizationEndpoint()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createOrganization(OrganizationRequest request) Creates a new Organization based on the parameters of the incoming OrganizationRequest.
javax.ws.rs.core.Response	deleteOrganization(String id) Removes an existing Organization if the persona has permissions to do so.
javax.ws.rs.core.Response	getOrganizationsForPersona() Retrieves all organizations to which this HawkularUser has access to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrganizationEndpoint

public OrganizationEndpoint()

Method Detail

getOrganizationsForPersona

@GET
 @Path(value="/")
public javax.ws.rs.core.Response getOrganizationsForPersona()

Retrieves all organizations to which this HawkularUser has access to.

Returns:

a Response whose entity is a List of Organization

createOrganization

@POST
 @Path(value="/")
public javax.ws.rs.core.Response createOrganization(@NotNull
                                                                            OrganizationRequest request)

Creates a new Organization based on the parameters of the incoming OrganizationRequest.

Note that an organization cannot, currently, create an organization. The main Accounts API allows that, but we block it on this endpoint as other components might not be able to deal with this situation.

Parameters:

request - the incoming request as OrganizationRequest

Returns:

a Response whose entity is an Organization

deleteOrganization

@DELETE
 @Path(value="/{id}")
public javax.ws.rs.core.Response deleteOrganization(@NotNull @PathParam(value="id")
                                                                                  String id)

Removes an existing Organization if the persona has permissions to do so.

Parameters:

id - the ID of the Organization to be removed.

Returns:

an empty Response if successful or forbidden, if the persona has no access to the organization.