net.bluemind.domain.api

Interface IDomains

All Known Implementing Classes:

DomainsService

@Path(value="/domains")
public interface IDomains

Method Summary

Modifier and Type	Method and Description
java.util.List<ItemValue<Domain>>	all() Retrieve all domains
void	create(java.lang.String uid, Domain domain) Creates a domain
void	delete(java.lang.String uid) Deletes an existing domain
TaskRef	deleteDomainItems(java.lang.String uid)
ItemValue<Domain>	findByNameOrAliases(java.lang.String name)
ItemValue<Domain>	get(java.lang.String uid)
java.util.Set<java.lang.String>	getRoles(java.lang.String uid)
TaskRef	setAliases(java.lang.String domainUid, java.util.Set<java.lang.String> aliases)
void	setRoles(java.lang.String uid, java.util.Set<java.lang.String> roles)
void	update(java.lang.String uid, Domain domain) Modifies an existing domain

Method Detail

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       Domain domain)
                                throws ServerFault

Creates a domain

Parameters:

domain -

Throws:

ServerFault

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        Domain domain)
                                 throws ServerFault

Modifies an existing domain

Parameters:

domain -

Throws:

ServerFault

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Deletes an existing domain

Throws:

ServerFault

deleteDomainItems

@DELETE
 @Path(value="{uid}/_items")
TaskRef deleteDomainItems(@PathParam(value="uid")
                                                               java.lang.String uid)
                                                        throws ServerFault

Throws:

ServerFault

get

@GET
 @Path(value="{uid}")
ItemValue<Domain> get(@PathParam(value="uid")
                                                 java.lang.String uid)
                                          throws ServerFault

Throws:

ServerFault

all

@GET
java.util.List<ItemValue<Domain>> all()
                                    throws ServerFault

Retrieve all domains

Returns:

Throws:

ServerFault

setAliases

@POST
 @Path(value="{uid}/_aliases")
TaskRef setAliases(@PathParam(value="uid")
                                                        java.lang.String domainUid,
                                                        java.util.Set<java.lang.String> aliases)
                                                 throws ServerFault

Throws:

ServerFault

findByNameOrAliases

@GET
 @Path(value="_lookup")
ItemValue<Domain> findByNameOrAliases(@QueryParam(value="name")
                                                                   java.lang.String name)
                                                            throws ServerFault

Throws:

ServerFault

setRoles

@POST
 @Path(value="{uid}/roles")
void setRoles(@PathParam(value="uid")
                                                java.lang.String uid,
                                                java.util.Set<java.lang.String> roles)
                                         throws ServerFault

Throws:

ServerFault

getRoles

@GET
 @Path(value="{uid}/roles")
java.util.Set<java.lang.String> getRoles(@PathParam(value="uid")
                                                                          java.lang.String uid)
                                                                   throws ServerFault

Throws:

ServerFault