Interface DomainApi


  • public interface DomainApi
    Provides synchronous access to Domain requests.

    See Also:
    • Method Detail

      • list

        @Named("domain:list")
        @POST
        @Path("/domain/list/format/json")
        @Consumes("application/json")
        com.google.common.collect.FluentIterable<Domain> list()
        Get a list of all domains for this account.
        Returns:
        an account's associated domain objects.
      • get

        @Named("domain:details")
        @POST
        @Path("/domain/details/format/json")
        @Consumes("application/json")
        Domain get​(@FormParam("domainname")
                   String name)
        Get a specific domain.
        Returns:
        the requested domain object.
      • create

        @Named("domain:add")
        @POST
        @Path("/domain/add/format/json")
        @Consumes("application/json")
        Domain create​(@FormParam("domainname")
                      String name,
                      AddDomainOptions... options)
        Add a domain to the Glesys dns-system
        Parameters:
        name - the name of the domain to add.
        options - optional parameters
        Returns:
        information about the added domain
      • update

        @Named("domain:edit")
        @POST
        @Path("/domain/edit/format/json")
        @Consumes("application/json")
        Domain update​(@FormParam("domainname")
                      String domain,
                      DomainOptions options)
        Update a domain to the Glesys dns-system
        Parameters:
        domain - the name of the domain to add.
        options - optional parameters
        Returns:
        information about the modified domain
      • delete

        @Named("domain:delete")
        @POST
        @Path("/domain/delete/format/json")
        void delete​(@FormParam("domainname")
                    String domain)
        Remove a domain to the Glesys dns-system
        Parameters:
        domain - the name of the domain to remove
      • listRecords

        @Named("domain:listrecords")
        @POST
        @Path("/domain/listrecords/format/json")
        @Consumes("application/json")
        Set<DomainRecord> listRecords​(@FormParam("domainname")
                                      String domain)
        Retrieve the DNS records for a given domain
        Parameters:
        domain - the name of the domain to retrieve records for
      • createRecord

        @Named("domain:addrecord")
        @POST
        @Path("/domain/addrecord/format/json")
        @Consumes("application/json")
        DomainRecord createRecord​(@FormParam("domainname")
                                  String domain,
                                  @FormParam("host")
                                  String host,
                                  @FormParam("type")
                                  String type,
                                  @FormParam("data")
                                  String data,
                                  AddRecordOptions... options)
        Add a DNS Record
        Parameters:
        domain - the domain to add the record to
        options - optional settings for the record
      • updateRecord

        @Named("domain:updaterecord")
        @POST
        @Path("/domain/updaterecord/format/json")
        @Consumes("application/json")
        DomainRecord updateRecord​(@FormParam("recordid")
                                  String recordId,
                                  UpdateRecordOptions options)
        Modify a specific DNS Record
        Parameters:
        recordId - the id for the record to edit
        options - the settings to change
        See Also:
        to retrieve the necessary ids
      • deleteRecord

        @Named("domain:deleterecord")
        @POST
        @Path("/domain/deleterecord/format/json")
        void deleteRecord​(@FormParam("recordid")
                          String recordId)
        Delete a DNS record
        Parameters:
        recordId - the id for the record to delete
        See Also:
        to retrieve the necessary ids