net.bluemind.domain.api

Interface IDomains

All Known Implementing Classes:

DomainsService

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

Manage domain.

Method Summary

Modifier and Type	Method and Description
java.util.List<ItemValue<Domain>>	all() Fetch all domains.
void	create(java.lang.String uid, Domain domain) Creates a new Domain.
void	delete(java.lang.String uid) Delete the Domain item itself.
TaskRef	deleteDomainItems(java.lang.String uid) Delete data linked to the Domain.
ItemValue<Domain>	findByNameOrAliases(java.lang.String name) Fetch a Domain by its name or one of its alias.
ItemValue<Domain>	get(java.lang.String uid) Fetch a Domain by its uid.
java.util.Set<java.lang.String>	getRoles(java.lang.String uid)
TaskRef	setAliases(java.lang.String uid, java.util.Set<java.lang.String> aliases) Define domain aliases.
void	setDefaultAlias(java.lang.String uid, java.lang.String defaultAlias) Define the domain default alias.
void	setRoles(java.lang.String uid, java.util.Set<java.lang.String> roles)
void	update(java.lang.String uid, Domain domain) Modify 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 new Domain.

Parameters:

{@link - Domain}'s unique id

domain - Domain

Throws:

ServerFault - standard error object

update

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

Modify an existing Domain.

Parameters:

uid - Domain's unique id

domain - updated Domain

Throws:

ServerFault - standard error object

delete

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

Delete the Domain item itself. You must call first deleteDomainItems to delete domain's data. This operation is forbidden if there are still linked data.

Parameters:

uid - Domain's unique id

Throws:

ServerFault - standard error object

deleteDomainItems

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

Delete data linked to the Domain. You must call this operation before deleting the domain itself. According to the data quantity this operation can be very long, you can follow its progression with the returned TaskRef.

Parameters:

uid - Domain's unique id

Returns:

a TaskRef to track operation progress

Throws:

ServerFault - standard error object

get

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

Fetch a Domain by its uid.

Parameters:

uid - Domain's unique id

Returns:

Domain net.bluemind.core.container.api.ItemValue, or null if the Domain does not exist

Throws:

ServerFault - standard error object

all

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

Fetch all domains.

Returns:

a list of all Domain net.bluemind.core.container.api.ItemValue managed by the server

Throws:

ServerFault - standard error object

setAliases

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

Define domain aliases. If your domain already has aliases, you need to fetch them first and then call this setAliases operation with all desired aliases.

Parameters:

uid - Domain's unique id

aliases - set of aliases

Returns:

a TaskRef to track operation progress

Throws:

ServerFault - standard error object

setDefaultAlias

@POST
 @Path(value="{uid}/_default_alias")
void setDefaultAlias(@PathParam(value="uid")
                                                                java.lang.String uid,
                                                                java.lang.String defaultAlias)
                                                         throws ServerFault

Define the domain default alias. The default alias is the name which appears in the adminconsole when adding/modifying a domain "name". The default alias is used as the default domain name to use when creating a new email account. The default alias must be contained within the domain aliases.

Parameters:

uid - Domain's unique id

defaultAlias - default domain name

Throws:

ServerFault - standard error object

findByNameOrAliases

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

Fetch a Domain by its name or one of its alias.

Parameters:

name - Domain's name or alias

Returns:

Domain net.bluemind.core.container.api.ItemValue, or null if no Domain match

Throws:

ServerFault - standard error object

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