Index (num-library 0.12.2 API)

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

A

addRequestProperty(String, String) - Method in class uk.num.net.NUMURLConnection: Adds a general request property specified by a key-value pair.
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
apply(String) - Method in class uk.num.numlib.internal.util.LegacyEscapeReplacer: Applies this function to the given argument.

B

begin(String, int) - Method in interface uk.num.numlib.api.NumAPI: Initialise a new NumAPIContextBase object for a specific module/NUM ID combination.
begin(String, int) - Method in class uk.num.numlib.api.NumAPIImpl: Initialise a new NumAPIContextBase object for a specific module/NUM ID combination.
begin(URL, int) - Method in interface uk.num.numlib.api.NumAPI: Initialise a new NumAPIContextBase object for a specific module/NUM ID combination.
begin(URL, int) - Method in class uk.num.numlib.api.NumAPIImpl: Initialise a new NumAPIContextBase object for a specific module/NUM ID combination.

C

connect() - Method in class uk.num.net.NUMURLConnection: Opens a communications link to the resource referenced by this URL, if such a connection has not already been established.

E

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.
getAllowUserInteraction() - Method in class uk.num.net.NUMURLConnection: Returns the value of the allowUserInteraction field for this object.
getContent() - Method in class uk.num.net.NUMURLConnection: Retrieves the contents of this URL connection.
getContent(Class[]) - Method in class uk.num.net.NUMURLConnection: Retrieves the contents of this URL connection.
getContentEncoding() - Method in class uk.num.net.NUMURLConnection: Returns the value of the content-encoding header field.
getContentLength() - Method in class uk.num.net.NUMURLConnection: Returns the value of the content-length header field.
getContentLengthLong() - Method in class uk.num.net.NUMURLConnection: Returns the value of the content-length header field as a long.
getContentType() - Method in class uk.num.net.NUMURLConnection: Returns the value of the content-type header field.
getDate() - Method in class uk.num.net.NUMURLConnection: Returns the value of the date header field.
getDefaultUseCaches() - Method in class uk.num.net.NUMURLConnection: Returns the default value of a URLConnection's useCaches flag.
getDoInput() - Method in class uk.num.net.NUMURLConnection: Returns the value of this URLConnection's doInput flag.
getDoOutput() - Method in class uk.num.net.NUMURLConnection: Returns the value of this URLConnection's doOutput flag.
getExpiration() - Method in class uk.num.net.NUMURLConnection: Returns the value of the expires header field.
getHeaderField(int) - Method in class uk.num.net.NUMURLConnection: Returns the value for the n^th header field.
getHeaderField(String) - Method in class uk.num.net.NUMURLConnection: Returns the value of the named header field.
getHeaderFieldDate(String, long) - Method in class uk.num.net.NUMURLConnection: Returns the value of the named field parsed as date.
getHeaderFieldInt(String, int) - Method in class uk.num.net.NUMURLConnection: Returns the value of the named field parsed as a number.
getHeaderFieldKey(int) - Method in class uk.num.net.NUMURLConnection: Returns the key for the n^th header field.
getHeaderFieldLong(String, long) - Method in class uk.num.net.NUMURLConnection: Returns the value of the named field parsed as a number.
getHeaderFields() - Method in class uk.num.net.NUMURLConnection: Returns an unmodifiable Map of the header fields.
getHostedRecordPath() - Method in class uk.num.numlib.internal.module.ModuleDNSQueries: Extract the 'path' portion of the hosted record
getIfModifiedSince() - Method in class uk.num.net.NUMURLConnection: Returns the value of this object's ifModifiedSince field.
getIndependentRecordPath() - Method in class uk.num.numlib.internal.module.ModuleDNSQueries: Extract the 'path' portion of the independent record
getInputStream() - Method in class uk.num.net.NUMURLConnection: Returns an input stream that reads from this open connection.
getInstance(int, String) - 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.
getLastModified() - Method in class uk.num.net.NUMURLConnection: Returns the value of the last-modified header field.
getLocation() - Method in interface uk.num.numlib.api.NumAPIContext
getOutputStream() - Method in class uk.num.net.NUMURLConnection: Returns an output stream that writes to this connection.
getPermission() - Method in class uk.num.net.NUMURLConnection: Returns a permission object representing the permission necessary to make the connection represented by this object.
getRecordLocation() - Method in class uk.num.numlib.internal.ctx.NumAPIContextBase: Get the query location based on the current location that is being tried.
getRequestProperties() - Method in class uk.num.net.NUMURLConnection: Returns an unmodifiable Map of general request properties for this connection.
getRequestProperty(String) - Method in class uk.num.net.NUMURLConnection: Returns the value of the named general request property for this connection.
getRequiredUserVariables() - Method in interface uk.num.numlib.api.NumAPIContext: Get the user variables.
getRequiredUserVariables() - Method in class uk.num.numlib.internal.ctx.NumAPIContextBase: Get the user variables.
getResult() - Method in interface uk.num.numlib.api.NumAPICallbacks: Accessor for the JSON result.
getURL() - Method in class uk.num.net.NUMURLConnection: Returns the value of this URLConnection's URL field.
getUseCaches() - Method in class uk.num.net.NUMURLConnection: Returns the value of this URLConnection's useCaches field.

H

handleQueryRedirect(String) - Method in class uk.num.numlib.internal.ctx.NumAPIContextBase: Update the relevant query for the supplied redirect
HIDE_PARAMS - Static variable in class uk.num.net.NUMURLConnection
HOSTED - uk.num.numlib.api.NumAPICallbacks.Location

I

INDEPENDENT - uk.num.numlib.api.NumAPICallbacks.Location
init() - Static method in class uk.num.net.NumProtocolSupport: Force the class to be loaded and the static initializer to be executed
initialise() - Method in class uk.num.numlib.internal.module.ModuleDNSQueries: Build the DNS query Strings and set the root/branch flag.
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.
isDnsSecSigned() - Method in interface uk.num.numlib.api.NumAPIContext
isPopulatorQueryRequired() - Method in interface uk.num.numlib.api.NumAPIContext
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

L

LegacyEscapeReplacer - Class in uk.num.numlib.internal.util: Replace Legacy DNS Escape sequences see https://app.clubhouse.io/num/story/2639/handling-escaped-characters-in-dns-responses
LegacyEscapeReplacer() - Constructor for class uk.num.numlib.internal.util.LegacyEscapeReplacer

M

MATCH_NUM_RECORDS - Static variable in class uk.num.numlib.api.NumAPIImpl
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
ModuleDNSQueries - Class in uk.num.numlib.internal.module: Class to hold the DNS query strings for a module and NUM ID combination.
ModuleDNSQueries(int, String) - 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
MODULES_LOCATION - Static variable in class uk.num.net.NUMURLConnection

N

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.
NumBadRecordException - Exception in uk.num.numlib.exc
NumBadRecordException(String, Throwable) - Constructor for exception uk.num.numlib.exc.NumBadRecordException
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
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
NumInvalidRedirectException(Throwable) - 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
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
NumProtocolSupport - Class in uk.num.net: Add NUM Protocol Support
NumProtocolSupport() - Constructor for class uk.num.net.NumProtocolSupport
NUMURLConnection - Class in uk.num.net
NUMURLConnection(URL) - Constructor for class uk.num.net.NUMURLConnection: Constructs a URL connection to the specified URL.

P

POPULATOR - uk.num.numlib.api.NumAPICallbacks.Location
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

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.
redirectHostedPath(String) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries: Set the hosted record to the specified path
redirectIndependentPath(String) - Method in class uk.num.numlib.internal.module.ModuleDNSQueries: Set the independent record to the specified path
RelativePathException - Exception in uk.num.numlib.exc
RelativePathException(String) - Constructor for exception uk.num.numlib.exc.RelativePathException
resolve(String, String) - Static method in class uk.num.numlib.internal.util.UrlRelativePathResolver: Convert a path of the form `/a/b/c/../../d/../e/../..` etc to a resolved path.
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

S

setAllowUserInteraction(boolean) - Method in class uk.num.net.NUMURLConnection: Set the value of the allowUserInteraction field of this URLConnection.
setDefaultUseCaches(boolean) - Method in class uk.num.net.NUMURLConnection: Sets the default value of the useCaches field to the specified value.
setDoInput(boolean) - Method in class uk.num.net.NUMURLConnection: Sets the value of the doInput field for this URLConnection to the specified value.
setDoOutput(boolean) - Method in class uk.num.net.NUMURLConnection: Sets the value of the doOutput field for this URLConnection to the specified value.
setEmailRecordDistributionLevels(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.
setIfModifiedSince(long) - Method in class uk.num.net.NUMURLConnection: Sets the value of the ifModifiedSince field of this URLConnection to the specified value.
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: Used internally to set the NUM record retrieval location.
setModulesLocation(String) - Method in class uk.num.numlib.api.NumAPIImpl
setPopulatorQueryRequired(boolean) - Method in interface uk.num.numlib.api.NumAPIContext
setReadTimeout(int) - Method in class uk.num.net.NUMURLConnection: Sets the read timeout to a specified timeout, in milliseconds.
setRequestProperty(String, String) - Method in class uk.num.net.NUMURLConnection: Sets the general request property.
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.
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 timeout.
setUseCaches(boolean) - Method in class uk.num.net.NUMURLConnection: Sets the value of the useCaches field of this URLConnection to the specified value.
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

T

toString() - Method in class uk.num.net.NUMURLConnection: Returns a String representation of this URL connection.
toUrl(String) - Static method in class uk.num.net.NumProtocolSupport: Create a `num` protocol URL

U

uk.num.net - package uk.num.net
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.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
UrlRelativePathResolver - Class in uk.num.numlib.internal.util: Convert a path of the form `/a/b/c/../../d/../e/../..` etc to a resolved path.
UrlRelativePathResolver() - Constructor for class uk.num.numlib.internal.util.UrlRelativePathResolver
USE_POPULATOR - Static variable in class uk.num.net.NUMURLConnection
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

V

VALID_TXT_RECORD_CODE - Static variable in class uk.num.numlib.internal.modl.PopulatorResponse
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.

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