com.psoft.hsphere.axis
Interface DNSServices_PortType

All Superinterfaces:
java.rmi.Remote

public interface DNSServices_PortType
extends java.rmi.Remote


Method Summary
 void addARecord(AuthToken at, java.lang.String zoneName, java.lang.String prefix, java.lang.String ip, java.lang.String ttl)
          Creates A record for service DNS zone.
 void addCNAMERecord(AuthToken at, java.lang.String zoneName, java.lang.String prefix, java.lang.String ip, java.lang.String ttl)
          Creates CNAME record for service DNS zone.
 void addDNSZone(AuthToken at, java.lang.String zoneName, java.lang.String admEmail, boolean allowThirdDomainLevelHosting, long masterServer)
          Creates service DNS zone.
 void addInstantAlias(AuthToken at, java.lang.String zoneName, java.lang.String prefix, int tag)
          Creates instant alias.
 void addMXRecord(AuthToken at, java.lang.String zoneName, java.lang.String prefix, java.lang.String ip, java.lang.String priority)
          Creates MX record for service DNS zone.
 void addResellerCPAlias(AuthToken at, java.lang.String zoneName, java.lang.String prefix)
          Creates reseller CP alias template.
 void addUserCustomARecord(AuthToken at, java.lang.String zoneName, java.lang.String prefix, java.lang.String ttl, java.lang.String ip)
          Creates custom A DNS record for the user from AuthToken.
 void addUserCustomCNAMERecord(AuthToken at, java.lang.String zoneName, java.lang.String prefix, java.lang.String ttl, java.lang.String ip)
          Creates custom CNAME DNS record for the user from AuthToken.
 void addUserCustomMXRecord(AuthToken at, java.lang.String zoneName, java.lang.String prefix, java.lang.String priority, java.lang.String ip)
          Creates custom MX DNS record for the user from AuthToken.
 void delCustomDNSRecord(AuthToken at, java.lang.String zoneName, java.lang.String prefix, java.lang.String type)
          Deletes DNS record from service zone.
 void delDNSZone(AuthToken at, java.lang.String zoneName)
          Deletes service DNS zone.
 void delInstantAlias(AuthToken at, java.lang.String zoneName, java.lang.String prefix, int tag)
          Deletes instant alias.
 void delResellerCPAlias(AuthToken at, java.lang.String zoneName, java.lang.String prefix)
          Deletes reseller CP alias template.
 void delUserCustomRecord(AuthToken at, java.lang.String fullRecordname)
          Deletes custom DNS record for the user from AuthToken.
 java.lang.String getAdminEmailForZone(AuthToken at, java.lang.String zoneName)
          Returns admin email address to service DNS zone.
 DNSRecordInfo[] getAllCustomDNSRecords(AuthToken at, java.lang.String zoneName)
          Retrieves all custom records of service DNS zone.
 java.lang.String[] getAllInstantAliases(AuthToken at, java.lang.String zoneName)
          Retrieves instant aliases for service DNS zone.
 java.lang.String[] getAllResellerCPAliases(AuthToken at, java.lang.String zoneName)
          Retrieves reseller CP aliases for service DNS zone.
 DNSRecordInfo[] getAllUserCustomDNSRecords(AuthToken at, java.lang.String zoneName)
          Retrieves all custom records of DNS zone for the user from AuthToken.
 java.lang.String[] getAllUserZones(AuthToken at)
          Retrieves all DNS zone names for the user from AuthToken.
 java.lang.Object[] getAllZones(AuthToken at)
          Retrieves all service DNS zones.
 DNSRecordInfo[] getBuiltinARecords(AuthToken at, java.lang.String domainName)
          Retrieves all builtin A records for the user from AuthToken.
 DNSRecordInfo[] getBuiltinCNAMERecords(AuthToken at, java.lang.String domainName)
          Retrieves all builtin CNAME records for the user from AuthToken.
 DNSRecordInfo[] getBuiltinMXRecords(AuthToken at, java.lang.String domainName)
          Retrieves all builtin MX records for the user from AuthToken.
 java.lang.String getDescription()
          Returns description of the class
 boolean isAllowHosting(AuthToken at, java.lang.String zoneName)
          Returns true if third level domain hosting allowed for chosen DNS zone.
 void setAllowHosting(AuthToken at, java.lang.String zoneName, boolean allowThirdDomainLevelHosting)
          Enable or disable third level domain hosting for chosen DNS zone.
 

Method Detail

getDescription

java.lang.String getDescription()
                                throws java.rmi.RemoteException
Returns description of the class

Returns:
description of the class
Throws:
java.rmi.RemoteException

addDNSZone

void addDNSZone(AuthToken at,
                java.lang.String zoneName,
                java.lang.String admEmail,
                boolean allowThirdDomainLevelHosting,
                long masterServer)
                throws java.rmi.RemoteException
Creates service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
admEmail - service DNS zone admin email,
format: username.domainLn...domainL1 (use dot (.) instead of commercial at (@))
allowThirdDomainLevelHosting - allow third level domain hosting for this DNS zone
masterServer - logical DNS server ID that will be master server for this DNS zone
Throws:
java.lang.Exception
java.rmi.RemoteException

setAllowHosting

void setAllowHosting(AuthToken at,
                     java.lang.String zoneName,
                     boolean allowThirdDomainLevelHosting)
                     throws java.rmi.RemoteException
Enable or disable third level domain hosting for chosen DNS zone.

Parameters:
at - user authentication information.
zoneName - DNS zone name, format: xxx.yyy.zzz ...
allowThirdDomainLevelHosting - true - for enabling third level domain hosting, false - otherwise.
Throws:
java.lang.Exception
java.rmi.RemoteException

delDNSZone

void delDNSZone(AuthToken at,
                java.lang.String zoneName)
                throws java.rmi.RemoteException
Deletes service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
Throws:
java.lang.Exception
java.rmi.RemoteException

isAllowHosting

boolean isAllowHosting(AuthToken at,
                       java.lang.String zoneName)
                       throws java.rmi.RemoteException
Returns true if third level domain hosting allowed for chosen DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
Returns:
true - if third level domain hosting allowed for this DNS zone,
false - otherwise.
Throws:
java.lang.Exception
java.rmi.RemoteException

getAllZones

java.lang.Object[] getAllZones(AuthToken at)
                               throws java.rmi.RemoteException
Retrieves all service DNS zones.

Parameters:
at - user authentication information.
Returns:
array of serice DNS zone names.
Throws:
java.lang.Exception
java.rmi.RemoteException

getAdminEmailForZone

java.lang.String getAdminEmailForZone(AuthToken at,
                                      java.lang.String zoneName)
                                      throws java.rmi.RemoteException
Returns admin email address to service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
Returns:
admin email address to service DNS zone.
Throws:
java.lang.Exception
java.rmi.RemoteException

addARecord

void addARecord(AuthToken at,
                java.lang.String zoneName,
                java.lang.String prefix,
                java.lang.String ip,
                java.lang.String ttl)
                throws java.rmi.RemoteException
Creates A record for service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
prefix - the string appended to the zone name to create a FQDN mapped to the IP,
format: alphanumeric value.
ip - the IP address that fully qualified domain name will be mapped to,
format: 4 groups of decimal digits separated with a dot.
ttl - TTL (seconds to elapse before the record is refreshed in the provider's DNS cache),
format: 5 digits.
Throws:
java.lang.Exception
java.rmi.RemoteException

addMXRecord

void addMXRecord(AuthToken at,
                 java.lang.String zoneName,
                 java.lang.String prefix,
                 java.lang.String ip,
                 java.lang.String priority)
                 throws java.rmi.RemoteException
Creates MX record for service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
prefix - the string appended to the zone name to create a FQDN mapped to the IP,
format: alphanumeric value.
ip - the IP address that fully qualified domain name will be mapped to,
format: 4 groups of decimal digits separated with a dot.
priority - the priority of the record and mail domain name (not the IP) mail will be forwarded to,
format: integer value from 1 to 99
Throws:
java.lang.Exception
java.rmi.RemoteException

addCNAMERecord

void addCNAMERecord(AuthToken at,
                    java.lang.String zoneName,
                    java.lang.String prefix,
                    java.lang.String ip,
                    java.lang.String ttl)
                    throws java.rmi.RemoteException
Creates CNAME record for service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
prefix - the string appended to the zone name to create a FQDN mapped to the IP,
format: alphanumeric value.
ip - name of the server to which you are creating the alias record format: xxx.yyy.zzz ...
ttl - TTL (seconds to elapse before the record is refreshed in the provider's DNS cache),
format: 5 digits.
Throws:
java.lang.Exception
java.rmi.RemoteException

delCustomDNSRecord

void delCustomDNSRecord(AuthToken at,
                        java.lang.String zoneName,
                        java.lang.String prefix,
                        java.lang.String type)
                        throws java.rmi.RemoteException
Deletes DNS record from service zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
prefix - the string appended to the zone name to create a FQDN mapped to the IP,
format: alphanumeric value.
type - DNS record type, format: A, MX, CNAME or TXT.
Throws:
java.lang.Exception
java.rmi.RemoteException

addInstantAlias

void addInstantAlias(AuthToken at,
                     java.lang.String zoneName,
                     java.lang.String prefix,
                     int tag)
                     throws java.rmi.RemoteException
Creates instant alias. It will automatically add one or more A-DNS records to your service zone. These records resolve all your logical servers.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
prefix - instant alias prefix that will appear on the left to the domain part in user's instant domain alias,
format: alphanumeric value.
tag - a digital "mark" that helps separate sites within one plan on one logical server, format: numbers 10 to 99 are acceptable, the default value of 2 is assigned when the field is submitted being empty.
Throws:
java.lang.Exception
java.rmi.RemoteException

delInstantAlias

void delInstantAlias(AuthToken at,
                     java.lang.String zoneName,
                     java.lang.String prefix,
                     int tag)
                     throws java.rmi.RemoteException
Deletes instant alias.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
prefix - instant alias prefix that will appear on the left to the domain part in user's instant domain alias,
format: alphanumeric value.
tag - tag a digital "mark" that helps separate sites within one plan on one logical server, format: numbers 10 to 99 are acceptable, the default value of 2 is assigned when the field is submitted being empty.
Throws:
java.lang.Exception
java.rmi.RemoteException

addResellerCPAlias

void addResellerCPAlias(AuthToken at,
                        java.lang.String zoneName,
                        java.lang.String prefix)
                        throws java.rmi.RemoteException
Creates reseller CP alias template. It is temporary addresses that are used to access reseller control panels until they are changed to resellers' own URLs. Reseller CP Alias Template is one for all resellers.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
prefix - prefix helps to distinguish which DNS zone will service the temporary reseller cp alias when you proceed to creating reseller plans, format: alphanumeric value.
Throws:
java.lang.Exception
java.rmi.RemoteException

delResellerCPAlias

void delResellerCPAlias(AuthToken at,
                        java.lang.String zoneName,
                        java.lang.String prefix)
                        throws java.rmi.RemoteException
Deletes reseller CP alias template.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
prefix - prefix helps to distinguish which DNS zone will service the temporary reseller cp alias when you proceed to creating reseller plans, format: alphanumeric value.
Throws:
java.lang.Exception
java.rmi.RemoteException

getAllCustomDNSRecords

DNSRecordInfo[] getAllCustomDNSRecords(AuthToken at,
                                       java.lang.String zoneName)
                                       throws java.rmi.RemoteException
Retrieves all custom records of service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
Returns:
array of DNSRecordInfo objects
Throws:
java.lang.Exception
java.rmi.RemoteException

getAllInstantAliases

java.lang.String[] getAllInstantAliases(AuthToken at,
                                        java.lang.String zoneName)
                                        throws java.rmi.RemoteException
Retrieves instant aliases for service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
Returns:
array of Strings with instant alias prefix values.
Throws:
java.lang.Exception
java.rmi.RemoteException

getAllResellerCPAliases

java.lang.String[] getAllResellerCPAliases(AuthToken at,
                                           java.lang.String zoneName)
                                           throws java.rmi.RemoteException
Retrieves reseller CP aliases for service DNS zone.

Parameters:
at - user authentication information.
zoneName - service DNS zone name, format: xxx.yyy.zzz ...
Returns:
array of Strings with reseller CP aliases.
Throws:
java.lang.Exception
java.rmi.RemoteException

getBuiltinARecords

DNSRecordInfo[] getBuiltinARecords(AuthToken at,
                                   java.lang.String domainName)
                                   throws java.rmi.RemoteException
Retrieves all builtin A records for the user from AuthToken.

Parameters:
at - user authentication information.
domainName - domain name, format: xxx.yyy.zzz ...
Returns:
array of DNSRecordInfo objects.
Throws:
java.lang.Exception
java.rmi.RemoteException

getBuiltinMXRecords

DNSRecordInfo[] getBuiltinMXRecords(AuthToken at,
                                    java.lang.String domainName)
                                    throws java.rmi.RemoteException
Retrieves all builtin MX records for the user from AuthToken.

Parameters:
at - user authentication information.
domainName - domain name, format: xxx.yyy.zzz ...
Returns:
array of DNSRecordInfo objects.
Throws:
java.lang.Exception
java.rmi.RemoteException

getBuiltinCNAMERecords

DNSRecordInfo[] getBuiltinCNAMERecords(AuthToken at,
                                       java.lang.String domainName)
                                       throws java.rmi.RemoteException
Retrieves all builtin CNAME records for the user from AuthToken.

Parameters:
at - user authentication information.
domainName - domain name, format: xxx.yyy.zzz ...
Returns:
array of DNSRecordInfo objects.
Throws:
java.lang.Exception
java.rmi.RemoteException

getAllUserZones

java.lang.String[] getAllUserZones(AuthToken at)
                                   throws java.rmi.RemoteException
Retrieves all DNS zone names for the user from AuthToken.

Parameters:
at - user authentication information.
Returns:
array of Strings with DNS zone names.
Throws:
java.lang.Exception
java.rmi.RemoteException

addUserCustomARecord

void addUserCustomARecord(AuthToken at,
                          java.lang.String zoneName,
                          java.lang.String prefix,
                          java.lang.String ttl,
                          java.lang.String ip)
                          throws java.rmi.RemoteException
Creates custom A DNS record for the user from AuthToken.

Parameters:
at - user authentication information.
zoneName - DNS zone name, format: xxx.yyy.zzz ...
prefix - the string appended to the DNS zone name to create a FQDN mapped to the IP,
format: alphanumeric value.
ttl - TTL (seconds to elapse before the record is refreshed in the provider's DNS cache),
format: 5 digits.
ip - the IP address that fully qualified domain name will be mapped to,
format: 4 groups of decimal digits separated with a dot.
Throws:
java.lang.Exception
java.rmi.RemoteException

addUserCustomMXRecord

void addUserCustomMXRecord(AuthToken at,
                           java.lang.String zoneName,
                           java.lang.String prefix,
                           java.lang.String priority,
                           java.lang.String ip)
                           throws java.rmi.RemoteException
Creates custom MX DNS record for the user from AuthToken.

Parameters:
at - user authentication information.
zoneName - DNS zone name, format: xxx.yyy.zzz ...
prefix - the string appended to the zone name to create a FQDN mapped to the IP,
format: alphanumeric value.
priority - the priority of the record and mail domain name (not the IP) mail will be forwarded to,
format: integer value from 1 to 99
ip - the IP address that fully qualified domain name will be mapped to,
format: 4 groups of decimal digits separated with a dot.
Throws:
java.lang.Exception
java.rmi.RemoteException

addUserCustomCNAMERecord

void addUserCustomCNAMERecord(AuthToken at,
                              java.lang.String zoneName,
                              java.lang.String prefix,
                              java.lang.String ttl,
                              java.lang.String ip)
                              throws java.rmi.RemoteException
Creates custom CNAME DNS record for the user from AuthToken.

Parameters:
at - user authentication information.
zoneName - DNS zone name, format: xxx.yyy.zzz ...
prefix - the string appended to the zone name to create a FQDN mapped to the IP,
format: alphanumeric value.
ttl - TTL (seconds to elapse before the record is refreshed in the provider's DNS cache),
format: 5 digits.
ip - name of the server to which you are creating the alias record format: xxx.yyy.zzz ...
Throws:
java.lang.Exception
java.rmi.RemoteException

delUserCustomRecord

void delUserCustomRecord(AuthToken at,
                         java.lang.String fullRecordname)
                         throws java.rmi.RemoteException
Deletes custom DNS record for the user from AuthToken.

Parameters:
at - user authentication information.
fullRecordname - DNS record name, format: xxx.yyy.zzz ...
Throws:
java.lang.Exception
java.rmi.RemoteException

getAllUserCustomDNSRecords

DNSRecordInfo[] getAllUserCustomDNSRecords(AuthToken at,
                                           java.lang.String zoneName)
                                           throws java.rmi.RemoteException
Retrieves all custom records of DNS zone for the user from AuthToken.

Parameters:
at - user authentication information.
zoneName - DNS zone name, format: xxx.yyy.zzz ...
Returns:
array of DNSRecordInfo objects.
Throws:
java.lang.Exception
java.rmi.RemoteException


Copyright © 2005 Positive Software Corporation. All Rights Reserved.