net.bluemind.domain.service.internal

Class DomainsService

java.lang.Object

net.bluemind.domain.service.internal.DomainsService

All Implemented Interfaces:

IDomains

public class DomainsService
extends java.lang.Object
implements IDomains

Constructor Summary

Constructors

Constructor and Description
DomainsService(BmContext context, Container installationContainer)

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.
protected void	doSetAliases(ItemValue<Domain> domainItem, java.util.Set<java.lang.String> previousAliases, IServerTaskMonitor monitor)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainsService

public DomainsService(BmContext context,
                      Container installationContainer)

Method Detail

create

public void create(java.lang.String uid,
                   Domain domain)

Description copied from interface: IDomains

Creates a new Domain.

Specified by:

create in interface IDomains

domain - Domain

update

public void update(java.lang.String uid,
                   Domain domain)

Description copied from interface: IDomains

Modify an existing Domain.

Specified by:

update in interface IDomains

Parameters:

uid - Domain's unique id

domain - updated Domain

delete

public void delete(java.lang.String uid)

Description copied from interface: IDomains

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.

Specified by:

delete in interface IDomains

Parameters:

uid - Domain's unique id

deleteDomainItems

public TaskRef deleteDomainItems(java.lang.String uid)

Description copied from interface: IDomains

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.

Specified by:

deleteDomainItems in interface IDomains

Parameters:

uid - Domain's unique id

Returns:

a TaskRef to track operation progress

get

public ItemValue<Domain> get(@PathParam(value="uid")
                             java.lang.String uid)

Description copied from interface: IDomains

Fetch a Domain by its uid.

Specified by:

get in interface IDomains

Parameters:

uid - Domain's unique id

Returns:

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

all

public java.util.List<ItemValue<Domain>> all()

Description copied from interface: IDomains

Fetch all domains.

Specified by:

all in interface IDomains

Returns:

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

setAliases

public TaskRef setAliases(java.lang.String uid,
                          java.util.Set<java.lang.String> aliases)

Description copied from interface: IDomains

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.

Specified by:

setAliases in interface IDomains

Parameters:

uid - Domain's unique id

aliases - set of aliases

Returns:

a TaskRef to track operation progress

doSetAliases

protected void doSetAliases(ItemValue<Domain> domainItem,
                            java.util.Set<java.lang.String> previousAliases,
                            IServerTaskMonitor monitor)

setDefaultAlias

public void setDefaultAlias(java.lang.String uid,
                            java.lang.String defaultAlias)

Description copied from interface: IDomains

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.

Specified by:

setDefaultAlias in interface IDomains

Parameters:

uid - Domain's unique id

defaultAlias - default domain name

findByNameOrAliases

public ItemValue<Domain> findByNameOrAliases(java.lang.String name)

Description copied from interface: IDomains

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

Specified by:

findByNameOrAliases in interface IDomains

Parameters:

name - Domain's name or alias

Returns:

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

setRoles

public void setRoles(java.lang.String uid,
                     java.util.Set<java.lang.String> roles)

Specified by:

setRoles in interface IDomains

getRoles

public java.util.Set<java.lang.String> getRoles(java.lang.String uid)

Specified by:

getRoles in interface IDomains