com.github.narcissujsk.openstackjsk.api.compute.ext.FloatingIPDNSEntryService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openstackjsk Show documentation

OpenStack Java API

The newest version!

package com.github.narcissujsk.openstackjsk.api.compute.ext;

import java.util.List;

import com.github.narcissujsk.openstackjsk.common.RestService;
import com.github.narcissujsk.openstackjsk.model.common.ActionResponse;
import com.github.narcissujsk.openstackjsk.model.compute.ext.DNSEntry;
import com.github.narcissujsk.openstackjsk.model.compute.ext.DNSRecordType;

/**
 * A Service which handles DNS Entries for the Floating IP DNS Extension
 * 
 * @author Jeremy Unruh
 */
public interface FloatingIPDNSEntryService extends RestService {

    /**
     * Return a list of entries for the given domain and IP Address
     * 
     * @param domain the FQ Domain name
     * @param ip the IP Address
     * @return List of DNS Entries
     */
    List listByIP(String domain, String ip);
    
    /**
     * Return a list of entries for the given domain and name
     * 
     * @param domain the FQ Domain name
     * @param name DNS entry name assigned under a domain
     * @return List of DNS Entries
     */
    List listByName(String domain, String name);
    
    /**
     * Creates or Updates a DNS Entry
     * 
     * @param domain the FQ Domain name 
     * @param name DNS entry name assigned under a domain
     * @param ip the IP Address associated with the current entry
     * @param type the DNS Record Type
     * @return the created or modified DNSEntry
     */
    DNSEntry create(String domain, String name, String ip, DNSRecordType type);
    
    /**
     * Modifies the IP Address for the specified domain and name
     * 
     * @param domain the FQ Domain name 
     * @param name DNS entry name assigned under a domain
     * @param ip the new IP Address
     * @return the modified DNSEntry
     */
    DNSEntry modifyIP(String domain, String name, String ip);
    
    /**
     * Deletes a specified DNS entry
     *  
     * @param domain the FQ Domain name 
     * @param name DNS entry name assigned under a domain
     * @return the action response
     */
    ActionResponse delete(String domain, String name);
}