Package uk.num.numlib.internal.module

Class ModuleDNSQueries

java.lang.Object

uk.num.numlib.internal.module.ModuleDNSQueries

public class ModuleDNSQueries
extends java.lang.Object

Class to hold the DNS query strings for a module and domain name/URL/email address combination.

Constructor Summary

Constructors

Constructor	Description
ModuleDNSQueries(java.lang.String moduleId, java.lang.String domainName)	Constructor

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDomainName()	Accessor
java.lang.String	getIndependentRecordLocation()	Accessor
java.lang.String	getManagedRecordLocation()	Accessor
java.lang.String	getModuleId()	Accessor
java.lang.String	getPopulatorLocation()	Accessor
java.lang.String	getPrepopulatedRecordLocation()	Accessor
void	initialise()	Build the DNS query Strings and set the root/branch flag.
boolean	isRootQuery()	Accessor
void	setIndependentRecordLocation(java.lang.String location)	Set the independent record location to a specific value.
void	setManagedRecordLocation(java.lang.String location)	Override the managed record location, usually due to a redirect
void	setPrepopulatedRecordLocation(java.lang.String location)	Override the prepopulated record location, usually due to a redirect
void	setRelativeRedirectIndependentRecordLocation(java.lang.String redirect, int levels)	Change the independent record location due to a redirect.
void	setRelativeRedirectManagedRecordLocation(java.lang.String redirect, int levels)	Change the managed record location due to a redirect.
void	setRelativeRedirectPrepopulatedRecordLocation(java.lang.String redirect, int levels)	Change the pre-poulated record location due to a redirect.
void	setRootRedirectIndependentRecordLocation(java.lang.String redirectTo)	Change the independent record location due to a redirect.
void	setRootRedirectManagedRecordLocation(java.lang.String redirect)	Change the managed record location due to a redirect.
void	setRootRedirectPrepopulatedRecordLocation(java.lang.String redirect)	Change the pre-populated record location due to a redirect.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModuleDNSQueries

public ModuleDNSQueries(java.lang.String moduleId,
                        java.lang.String domainName)
                 throws NumInvalidParameterException

Constructor

Parameters:

moduleId - the module ID string

domainName - the domain name/URL string/email address.

Throws:

NumInvalidParameterException - on error

Method Detail

isRootQuery

public boolean isRootQuery()

Accessor

Returns:

true if this is a root query

initialise

public void initialise()
                throws NumBadURLException,
                       NumInvalidParameterException

Build the DNS query Strings and set the root/branch flag.

Throws:

NumBadURLException - on error

NumInvalidParameterException - on error

getModuleId

public java.lang.String getModuleId()

Accessor

Returns:

the module ID string

getDomainName

public java.lang.String getDomainName()

Accessor

Returns:

the domain name/URL/email address

getIndependentRecordLocation

public java.lang.String getIndependentRecordLocation()

Accessor

Returns:

the independent record query string.

setIndependentRecordLocation

public void setIndependentRecordLocation(java.lang.String location)

Set the independent record location to a specific value.

Parameters:

location - the new independent record location

getManagedRecordLocation

public java.lang.String getManagedRecordLocation()

Accessor

Returns:

the managed record query string

setManagedRecordLocation

public void setManagedRecordLocation(java.lang.String location)

Override the managed record location, usually due to a redirect

Parameters:

location - the new location

getPrepopulatedRecordLocation

public java.lang.String getPrepopulatedRecordLocation()

Accessor

Returns:

the pre-populated record query string.

setPrepopulatedRecordLocation

public void setPrepopulatedRecordLocation(java.lang.String location)

Override the prepopulated record location, usually due to a redirect

Parameters:

location - the prepopulated record location

getPopulatorLocation

public java.lang.String getPopulatorLocation()

Accessor

Returns:

the populator query string

setRootRedirectIndependentRecordLocation

public void setRootRedirectIndependentRecordLocation(java.lang.String redirectTo)
                                              throws NumInvalidParameterException,
                                                     NumBadURLException,
                                                     NumInvalidRedirectException

Change the independent record location due to a redirect.

Parameters:

redirectTo - the root-relative branch record to use.

Throws:

NumInvalidParameterException - on error

NumBadURLException - on error

NumInvalidRedirectException - on error

setRelativeRedirectIndependentRecordLocation

public void setRelativeRedirectIndependentRecordLocation(java.lang.String redirect,
                                                         int levels)
                                                  throws NumInvalidRedirectException,
                                                         NumInvalidParameterException,
                                                         NumBadURLException

Change the independent record location due to a redirect.

Parameters:

redirect - the relative branch record to use.

levels - the number of levels to go up before adding the redirect location

Throws:

NumInvalidRedirectException - on error

NumInvalidParameterException - on error

NumBadURLException - on error

setRootRedirectManagedRecordLocation

public void setRootRedirectManagedRecordLocation(java.lang.String redirect)
                                          throws NumInvalidParameterException,
                                                 NumBadURLException,
                                                 NumInvalidRedirectException

Change the managed record location due to a redirect.

Parameters:

redirect - the root-relative branch record to use.

Throws:

NumInvalidParameterException - on error

NumBadURLException - on error

NumInvalidRedirectException - on error

setRelativeRedirectManagedRecordLocation

public void setRelativeRedirectManagedRecordLocation(java.lang.String redirect,
                                                     int levels)
                                              throws NumInvalidRedirectException,
                                                     NumInvalidParameterException,
                                                     NumBadURLException

Change the managed record location due to a redirect.

Parameters:

redirect - the relative branch record to use.

levels - the number of levels to go up before adding the redirect location

Throws:

NumInvalidRedirectException - on error

NumInvalidParameterException - on error

NumBadURLException - on error

setRootRedirectPrepopulatedRecordLocation

public void setRootRedirectPrepopulatedRecordLocation(java.lang.String redirect)
                                               throws NumBadURLException,
                                                      NumInvalidParameterException,
                                                      NumInvalidRedirectException

Change the pre-populated record location due to a redirect.

Parameters:

redirect - the root-relative branch record to use.

Throws:

NumBadURLException - on error

NumInvalidParameterException - on error

NumInvalidRedirectException - on error

setRelativeRedirectPrepopulatedRecordLocation

public void setRelativeRedirectPrepopulatedRecordLocation(java.lang.String redirect,
                                                          int levels)
                                                   throws NumBadURLException,
                                                          NumInvalidParameterException,
                                                          NumInvalidRedirectException

Change the pre-poulated record location due to a redirect.

Parameters:

redirect - the relative branch record to use.

levels - the number of levels to go up before adding the redirect location

Throws:

NumBadURLException - on error

NumInvalidParameterException - on error

NumInvalidRedirectException - on error