com.psoft.hsphere.axis
Interface DomainServices_PortType

All Superinterfaces:
java.rmi.Remote

public interface DomainServices_PortType
extends java.rmi.Remote


Method Summary
 void add3RdLevelDomain(AuthToken at, java.lang.String name)
           
 void addDomain(AuthToken at, java.lang.String name)
          Adds a domain already registered with a Domain Registrar to the system.
 void addDomainAlias(AuthToken at, java.lang.String alias, java.lang.String domain, boolean isDNS, boolean isMailAlias)
          Adds domain alias.
 void addDomainWithoutWebMailServices(AuthToken at, java.lang.String name)
          Adds a domain already registered with a Domain Registrar to the system.
 void addDomainWithServiceOptions(AuthToken at, java.lang.String name, ServiceOptions serviceOptions)
          Adds a domain already registered with a Domain Registrar to the system.
 void addNoDomain(AuthToken at)
          Adds nodomain resource.
 void addParkedDomain(AuthToken at, java.lang.String name, java.lang.String ip)
          Adds parked domain.
 void addServiceDomain(AuthToken at, java.lang.String name)
          Adds service domain.
 void addSubDomain(AuthToken at, java.lang.String name, java.lang.String domain)
          Adds subdomain.
 void deleteDomain(AuthToken at, java.lang.String name)
          Deletes domain.
 void deleteDomainAlias(AuthToken at, java.lang.String name)
          Deletes domain alias.
 void deleteHosting(AuthToken at, java.lang.String domainName, boolean deleteContent)
          Deletes the hosting resource for the specified domain.
 void deleteHostingAlias(AuthToken at, java.lang.String domainName)
          Deletes the hosting alias resource for the specified domain.
 void deleteMailService(AuthToken at, java.lang.String domainName)
          Deletes the mail service resource for the specified domain.
 void deleteMailServiceAlias(AuthToken at, java.lang.String domainName)
          Deletes the mail service resource for the specified domain.
 void deleteParkedDomain(AuthToken at, java.lang.String name)
          Deletes parked domain.
 void deleteSubDomain(AuthToken at, java.lang.String name, java.lang.String domain)
          Deeletes subdomain.
 void enableHosting(AuthToken at, java.lang.String domainName)
          Turns on the "hosting" resource for the specified domain
 void enableHostingAlias(AuthToken at, java.lang.String aliasDomainName, java.lang.String actualDomainName)
          Turns on the "hosting alias" resource for the specified domain to refer to the domain specified by the argument 'actualDomainName'.
 void enableMailService(AuthToken at, java.lang.String domainName)
          Turns on the "mail_service" resource for the specified domain
 void enableMailServiceAlias(AuthToken at, java.lang.String aliasDomainName, java.lang.String actualDomainName)
          Turns on the "mail service alias" resource for the specified domain to refer to the domain specified by the argument 'actualDomainName'.
 java.lang.String getDescription()
          Returns description of the class
 java.lang.String getHostingAlias(AuthToken at, java.lang.String domainName)
          In case the specified domain contains the "hosting alias" resource, the method returns the domain name for the actual hosting resource the above alias points to.
 java.lang.Object[] getHostingAliasesForActualDomain(AuthToken at, java.lang.String domainName)
          Retrieves list of hosting aliases (as domain names) for the domain containing the actual hosting resource (the aliases point to this resource).
 java.lang.String getMailServiceAlias(AuthToken at, java.lang.String domainName)
          In case the specified domain contains the "mail service alias" resource, the method returns the domain name for the actual hosting resource the above alias points to.
 java.lang.Object[] getMailServiceAliasesForActualDomain(AuthToken at, java.lang.String domainName)
          Retrieves list of mail service aliases (as domain names) for the domain containing the actual mail service resource (the aliases point to this resource).
 boolean lookup(AuthToken at, java.lang.String domainName)
          Lookups if the domain name is already registered.
 void registerDomain(AuthToken at, java.lang.String name, int period, int renew, ContactInfo ci, ContactInfo bi)
          Registers a domain with a Domain Registrar and adds it to the system.
 void registerDomainWithoutWebMailServices(AuthToken at, java.lang.String name, int period, int renew, ContactInfo ci, ContactInfo bi)
          Registers a domain with a Domain Registrar and adds it to the system.
 void registerDomainWithServiceOptions(AuthToken at, java.lang.String name, int period, int renew, ContactInfo ci, ContactInfo bi, ServiceOptions serviceOptions)
          Registers a domain with a Domain Registrar and adds it to the system.
 void transferDomain(AuthToken at, java.lang.String name, int renew, ContactInfo ci, ContactInfo bi)
          Transfers a domain with a Domain Registrar and adds it to the system.
 void transferDomainWithoutWebMailServices(AuthToken at, java.lang.String name, int renew, ContactInfo ci, ContactInfo bi)
          Transfers a domain with a Domain Registrar and adds it to the system.
 void transferDomainWithServiceOptions(AuthToken at, java.lang.String name, int renew, ContactInfo ci, ContactInfo bi, ServiceOptions serviceOptions)
          Transfers a domain with a Domain Registrar and adds it to the system.
 

Method Detail

lookup

boolean lookup(AuthToken at,
               java.lang.String domainName)
               throws java.rmi.RemoteException
Lookups if the domain name is already registered.

Parameters:
at - user authentication information
domainName - domain name
Returns:
true - if the domain name is already registered
false - if domain name is available
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

getDescription

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

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

addDomain

void addDomain(AuthToken at,
               java.lang.String name)
               throws java.rmi.RemoteException
Adds a domain already registered with a Domain Registrar to the system. Creation of Web (hosting) and Mail services when adding the domain depends on the account plan settings (most probably both "hosting" and "mail service" will be enabled automatically).

Parameters:
at - is the user authentication information
name - is the domain name
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

deleteDomain

void deleteDomain(AuthToken at,
                  java.lang.String name)
                  throws java.rmi.RemoteException
Deletes domain.

Parameters:
at - user authentication information
name - domain name
Throws:
java.lang.Exception
java.rmi.RemoteException

getHostingAlias

java.lang.String getHostingAlias(AuthToken at,
                                 java.lang.String domainName)
                                 throws java.rmi.RemoteException
In case the specified domain contains the "hosting alias" resource, the method returns the domain name for the actual hosting resource the above alias points to. Otherwise, the method returns null.

Parameters:
at -
domainName -
Returns:
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

deleteMailServiceAlias

void deleteMailServiceAlias(AuthToken at,
                            java.lang.String domainName)
                            throws java.rmi.RemoteException
Deletes the mail service resource for the specified domain.

Parameters:
at -
domainName -
Throws:
java.lang.Exception
java.rmi.RemoteException

enableMailService

void enableMailService(AuthToken at,
                       java.lang.String domainName)
                       throws java.rmi.RemoteException
Turns on the "mail_service" resource for the specified domain

Parameters:
at -
domainName -
Throws:
java.lang.Exception
java.rmi.RemoteException

addDomainWithoutWebMailServices

void addDomainWithoutWebMailServices(AuthToken at,
                                     java.lang.String name)
                                     throws java.rmi.RemoteException
Adds a domain already registered with a Domain Registrar to the system. Neither web (hosting) nor mail services will be created when adding the domain.

Parameters:
at -
name - is the domain name
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

addDomainWithServiceOptions

void addDomainWithServiceOptions(AuthToken at,
                                 java.lang.String name,
                                 ServiceOptions serviceOptions)
                                 throws java.rmi.RemoteException
Adds a domain already registered with a Domain Registrar to the system. The desired web/mail services specified in object 'serviceOptions' will be automatically enabled when adding the domain.

Parameters:
at -
name - is the domain name
serviceOptions - tells what services (hosting/hosting alias, mail, etc) need to be enabled while creating the domain resource.
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

registerDomain

void registerDomain(AuthToken at,
                    java.lang.String name,
                    int period,
                    int renew,
                    ContactInfo ci,
                    ContactInfo bi)
                    throws java.rmi.RemoteException
Registers a domain with a Domain Registrar and adds it to the system. Creation of Web (hosting) and Mail services when adding the domain depends on the account plan settings (most probably both "hosting" and "mail service" will be enabled automatically).

Parameters:
at - user authentication information
name - domain name
period - domain registration period (years)
renew - domain renewal mode.
0 - manual renew
1..n - automatic renew. renewal period (years)
ci - registrar contact info
bi - registrar billing info
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

registerDomainWithoutWebMailServices

void registerDomainWithoutWebMailServices(AuthToken at,
                                          java.lang.String name,
                                          int period,
                                          int renew,
                                          ContactInfo ci,
                                          ContactInfo bi)
                                          throws java.rmi.RemoteException
Registers a domain with a Domain Registrar and adds it to the system. Neither web (hosting) nor mail services will be created when adding the domain.

Parameters:
at - is AuthToken
name - is the domain name
period - is how many years the domain is registered for
renew: - 0 means renew the domain manually; a number more or equal to 1 means automatic renewal for the specified number of years.
ci - is the owner Contact Information
bi - is the Billing Information
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

registerDomainWithServiceOptions

void registerDomainWithServiceOptions(AuthToken at,
                                      java.lang.String name,
                                      int period,
                                      int renew,
                                      ContactInfo ci,
                                      ContactInfo bi,
                                      ServiceOptions serviceOptions)
                                      throws java.rmi.RemoteException
Registers a domain with a Domain Registrar and adds it to the system. The desired web/mail services specified in object 'serviceOptions' will be automatically enabled when adding the domain.

Parameters:
at - is AuthToken
name - is the domain name
period - is how many years the domain is registered for
renew: - 0 means renew the domain manually; a number more or equal to 1 means automatic renewal for the specified number of years.
ci - is the owner Contact Information
bi - is the Billing Information
serviceOptions -
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

transferDomain

void transferDomain(AuthToken at,
                    java.lang.String name,
                    int renew,
                    ContactInfo ci,
                    ContactInfo bi)
                    throws java.rmi.RemoteException
Transfers a domain with a Domain Registrar and adds it to the system. Creation of Web (hosting) and Mail services when adding the domain depends on the account plan settings (most probably both "hosting" and "mail service" will be enabled automatically).

Parameters:
at - user authentication information
name - domain name
renew - domain renewal mode.
0 - manual renew
-1 - expired domain
1..n - automatic renew. renewal period (years)
ci - registrar contact info
bi - registrar billing info
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

transferDomainWithoutWebMailServices

void transferDomainWithoutWebMailServices(AuthToken at,
                                          java.lang.String name,
                                          int renew,
                                          ContactInfo ci,
                                          ContactInfo bi)
                                          throws java.rmi.RemoteException
Transfers a domain with a Domain Registrar and adds it to the system. Neither web (hosting) nor mail services will be created when adding the domain.

Parameters:
at - is AuthToken
name - is the domain name
renew: - 0 means renew the domain manually; a number more or equal to 1 means automatic renewal for the specified number of years.
ci - is the owner Contact Information
bi - is the Billing Information
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

transferDomainWithServiceOptions

void transferDomainWithServiceOptions(AuthToken at,
                                      java.lang.String name,
                                      int renew,
                                      ContactInfo ci,
                                      ContactInfo bi,
                                      ServiceOptions serviceOptions)
                                      throws java.rmi.RemoteException
Transfers a domain with a Domain Registrar and adds it to the system. The desired web/mail services specified in object 'serviceOptions' will be automatically enabled when adding the domain.

Parameters:
at - is AuthToken
name - is the domain name
renew: - 0 means renew the domain manually; a number more or equal to 1 means automatic renewal for the specified number of years.
ci - is the owner Contact Information
bi - is the Billing Information
serviceOptions -
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

add3RdLevelDomain

void add3RdLevelDomain(AuthToken at,
                       java.lang.String name)
                       throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

addServiceDomain

void addServiceDomain(AuthToken at,
                      java.lang.String name)
                      throws java.rmi.RemoteException
Adds service domain.

Parameters:
at - user authentication information
name - service domain name
Throws:
java.lang.Exception
java.rmi.RemoteException

addSubDomain

void addSubDomain(AuthToken at,
                  java.lang.String name,
                  java.lang.String domain)
                  throws java.rmi.RemoteException
Adds subdomain.

Parameters:
at - user authentication information
name - subdomain name
domain - domain name
Throws:
java.lang.Exception
java.rmi.RemoteException

addNoDomain

void addNoDomain(AuthToken at)
                 throws java.rmi.RemoteException
Adds nodomain resource.

Parameters:
at - user authentication information
Throws:
java.lang.Exception
java.rmi.RemoteException

deleteSubDomain

void deleteSubDomain(AuthToken at,
                     java.lang.String name,
                     java.lang.String domain)
                     throws java.rmi.RemoteException
Deeletes subdomain.

Parameters:
at - user authentication information
name - subdomain name
domain - domain name
Throws:
java.lang.Exception
java.rmi.RemoteException

addParkedDomain

void addParkedDomain(AuthToken at,
                     java.lang.String name,
                     java.lang.String ip)
                     throws java.rmi.RemoteException
Adds parked domain.

Parameters:
at - user authentication information
name - domain name
ip - domain's IP address
Throws:
java.lang.Exception
java.rmi.RemoteException

deleteParkedDomain

void deleteParkedDomain(AuthToken at,
                        java.lang.String name)
                        throws java.rmi.RemoteException
Deletes parked domain.

Parameters:
at - user authentication information
name - domain name
Throws:
java.lang.Exception
java.rmi.RemoteException

addDomainAlias

void addDomainAlias(AuthToken at,
                    java.lang.String alias,
                    java.lang.String domain,
                    boolean isDNS,
                    boolean isMailAlias)
                    throws java.rmi.RemoteException
Adds domain alias.

Parameters:
at - user authentication information
alias - domain alias name
domain - domain name
isDNS -
isMailAlias -
Throws:
java.lang.Exception
java.rmi.RemoteException

deleteDomainAlias

void deleteDomainAlias(AuthToken at,
                       java.lang.String name)
                       throws java.rmi.RemoteException
Deletes domain alias.

Parameters:
at - user authentication information
name - domain alias name
Throws:
java.lang.Exception
java.rmi.RemoteException

enableHosting

void enableHosting(AuthToken at,
                   java.lang.String domainName)
                   throws java.rmi.RemoteException
Turns on the "hosting" resource for the specified domain

Parameters:
at -
domainName -
Throws:
java.lang.Exception
java.rmi.RemoteException

enableHostingAlias

void enableHostingAlias(AuthToken at,
                        java.lang.String aliasDomainName,
                        java.lang.String actualDomainName)
                        throws java.rmi.RemoteException
Turns on the "hosting alias" resource for the specified domain to refer to the domain specified by the argument 'actualDomainName'.

Parameters:
at -
aliasDomainName -
actualDomainName -
Throws:
java.lang.Exception
java.rmi.RemoteException

enableMailServiceAlias

void enableMailServiceAlias(AuthToken at,
                            java.lang.String aliasDomainName,
                            java.lang.String actualDomainName)
                            throws java.rmi.RemoteException
Turns on the "mail service alias" resource for the specified domain to refer to the domain specified by the argument 'actualDomainName'. Note. This method will always create a mail service alias with automatic DNS configuration.

Parameters:
at -
aliasDomainName -
actualDomainName -
Throws:
java.lang.Exception
java.rmi.RemoteException

deleteHosting

void deleteHosting(AuthToken at,
                   java.lang.String domainName,
                   boolean deleteContent)
                   throws java.rmi.RemoteException
Deletes the hosting resource for the specified domain.

Parameters:
at -
domainName -
deleteContent - set to true if you need to delete the web site content
Throws:
java.lang.Exception
java.rmi.RemoteException

deleteMailService

void deleteMailService(AuthToken at,
                       java.lang.String domainName)
                       throws java.rmi.RemoteException
Deletes the mail service resource for the specified domain.

Parameters:
at -
domainName -
Throws:
java.lang.Exception
java.rmi.RemoteException

deleteHostingAlias

void deleteHostingAlias(AuthToken at,
                        java.lang.String domainName)
                        throws java.rmi.RemoteException
Deletes the hosting alias resource for the specified domain.

Parameters:
at -
domainName -
Throws:
java.lang.Exception
java.rmi.RemoteException

getMailServiceAlias

java.lang.String getMailServiceAlias(AuthToken at,
                                     java.lang.String domainName)
                                     throws java.rmi.RemoteException
In case the specified domain contains the "mail service alias" resource, the method returns the domain name for the actual hosting resource the above alias points to. Otherwise, the method returns null.

Parameters:
at -
domainName -
Returns:
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

getHostingAliasesForActualDomain

java.lang.Object[] getHostingAliasesForActualDomain(AuthToken at,
                                                    java.lang.String domainName)
                                                    throws java.rmi.RemoteException
Retrieves list of hosting aliases (as domain names) for the domain containing the actual hosting resource (the aliases point to this resource). In case there is no "hosting" resource created for the specified domain, the method throws AxisFault exception.

Parameters:
at -
domain -
Returns:
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException

getMailServiceAliasesForActualDomain

java.lang.Object[] getMailServiceAliasesForActualDomain(AuthToken at,
                                                        java.lang.String domainName)
                                                        throws java.rmi.RemoteException
Retrieves list of mail service aliases (as domain names) for the domain containing the actual mail service resource (the aliases point to this resource). In case there is no "mail service" resource created for the specified domain, the method throws AxisFault exception.

Parameters:
at -
domain -
Returns:
Throws:
AxisFault
java.lang.Exception
java.rmi.RemoteException


Copyright © 2005 Positive Software Corporation. All Rights Reserved.