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
java.lang.String	getRecordLocation()	Get the query location based on the current location that is being tried.
UserVariable[]	getRequiredUserVariables()	Modules can have required user variables that must be supplied before the NUM record csn be retrieved.
void	handleQueryRedirect(AppContext appContext, NonBlankString redirect, NumAPIContextBase context)	Update the relevant query for the supplied redirect
void	setRequiredUserVariables(UserVariable[] userVariables)	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

Methods inherited from interface uk.num.numlib.api.NumAPIContext

setLocation

Constructor Detail

NumAPIContextBase

public NumAPIContextBase()

Method Detail

getRequiredUserVariables

public UserVariable[] 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(UserVariable[] userVariables)
                              throws NumUserVariablesException

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

Specified by:

setRequiredUserVariables in interface NumAPIContext

Parameters:

userVariables - The RequiredUserVariable array with the value fields populated.

Throws:

NumUserVariablesException - on error

getRecordLocation

public java.lang.String getRecordLocation()

Get the query location based on the current location that is being tried.

Returns:

a DNS query string for the current location.

handleQueryRedirect

public void handleQueryRedirect(AppContext appContext,
                                NonBlankString redirect,
                                NumAPIContextBase context)
                         throws NumBadURLException,
                                NumInvalidRedirectException,
                                NumInvalidParameterException,
                                NumMaximumRedirectsExceededException

Update the relevant query for the supplied redirect

Parameters:

appContext - the AppContext

redirect - the supplied redirect

context - the NumAPIContextBase

Throws:

NumBadURLException - on error

NumInvalidRedirectException - on error

NumInvalidParameterException - on error

NumMaximumRedirectsExceededException - on Error