A B C D E G H I L M N O P R S T U V Z
All Classes All Packages

A

AppContext - Class in uk.num.numlib.internal.ctx

Some objects need to be globally accessibly

AppContext() - Constructor for class uk.num.numlib.internal.ctx.AppContext

B

begin(String, String, int) - Method in interface uk.num.numlib.api.NumAPI

Initialise a new NumAPIContextBase object for a specific module/NUM ID combination.

begin(String, String, int) - Method in class uk.num.numlib.api.NumAPIImpl

Initialise a new NumAPIContextBase object for a specific module/NUM ID combination.

C

CONFIG_FILE_SUFFIX() - Method in class uk.num.numlib.internal.util.StringConstants

Accessor

D

DNSServices - Interface in uk.num.numlib.internal.dns

This interface defines the contract for the DNS Service provider.

DNSServicesDefaultImpl - Class in uk.num.numlib.internal.dns

A default implementation of the DNSServices interface.

DNSServicesDefaultImpl() - Constructor for class uk.num.numlib.internal.dns.DNSServicesDefaultImpl

DOMAIN_NAME_PREFIX() - Method in class uk.num.numlib.internal.util.StringConstants

Accessor

DOMAIN_SEPARATOR - Static variable in class uk.num.numlib.internal.util.StringConstants

DomainLookupGenerator - Class in uk.num.numlib.internal.util

DomainLookupGenerator(AppContext, String) - Constructor for class uk.num.numlib.internal.util.DomainLookupGenerator

E

EMAIL_DOMAIN_SEPARATOR() - Method in class uk.num.numlib.internal.util.StringConstants

/** Accessor

EmailLookupGenerator - Class in uk.num.numlib.internal.util

EmailLookupGenerator(AppContext, String) - Constructor for class uk.num.numlib.internal.util.EmailLookupGenerator

ERROR_RETRIES - Static variable in class uk.num.numlib.internal.util.PopulatorRetryConfig

ERROR_RETRY_DELAYS - Static variable in class uk.num.numlib.internal.util.PopulatorRetryConfig

G

get(K) - Method in class uk.num.numlib.internal.util.SimpleCache

Get an item from the cache.

getConfigFileTXTRecords(AppContext, String, int) - Method in interface uk.num.numlib.internal.dns.DNSServices

Get the Module Configuration from DNS as an array of Records

getConfigFileTXTRecords(AppContext, String, int) - Method in class uk.num.numlib.internal.dns.DNSServicesDefaultImpl

Get the Module Configuration from DNS as an array of Records

getDistributedHostedLocation(String, int) - Method in class uk.num.numlib.internal.util.EmailLookupGenerator

getDistributedIndependentLocation(String, int) - Method in class uk.num.numlib.internal.util.EmailLookupGenerator

getHostedLocation(String) - Method in class uk.num.numlib.internal.util.EmailLookupGenerator

getHostedLocation(String) - Method in interface uk.num.numlib.internal.util.LookupGenerator

getIndependentLocation(String) - Method in class uk.num.numlib.internal.util.EmailLookupGenerator

getIndependentLocation(String) - Method in interface uk.num.numlib.internal.util.LookupGenerator

getInstance(AppContext, NonBlankString, NonBlankString) - Method in class uk.num.numlib.internal.module.ModuleFactory

Create and initialise a ModuleDNSQueries object or use a cached object.

getKey() - Method in interface uk.num.numlib.api.NumAPICallbacks

The decryption key from the client application.

getPopulatorLocation(String) - Method in class uk.num.numlib.internal.util.EmailLookupGenerator

getPopulatorLocation(String) - Method in interface uk.num.numlib.internal.util.LookupGenerator

getRecordFromDnsNoCache(NonBlankString, int, boolean) - Method in interface uk.num.numlib.internal.dns.DNSServices

Get a NUM record from DNS.

getRecordFromDnsNoCache(NonBlankString, int, boolean) - Method in class uk.num.numlib.internal.dns.DNSServicesDefaultImpl

Get a NUM record from DNS without caching.

getRecordLocation() - Method in class uk.num.numlib.internal.ctx.NumAPIContextBase

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

getRequiredUserVariables() - Method in interface uk.num.numlib.api.NumAPIContext

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

getRequiredUserVariables() - Method in class uk.num.numlib.internal.ctx.NumAPIContextBase

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

getResult() - Method in interface uk.num.numlib.api.NumAPICallbacks

Accessor for the JSON result.

getRootHostedLocation(String) - Method in class uk.num.numlib.internal.util.EmailLookupGenerator

getRootHostedLocation(String) - Method in interface uk.num.numlib.internal.util.LookupGenerator

getRootIndependentLocation(String) - Method in class uk.num.numlib.internal.util.EmailLookupGenerator

getRootIndependentLocation(String) - Method in interface uk.num.numlib.internal.util.LookupGenerator

H

handleQueryRedirect(AppContext, NonBlankString, NumAPIContextBase) - Method in class uk.num.numlib.internal.ctx.NumAPIContextBase

Update the relevant query for the supplied redirect

HOSTED - uk.num.numlib.api.NumAPICallbacks.Location

HOSTED_RECORD_SUFFIX() - Method in class uk.num.numlib.internal.util.StringConstants

Accessor

I

INDEPENDENT - uk.num.numlib.api.NumAPICallbacks.Location

initialise(AppContext) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries

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

interpretModuleConfig(String) - Method in class uk.num.numlib.internal.modl.ModlServices

Interpret a module configuration MODL object.

interpretNumRecord(String) - Method in class uk.num.numlib.internal.modl.ModlServices

Interpret a NUM record MODL string to a JSON String.

interpretPopulatorResponse(String) - Method in class uk.num.numlib.internal.modl.ModlServices

Interpret a NUM record response from the populator.

isDomainRoot() - Method in interface uk.num.numlib.internal.util.LookupGenerator

isSignedDNSSEC() - Method in interface uk.num.numlib.api.NumAPICallbacks

Check whether the record was DNSSEC signed.

isValid() - Method in class uk.num.numlib.internal.modl.PopulatorResponse

isValid() - Method in class uk.num.numlib.internal.module.ModuleConfig

L

localPart - Variable in class uk.num.numlib.internal.util.EmailLookupGenerator

LookupGenerator - Interface in uk.num.numlib.internal.util

M

ModlServices - Class in uk.num.numlib.internal.modl

A class to act as a facade for the MODL interpreter.

ModlServices() - Constructor for class uk.num.numlib.internal.modl.ModlServices

Default constructor

Module - Class in uk.num.numlib.internal.module

A class to represent the Module Configuration data obtained from DNS.

Module() - Constructor for class uk.num.numlib.internal.module.Module

Default constructor

ModuleConfig - Class in uk.num.numlib.internal.module

The Module Configuration Data.

ModuleConfig() - Constructor for class uk.num.numlib.internal.module.ModuleConfig

ModuleDNSQueries - Class in uk.num.numlib.internal.module

Class to hold the DNS query strings for a module and NUM ID combination.

ModuleDNSQueries(NonBlankString, NonBlankString) - Constructor for class uk.num.numlib.internal.module.ModuleDNSQueries

Constructor

ModuleFactory - Class in uk.num.numlib.internal.module

A factory for ModuleDNSQuery objects.

ModuleFactory() - Constructor for class uk.num.numlib.internal.module.ModuleFactory

N

NonBlankString - Class in uk.num.numlib.internal.util

Uitility to guarantee a populated String value - it cannot be just spaces

NumAPI - Interface in uk.num.numlib.api

NumAPICallbacks - Interface in uk.num.numlib.api

This interface defines the callback contract for the NumAPI.

NumAPICallbacks.Location - Enum in uk.num.numlib.api

The type of location the NUM record was received from

NumAPICallbacksDefaultHandler - Class in uk.num.numlib.api

A default no-op implementation of the NumAPICallbacks.

NumAPICallbacksDefaultHandler() - Constructor for class uk.num.numlib.api.NumAPICallbacksDefaultHandler

NumAPIContext - Interface in uk.num.numlib.api

The context state for a given module and NUM ID combination

NumAPIContextBase - Class in uk.num.numlib.internal.ctx

A base class implementation of NumAPIContext.

NumAPIContextBase() - Constructor for class uk.num.numlib.internal.ctx.NumAPIContextBase

NumAPIImpl - Class in uk.num.numlib.api

This is the main class for using the num-client-library.

NumAPIImpl() - Constructor for class uk.num.numlib.api.NumAPIImpl

Default constructor to initialise the default DNS services and MODL services.

NumAPIImpl(String[]) - Constructor for class uk.num.numlib.api.NumAPIImpl

Support multiple DNS hosts.

NumAPIImpl(String, int) - Constructor for class uk.num.numlib.api.NumAPIImpl

Alternative constructor used to override the default DNS host and port.

NumAPIImpl(DNSServices, String) - Constructor for class uk.num.numlib.api.NumAPIImpl

Alternative constructor used to override the default DNS hosts.

NumBadModuleConfigDataException - Exception in uk.num.numlib.exc

NumBadModuleConfigDataException(String) - Constructor for exception uk.num.numlib.exc.NumBadModuleConfigDataException

NumBadModuleIdException - Exception in uk.num.numlib.exc

NumBadModuleIdException(String) - Constructor for exception uk.num.numlib.exc.NumBadModuleIdException

NumBadRecordException - Exception in uk.num.numlib.exc

NumBadRecordException(String, Throwable) - Constructor for exception uk.num.numlib.exc.NumBadRecordException

NumBadURLException - Exception in uk.num.numlib.exc

NumBadURLException(Throwable) - Constructor for exception uk.num.numlib.exc.NumBadURLException

NumDNSQueryException - Exception in uk.num.numlib.exc

NumDNSQueryException(String) - Constructor for exception uk.num.numlib.exc.NumDNSQueryException

NumException - Exception in uk.num.numlib.exc

Used to report errors detected by the NUM Library code.

NumException() - Constructor for exception uk.num.numlib.exc.NumException

NumException(String) - Constructor for exception uk.num.numlib.exc.NumException

NumException(String, Throwable) - Constructor for exception uk.num.numlib.exc.NumException

NumException(String, Throwable, boolean, boolean) - Constructor for exception uk.num.numlib.exc.NumException

NumException(Throwable) - Constructor for exception uk.num.numlib.exc.NumException

NumInvalidDNSHostException - Exception in uk.num.numlib.exc

NumInvalidDNSHostException(String) - Constructor for exception uk.num.numlib.exc.NumInvalidDNSHostException

NumInvalidDNSHostException(String, Throwable) - Constructor for exception uk.num.numlib.exc.NumInvalidDNSHostException

NumInvalidDNSQueryException - Exception in uk.num.numlib.exc

NumInvalidDNSQueryException(String) - Constructor for exception uk.num.numlib.exc.NumInvalidDNSQueryException

NumInvalidParameterException - Exception in uk.num.numlib.exc

NumInvalidParameterException(String) - Constructor for exception uk.num.numlib.exc.NumInvalidParameterException

NumInvalidPopulatorResponseCodeException - Exception in uk.num.numlib.exc

NumInvalidPopulatorResponseCodeException(String) - Constructor for exception uk.num.numlib.exc.NumInvalidPopulatorResponseCodeException

NumInvalidRedirectException - Exception in uk.num.numlib.exc

NumInvalidRedirectException(String) - Constructor for exception uk.num.numlib.exc.NumInvalidRedirectException

NumLookupRedirect - Class in uk.num.numlib.internal.modl

NumLookupRedirect() - Constructor for class uk.num.numlib.internal.modl.NumLookupRedirect

NumMaximumRedirectsExceededException - Exception in uk.num.numlib.exc

NumMaximumRedirectsExceededException() - Constructor for exception uk.num.numlib.exc.NumMaximumRedirectsExceededException

NumNoRecordAvailableException - Exception in uk.num.numlib.exc

NumNoRecordAvailableException(String) - Constructor for exception uk.num.numlib.exc.NumNoRecordAvailableException

NumNotImplementedException - Exception in uk.num.numlib.exc

NumNotImplementedException(String) - Constructor for exception uk.num.numlib.exc.NumNotImplementedException

NumPopulatorErrorException - Exception in uk.num.numlib.exc

NumPopulatorErrorException(String) - Constructor for exception uk.num.numlib.exc.NumPopulatorErrorException

NumQueryRedirect - Class in uk.num.numlib.internal.modl

NumQueryRedirect() - Constructor for class uk.num.numlib.internal.modl.NumQueryRedirect

NumUserVariablesException - Exception in uk.num.numlib.exc

NumUserVariablesException(String) - Constructor for exception uk.num.numlib.exc.NumUserVariablesException

O

of(String) - Static method in class uk.num.numlib.internal.util.NonBlankString

P

POPULATOR - uk.num.numlib.api.NumAPICallbacks.Location

POPULATOR_SERVICE_SUFFIX() - Method in class uk.num.numlib.internal.util.StringConstants

Accessor

PopulatorResponse - Class in uk.num.numlib.internal.modl

A response from the populator service.

PopulatorResponse() - Constructor for class uk.num.numlib.internal.modl.PopulatorResponse

PopulatorResponseRecord - Class in uk.num.numlib.internal.modl

An object to represent a status or error response from the populator service.

PopulatorResponseRecord() - Constructor for class uk.num.numlib.internal.modl.PopulatorResponseRecord

PopulatorRetryConfig - Class in uk.num.numlib.internal.util

put(K, V) - Method in class uk.num.numlib.internal.util.SimpleCache

Add an item to the cache.

R

rebuildTXTRecordContent(Record[]) - Method in interface uk.num.numlib.internal.dns.DNSServices

Concatenate an array of TXT record values to a single String

rebuildTXTRecordContent(Record[]) - Method in class uk.num.numlib.internal.dns.DNSServicesDefaultImpl

Concatenate an array of TXT record values to a single String

receivedFrom() - Method in interface uk.num.numlib.api.NumAPICallbacks

The type of location the NUM record was received from.

receivedFrom() - Method in class uk.num.numlib.api.NumAPICallbacksDefaultHandler

The type of location the NUM record was received from.

redirectHostedRecordLocationRelativeToCurrent(NonBlankString) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries

Handle simple redirects

redirectIndependentRecordLocationRelativeToCurrent(NonBlankString) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries

Handle simple redirects

retrieveNumRecord(NumAPIContext, NumAPICallbacks, int) - Method in interface uk.num.numlib.api.NumAPI

This method uses the module context and the supplied Required User Variable values to obtain a fully expanded JSON object from DNS.

retrieveNumRecord(NumAPIContext, NumAPICallbacks, int) - Method in class uk.num.numlib.api.NumAPIImpl

This method uses the module context and the supplied Required User Variable values to obtain a fully expanded JSON object from DNS.

RETRY_DELAYS - Static variable in class uk.num.numlib.internal.util.PopulatorRetryConfig

RrSetHeaderFormatException - Exception in uk.num.numlib.exc

RrSetHeaderFormatException(String) - Constructor for exception uk.num.numlib.exc.RrSetHeaderFormatException

RrSetIncompleteException - Exception in uk.num.numlib.exc

RrSetIncompleteException(String) - Constructor for exception uk.num.numlib.exc.RrSetIncompleteException

RrSetNoHeadersException - Exception in uk.num.numlib.exc

RrSetNoHeadersException(String) - Constructor for exception uk.num.numlib.exc.RrSetNoHeadersException

S

setEmailRecordDistributionLevels(AppContext, int) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries

A Zone Distribution Record has been found so we need to update the email lookups accordingly.

setErrorResult(String) - Method in interface uk.num.numlib.api.NumAPICallbacks

Called if an error occurs while retrieving or processing the NUM recocrd.

setErrorResult(String) - Method in class uk.num.numlib.api.NumAPICallbacksDefaultHandler

Called if an error occurs while retrieving or processing the NUM recocrd.

setKey(Key) - Method in interface uk.num.numlib.api.NumAPICallbacks

The decryption key set by the client application

setLocation(NumAPICallbacks.Location) - Method in interface uk.num.numlib.api.NumAPICallbacks

Tell the library user where the record was retrieved from.

setLocation(NumAPICallbacks.Location) - Method in interface uk.num.numlib.api.NumAPIContext

setPopulatorTopLevelZone(String) - Method in interface uk.num.numlib.api.NumAPI

Override the populator top-level zone from 'num.uk' to 'myzone.com' for example.

setPopulatorTopLevelZone(String) - Method in class uk.num.numlib.api.NumAPIImpl

Override the populatortop-level zone from 'num.uk' to 'myzone.com' for example.

setRelativeRedirectHostedRecordLocation(AppContext, NonBlankString, int) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries

Change the hosted record location due to a redirect.

setRelativeRedirectIndependentRecordLocation(AppContext, NonBlankString, int) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries

Change the independent record location due to a redirect.

setRequiredUserVariables(UserVariable[]) - Method in interface uk.num.numlib.api.NumAPIContext

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

setRequiredUserVariables(UserVariable[]) - Method in class uk.num.numlib.internal.ctx.NumAPIContextBase

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

setResult(String) - Method in interface uk.num.numlib.api.NumAPICallbacks

Called when the result is available from DNS

setResult(String) - Method in class uk.num.numlib.api.NumAPICallbacksDefaultHandler

Called when the query result is available.

setRootRedirectHostedRecordLocation(AppContext, NonBlankString) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries

Change the hosted record location due to a redirect.

setRootRedirectIndependentRecordLocation(AppContext, NonBlankString) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries

Change the independent record location due to a redirect.

setSignedDNSSEC(boolean) - Method in interface uk.num.numlib.api.NumAPICallbacks

Set a flag to indicate whether the record was DNSSEC signed or not.

setTCPOnly(boolean) - Method in interface uk.num.numlib.api.NumAPI

Tell dnsjava to use TCP and not UDP.

setTCPOnly(boolean) - Method in class uk.num.numlib.api.NumAPIImpl

Tell dnsjava to use TCP and not UDP.

setTimeToLive(int) - Method in class uk.num.numlib.internal.util.SimpleCache

Override the default cache timeour.

setTopLevelZone(String) - Method in interface uk.num.numlib.api.NumAPI

Override the top-level zone from 'num.uk' to 'myzone.com' for example.

setTopLevelZone(String) - Method in class uk.num.numlib.api.NumAPIImpl

Override the top-level zone from 'num.uk' to 'myzone.com' for example.

shutdown() - Method in interface uk.num.numlib.api.NumAPI

Stop any outstanding DNS queries still in the Executor.

shutdown() - Method in class uk.num.numlib.api.NumAPIImpl

Stop any outstanding DNS queries still in the Executor.

SimpleCache<K,V> - Class in uk.num.numlib.internal.util

A very basic cache with a timeout mechanism.

SimpleCache() - Constructor for class uk.num.numlib.internal.util.SimpleCache

Default Constructor

STOP - uk.num.numlib.api.NumAPICallbacks.Location

stringConstants - Variable in class uk.num.numlib.internal.ctx.AppContext

StringConstants - Class in uk.num.numlib.internal.util

Constants defined by the NUM Protocol Specification

StringConstants() - Constructor for class uk.num.numlib.internal.util.StringConstants

T

toString() - Method in class uk.num.numlib.internal.util.NonBlankString

U

uk.num.numlib.api - package uk.num.numlib.api

uk.num.numlib.exc - package uk.num.numlib.exc

uk.num.numlib.internal.ctx - package uk.num.numlib.internal.ctx

uk.num.numlib.internal.dns - package uk.num.numlib.internal.dns

uk.num.numlib.internal.modl - package uk.num.numlib.internal.modl

uk.num.numlib.internal.module - package uk.num.numlib.internal.module

uk.num.numlib.internal.util - package uk.num.numlib.internal.util

URLLookupGenerator - Class in uk.num.numlib.internal.util

URLLookupGenerator(AppContext, String) - Constructor for class uk.num.numlib.internal.util.URLLookupGenerator

UserVariable - Class in uk.num.numlib.api

A definition of a user variable that needs a value obtained from the user.

UserVariable() - Constructor for class uk.num.numlib.api.UserVariable

UTILITY_MODULE_PREFIX() - Method in class uk.num.numlib.internal.util.StringConstants

Accessor

V

VALID_TXT_RECORD_CODE - Static variable in class uk.num.numlib.internal.modl.PopulatorResponse

value - Variable in class uk.num.numlib.internal.util.NonBlankString

valueOf(String) - Static method in enum uk.num.numlib.api.NumAPICallbacks.Location

Returns the enum constant of this type with the specified name.

values() - Static method in enum uk.num.numlib.api.NumAPICallbacks.Location

Returns an array containing the constants of this enum type, in the order they are declared.

Z

ZONE_DISTRIBUTION_RECORD_PREFIX() - Method in class uk.num.numlib.internal.util.StringConstants

Used to indicate a requirement for distributing email records across DNS zone files.

A B C D E G H I L M N O P R S T U V Z
All Classes All Packages