Package uk.num.numlib.internal.ctx

Class NumAPIContextBase

java.lang.Object

uk.num.numlib.internal.ctx.NumAPIContextBase

All Implemented Interfaces:

NumAPIContext

public class NumAPIContextBase
extends java.lang.Object
implements NumAPIContext

A base class implementation of NumAPIContext.

Constructor Summary

Constructors

Constructor	Description
NumAPIContextBase()

Method Summary

Modifier and Type	Method	Description
ModuleConfig	getModuleConfig()	Accessor
ModuleDNSQueries	getModuleDNSQueries()	Accessor
RequiredUserVariable[]	getRequiredUserVariables()	Modules can have required user variables that must be supplied before the NUM record csn be retrieved.
void	handleIndependentQueryRedirect(java.lang.String redirectTo)	Update the independent query for the supplied redirect
void	handleLookupRedirect(java.lang.String redirect)	Update the DNS queries for the supplied lookup redirect.
void	handleManagedQueryRedirect(java.lang.String redirectTo)	Update the managed query for the supplied redirect
void	handlePrepopulatedQueryRedirect(java.lang.String redirectTo)	Update the pre-populated query for the supplied redirect
int	incrementRedirectCount()	Count redirects and return the current number of redirects.
void	setModuleConfig(ModuleConfig moduleConfig)	Accessor
void	setModuleDNSQueries(ModuleDNSQueries moduleDNSQueries)	Accessor
void	setRequiredUserVariables(RequiredUserVariable[] requiredUserVariables)	Update the required user variables with values obtained from the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

NumAPIContextBase

public NumAPIContextBase()

Method Detail

incrementRedirectCount

public int incrementRedirectCount()

Count redirects and return the current number of redirects.

Returns:

the current number of redirects

getModuleConfig

public ModuleConfig getModuleConfig()

Accessor

Returns:

The ModuleConfig object.

setModuleConfig

public void setModuleConfig(ModuleConfig moduleConfig)

Accessor

Parameters:

moduleConfig - The ModuleConfig object.

getModuleDNSQueries

public ModuleDNSQueries getModuleDNSQueries()

Accessor

Returns:

The ModuleDNSQueries object.

setModuleDNSQueries

public void setModuleDNSQueries(ModuleDNSQueries moduleDNSQueries)

Accessor

Parameters:

moduleDNSQueries - The ModuleDNSQueries object.

getRequiredUserVariables

public RequiredUserVariable[] getRequiredUserVariables()

Modules can have required user variables that must be supplied before the NUM record csn be retrieved.

Specified by:

getRequiredUserVariables in interface NumAPIContext

Returns:

An array of objects.

setRequiredUserVariables

public void setRequiredUserVariables(RequiredUserVariable[] requiredUserVariables)
                              throws NumUserVariablesException

Update the required user variables with values obtained from the client.

Specified by:

setRequiredUserVariables in interface NumAPIContext

Parameters:

requiredUserVariables - The RequiredUserVariable array with the value fields populated.

Throws:

NumUserVariablesException - on error

handleIndependentQueryRedirect

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

Update the independent query for the supplied redirect

Parameters:

redirectTo - the supplied redirect

Throws:

NumBadURLException - on error

NumInvalidParameterException - on error

NumInvalidRedirectException - on error

handleManagedQueryRedirect

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

Update the managed query for the supplied redirect

Parameters:

redirectTo - the supplied redirect

Throws:

NumBadURLException - on error

NumInvalidRedirectException - on error

NumInvalidParameterException - on error

handlePrepopulatedQueryRedirect

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

Update the pre-populated query for the supplied redirect

Parameters:

redirectTo - the supplied redirect

Throws:

NumBadURLException - on error

NumInvalidRedirectException - on error

NumInvalidParameterException - on error

handleLookupRedirect

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

Update the DNS queries for the supplied lookup redirect.

Parameters:

redirect - the supplied redirect location

Throws:

NumBadURLException - on error

NumInvalidRedirectException - on error

NumInvalidParameterException - on error