Package net.bluemind.domain.api

Interface IDomains

All Known Subinterfaces:
IInCoreDomains
@Path("/domains") public interface IDomains
Manage domain.

  • Method Details

    • create

      @PUT @Path("{uid}") void create(@PathParam("uid") String uid, Domain domain) throws ServerFault
      Creates a new Domain.
      Parameters:
      domain - Domain
      Throws:
      ServerFault - standard error object

    • update

      @POST @Path("{uid}") void update(@PathParam("uid") 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("{uid}") void delete(@PathParam("uid") 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("{uid}/_items") TaskRef deleteDomainItems(@PathParam("uid") 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("{uid}") ItemValue<Domain> get(@PathParam("uid") String uid) throws ServerFault
      Fetch a Domain by its uid.
      Parameters:
      uid - Domain's unique id
      Returns:
      Domain
      invalid reference 
      net.bluemind.core.container.api.ItemValue
      , or null if the Domain does not exist
      Throws:
      ServerFault - standard error object

    • all

      @GET List<ItemValue<Domain>> all() throws ServerFault
      Fetch all domains.
      Returns:
      a list of all Domain
      invalid reference 
      net.bluemind.core.container.api.ItemValue
      managed by the server
      Throws:
      ServerFault - standard error object

    • setAliases

      @POST @Path("{uid}/_aliases") TaskRef setAliases(@PathParam("uid") String uid, Set<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("{uid}/_default_alias") void setDefaultAlias(@PathParam("uid") String uid, 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("_lookup") ItemValue<Domain> findByNameOrAliases(@QueryParam("name") String name) throws ServerFault
      Fetch a Domain by its name or one of its alias.
      Parameters:
      name - Domain's name or alias
      Returns:
      Domain
      invalid reference 
      net.bluemind.core.container.api.ItemValue
      , or null if no Domain match
      Throws:
      ServerFault - standard error object

    • setRoles

      @POST @Path("{uid}/roles") void setRoles(@PathParam("uid") String uid, Set<String> roles) throws ServerFault
      Throws:
      ServerFault

    • getRoles

      @GET @Path("{uid}/roles") Set<String> getRoles(@PathParam("uid") String uid) throws ServerFault
      Throws:
      ServerFault

    • getExternalUrl

      @GET @Path("{uid}/externalurl") String getExternalUrl(@PathParam("uid") String domainUid)
      Get effective domain external-url.
      Parameters:
      domainUid - Domain's unique id
      Returns:
      domain external URL if defined, global external URL otherwisegitk