A

account - Variable in class com.northgateis.comms.dda.DDAConnectionSpec

 

AM - Static variable in class com.northgateis.reality.util.ItemView

Reality attribute mark delimiter.

AM - Static variable in class com.northgateis.realweb.RealWeb

 

AMtoNL(String) - Static method in class com.northgateis.realweb.RealWeb

Convert all attribute marks in the given string to HTML break tags

B

bufToString(byte[], int, int) - Static method in class com.northgateis.util.Diag

convert given byte array to printable string.

build(InputStream) - Method in class com.northgateis.comms.dda.DDAMsg

Read a message from the given input stream and use it to overwrite the current message.

C

command - Variable in class com.northgateis.realweb.RealWebUrl

The second path component after the servlet name.

connect() - Method in class com.northgateis.comms.dda.DDATcp

Connect to the TCP host and the DDA server.

connect() - Method in class com.northgateis.reality.rsc.RSCConnection

Connect to the RSC server.

copy(int, byte[], int) - Method in class com.northgateis.reality.util.ItemView

Get an attribute from the item and copy it to callers buffer

copy(int, int, byte[], int) - Method in class com.northgateis.reality.util.ItemView

Get a value from an attribute in the item and copy it to callers buffer

copy(int, int, int, byte[], int) - Method in class com.northgateis.reality.util.ItemView

Get a subvalue from a value in the item and copy it to callers buffer

D

dataAvailable() - Method in class com.northgateis.comms.dda.DDATcp

Test if data available for input

database - Variable in class com.northgateis.comms.dda.DDAConnectionSpec

 

DDAConnectionSpec - class com.northgateis.comms.dda.DDAConnectionSpec.

A class that holds all of the details of a DDATcp connection

DDAConnectionSpec() - Constructor for class com.northgateis.comms.dda.DDAConnectionSpec

Create a skeleton connection spec.

DDAConnectionSpec(String, int, String, String, String) - Constructor for class com.northgateis.comms.dda.DDAConnectionSpec

Create a connection spec to a specified port

DDAConnectionSpec(String, String, String) - Constructor for class com.northgateis.comms.dda.DDAConnectionSpec

Create a connection spec to localhost using the default port

DDAConnectionSpec(String, String, String, String) - Constructor for class com.northgateis.comms.dda.DDAConnectionSpec

Create a connection spec using the default port

DDAMsg - class com.northgateis.comms.dda.DDAMsg.

RealityX DDA Message class

DDAMsg() - Constructor for class com.northgateis.comms.dda.DDAMsg

Construct an empty DDA message

DDAMsg(int, int) - Constructor for class com.northgateis.comms.dda.DDAMsg

Construct a DDA message with empty data and qualifier

DDAMsg(int, int, byte[]) - Constructor for class com.northgateis.comms.dda.DDAMsg

Construct a DDA message with empty qualifier

DDAMsg(int, int, byte[], byte[]) - Constructor for class com.northgateis.comms.dda.DDAMsg

Construct a full DDA message

DDATcp - class com.northgateis.comms.dda.DDATcp.

Defines an object that creates a DDA TCP connection to a Reality database and supplies methods to access this connection.

DDATcp(DDAConnectionSpec, String) - Constructor for class com.northgateis.comms.dda.DDATcp

Define a new DDA TCP connection using a DDAConnectionSpec

DDATcp(String, int, String, String, String, String) - Constructor for class com.northgateis.comms.dda.DDATcp

Define a new DDA TCP connection for a non default port.

DDATcp(String, String, String, String, String) - Constructor for class com.northgateis.comms.dda.DDATcp

Define a new DDA TCP connection for the default port.

DDATest - class com.northgateis.comms.dda.DDATest.

Test class for DDATcp

DDATest() - Constructor for class com.northgateis.comms.dda.DDATest

 

debug - Variable in class com.northgateis.realweb.RealWebUrl

set to true if first path component contains 'Debug'

debug(boolean) - Static method in class com.northgateis.comms.dda.DDATcp

Turn on/off the debug flag.

debugOn() - Static method in class com.northgateis.realweb.RealWeb

Return true if RealWeb debugging enabled

DEFAULT_PORT - Static variable in class com.northgateis.comms.dda.DDAConnectionSpec

 

DEFAULT_PORT - Static variable in class com.northgateis.comms.dda.DDATcp

The default port used by to connect to a DDA server

Diag - class com.northgateis.util.Diag.

Defines a set of methods for converting byte arrays to displayable strings

Diag() - Constructor for class com.northgateis.util.Diag

 

disconnect() - Method in class com.northgateis.comms.dda.DDATcp

Close the TCP connection

disconnect() - Method in class com.northgateis.reality.rsc.RSCConnection

disconnect from the RSC server

doItAll(byte[]) - Method in class com.northgateis.reality.rsc.RSCConnection

Send a DOITALL command to the server and await its responce

Dump(byte[], int, int) - Static method in class com.northgateis.util.Diag

Convert given byte array to printable string and print it.

Dumper(byte[], int, int) - Static method in class com.northgateis.util.Diag

Print given byte array in classic hex and ASCII dump format.

E

echoTest(String) - Method in class com.northgateis.comms.dda.DDATest

 

elements() - Method in class com.northgateis.util.IniFiles

Create a list of all sections within the ini file

empty() - Method in class com.northgateis.util.Fifo

 

eRSCFuncOutOfSeq - Static variable in class com.northgateis.reality.rsc.RSCException

 

eRSCInvFuncCode - Static variable in class com.northgateis.reality.rsc.RSCException

 

eRSCInvParNum - Static variable in class com.northgateis.reality.rsc.RSCException

 

eRSCInvSubNo - Static variable in class com.northgateis.reality.rsc.RSCException

 

eRSCRefNumOvflw - Static variable in class com.northgateis.reality.rsc.RSCException

 

eRSCRuntimeError - Static variable in class com.northgateis.reality.rsc.RSCException

 

eRSCSuccess - Static variable in class com.northgateis.reality.rsc.RSCException

 

eRSCUnassignedVal - Static variable in class com.northgateis.reality.rsc.RSCException

 

escape(String) - Static method in class com.northgateis.util.Util

Encode a Java Script escape string.

execute() - Method in class com.northgateis.reality.rsc.RSC

Send all parameters, execute the subroutine, receive all result parameters and load them into the parameter structure

execute(byte[][]) - Method in class com.northgateis.reality.rsc.RSC

Execute subroutine with parameters passed as byte array.

execute(int) - Method in class com.northgateis.reality.rsc.RSCConnection

Send an EXECUTE command to the server and await its responce

execute(String[]) - Method in class com.northgateis.reality.rsc.RSC

Execute subroutine with parameters passed as String array.

F

Fifo - class com.northgateis.util.Fifo.

 

Fifo() - Constructor for class com.northgateis.util.Fifo

 

Fifo(int) - Constructor for class com.northgateis.util.Fifo

 

G

get(int) - Method in class com.northgateis.reality.rsc.RSCDescriptor

get a parameter descriptor by index

get(int) - Method in class com.northgateis.reality.util.ItemView

Get an attribute from the item

get(int, int) - Method in class com.northgateis.reality.util.ItemView

Get a value from an attribute in the item

get(int, int, int) - Method in class com.northgateis.reality.util.ItemView

Get a subvalue from a value in the item

get(String) - Method in class com.northgateis.reality.rsc.RSCDescriptor

get a parameter descriptor by name.

getAll() - Method in class com.northgateis.reality.util.ItemView

Get the whole item

getBoolValue(String, String) - Method in class com.northgateis.util.IniFiles

Get boolean ini file value.

getBytes() - Method in class com.northgateis.comms.dda.DDAMsg

Serialise the message into a byte array and return it

getConnection(HttpServletRequest, HttpServletResponse) - Static method in class com.northgateis.realweb.RealWeb

Get a RealWeb connection (current or new )

getConnection(HttpServletRequest, HttpServletResponse, RealWebUrl) - Static method in class com.northgateis.realweb.RealWeb

Get a RealWeb connection (current or new )

getConnection(HttpServletRequest, HttpServletResponse, String) - Static method in class com.northgateis.realweb.RealWeb

Get a RealWeb connection (current or new )

getData() - Method in class com.northgateis.comms.dda.DDAMsg

Get the data block

getDataLength() - Method in class com.northgateis.comms.dda.DDAMsg

Get the data length

getDescription() - Method in class com.northgateis.reality.rsc.RSC

Get the parameter descriptions string for this subroutine from the RSC server.

getDescription(int) - Static method in class com.northgateis.reality.rsc.RSCException

 

getDescriptor() - Method in class com.northgateis.reality.rsc.RSC

Returns the the parameter descriptor.

getDirection() - Method in class com.northgateis.reality.rsc.RSCParam

get parameters direction

getFunction() - Method in class com.northgateis.comms.dda.DDAMsg

Get the function code

getIniVars(String) - Static method in class com.northgateis.realweb.RwDatabase

This is the main entry point.

getIntValue(String, String) - Method in class com.northgateis.util.IniFiles

Get integer ini file value.

getLength() - Method in class com.northgateis.reality.util.ItemView

Get the whole item length

getLongValue(String, String) - Method in class com.northgateis.util.IniFiles

Get long ini file value.

getName() - Method in class com.northgateis.reality.rsc.RSCDescriptor

return name of this subroutine

getName() - Method in class com.northgateis.reality.rsc.RSCParam

get the parameters name

getParam(int) - Method in class com.northgateis.reality.rsc.RSC

Get a pointer to a parameter descriptor by index.

getParam(int, int) - Method in class com.northgateis.reality.rsc.RSCConnection

Get a parameter from the server

getParam(String) - Method in class com.northgateis.reality.rsc.RSC

Get a pointer to a parameter descriptor by name.

getPosition() - Method in class com.northgateis.reality.rsc.RSCParam

get the parameters position (index) in the paramer list

getProperty(String) - Method in class com.northgateis.reality.util.Properties

Get a property.

getProperty(String, String) - Method in class com.northgateis.reality.util.Properties

Get a property.

getQualifier() - Method in class com.northgateis.comms.dda.DDAMsg

Get the qualifier

getQualifierInt() - Method in class com.northgateis.comms.dda.DDAMsg

Get the qualifier

getQualifierLength() - Method in class com.northgateis.comms.dda.DDAMsg

Get the qualifier length

getReference() - Method in class com.northgateis.comms.dda.DDAMsg

Get the reference

getString() - Method in class com.northgateis.reality.rsc.RSCParam

get the parameters value as a string

getValue() - Method in class com.northgateis.reality.rsc.RSCParam

get parameters value

getValue(String, String) - Method in class com.northgateis.util.IniFiles

Get String ini file value.

H

hasMoreElements() - Method in class com.northgateis.reality.rsc.RSCDescriptor

test if there are more parameters available

hasMoreElements() - Method in class com.northgateis.util.IniFiles

Test if ini file has more elements

host - Variable in class com.northgateis.comms.dda.DDAConnectionSpec

 

I

IN - Static variable in class com.northgateis.reality.rsc.RSCParam

Parameter is an input to a subroutine

iniFile - Static variable in class com.northgateis.realweb.RwDatabase

 

IniFiles - class com.northgateis.util.IniFiles.

Defines an object that represents a Windows style ini file.

IniFiles(String) - Constructor for class com.northgateis.util.IniFiles

Construct a new IniFiles object referencing an actual file on disk.

init() - Method in class com.northgateis.comms.dda.DDATest

 

init() - Static method in class com.northgateis.realweb.RealWeb

Start a thread to timeout our connections

INOUT - Static variable in class com.northgateis.reality.rsc.RSCParam

Parameter is both input to and output from a subroutine.

isEmpty() - Method in class com.northgateis.util.Fifo

 

ItemView - class com.northgateis.reality.util.ItemView.

Defines an object that allows a Reality item to be broken down into attributes, values and subvalues.

ItemView(byte[]) - Constructor for class com.northgateis.reality.util.ItemView

Create a new item view with normal system delimiters (AM, VM, SVM)

ItemView(byte[], byte, byte, byte) - Constructor for class com.northgateis.reality.util.ItemView

Create a new item view with user defined delimiters

L

loadIni() - Method in class com.northgateis.util.IniFiles

Load an ini file from the specified file into this object using the current file spec.

loadIni(String) - Method in class com.northgateis.util.IniFiles

Load an ini file from the specified file into this object.

loadPropertyFile(String) - Static method in class com.northgateis.util.Util

Create a new properties class and load it with data from a property file.

locateFile(String) - Static method in class com.northgateis.util.Util

Search for given file name down class path

M

main(String[]) - Static method in class com.northgateis.comms.dda.DDATest

 

main(String[]) - Static method in class com.northgateis.reality.util.ItemView

Test method

MAX_FUNCTION_CODE - Static variable in class com.northgateis.comms.dda.DDAMsg

The maximimum value for a function code

MAX_QUALIFIER_LEN - Static variable in class com.northgateis.comms.dda.DDAMsg

The maximimum lenght of a qualfier array

MAX_REFERENCE - Static variable in class com.northgateis.comms.dda.DDAMsg

The maximimum calue for a reference

N

nextElement() - Method in class com.northgateis.reality.rsc.RSCDescriptor

get the next parameter descriptor in sequence.

nextElement() - Method in class com.northgateis.util.IniFiles

Get next section name from list

NL - Static variable in class com.northgateis.realweb.RealWeb

 

numAttributes() - Method in class com.northgateis.reality.util.ItemView

Get the number of attributes in the item

numElements() - Method in class com.northgateis.util.IniFiles

Get number of sections in ini file

numSubValues(int, int) - Method in class com.northgateis.reality.util.ItemView

Get the number of subvalues in a value

numValues(int) - Method in class com.northgateis.reality.util.ItemView

Get the number of values in an attribute

O

OUT - Static variable in class com.northgateis.reality.rsc.RSCParam

Parameter is an output from a subroutine

P

page - Variable in class com.northgateis.realweb.RealWebUrl

The third path component after the servlet name

pathInfo - Variable in class com.northgateis.realweb.RealWebUrl

The rest of the path after the servlet name

port - Variable in class com.northgateis.comms.dda.DDAConnectionSpec

 

prepare(RSCDescriptor) - Method in class com.northgateis.reality.rsc.RSCConnection

Send a prepare message to the server and process its responce.

Properties - class com.northgateis.reality.util.Properties.

Handles reality specific properties.

Properties() - Constructor for class com.northgateis.reality.util.Properties

Create a new properties class and load it from the reality properties file (reality.properties).

R

read() - Method in class com.northgateis.util.Fifo

 

RealWeb - class com.northgateis.realweb.RealWeb.

This class is used by a servlet to cache RSC connections to Reality databases.

RealWebException - exception com.northgateis.realweb.RealWebException.

Provide an exception class for RealWeb

RealWebException(int, String) - Constructor for class com.northgateis.realweb.RealWebException

 

RealWebException(String) - Constructor for class com.northgateis.realweb.RealWebException

 

RealWebUrl - class com.northgateis.realweb.RealWebUrl.

Process additional path information into usable fields

RealWebUrl(HttpServletRequest) - Constructor for class com.northgateis.realweb.RealWebUrl

Process the additional path information and extract bits of interest.

RealWebUrl(HttpServletRequest, int) - Constructor for class com.northgateis.realweb.RealWebUrl

Process the additional path information and extract bits of interest.

RealWebUrl(String) - Constructor for class com.northgateis.realweb.RealWebUrl

Create an empty class with just the section name defined

receive() - Method in class com.northgateis.comms.dda.DDATcp

Receive a DDA message

reference - Variable in class com.northgateis.reality.rsc.RSCDescriptor

the reference number for this subroutine on the server

release(int, int) - Method in class com.northgateis.reality.rsc.RSCConnection

Send a RELEASE command to the server of type specified and await its responce

releaseData(int) - Method in class com.northgateis.reality.rsc.RSCConnection

Send a RELEASE command to the server specifying only release the data, and await its responce

releaseSubroutine(int) - Method in class com.northgateis.reality.rsc.RSCConnection

Send a RELEASE command to the server specifying release the subroutine, and await its responce

remove(String) - Method in class com.northgateis.util.IniFiles

Remove geiven section from ini file

reqNo - Variable in class com.northgateis.realweb.RealWebUrl

The request number

RSC - class com.northgateis.reality.rsc.RSC.

Constructs a class that accesses a subroutine on the server.

RSC(RSCConnection, String) - Constructor for class com.northgateis.reality.rsc.RSC

Create a class to refer to a specific subroutine.

RSC(String, RSCConnection) - Constructor for class com.northgateis.reality.rsc.RSC

Deprecated. replaced by RSC(RSCConnection, String) which is more efficient as it doesn't always prepare a subroutine first.

RSCConnection - class com.northgateis.reality.rsc.RSCConnection.

Creates and manages a new connection to an RSC server.

RSCConnection(DDAConnectionSpec) - Constructor for class com.northgateis.reality.rsc.RSCConnection

Configure a new RSC connection using a DDAConnectionSpec

RSCConnection(String, int, String, String, String) - Constructor for class com.northgateis.reality.rsc.RSCConnection

Configure a new RSC connection using a non default port

RSCConnection(String, String, String) - Constructor for class com.northgateis.reality.rsc.RSCConnection

Configure a new RSC connection using a winsni.ini file entry.

RSCConnection(String, String, String, String) - Constructor for class com.northgateis.reality.rsc.RSCConnection

Configure a new RSC connection using the default port

RSCDescriptor - class com.northgateis.reality.rsc.RSCDescriptor.

Builds a Vector containing the parameters of a subroutine, and provides methods to access the parameters either by reference or sequentially.

RSCDescriptor(String) - Constructor for class com.northgateis.reality.rsc.RSCDescriptor

Construct a new empty subroutine descriptor

RSCDescriptor(String, int, int, String) - Constructor for class com.northgateis.reality.rsc.RSCDescriptor

Construct a new subroutine descriptor

RSCException - exception com.northgateis.reality.rsc.RSCException.

 

RSCException(int, String) - Constructor for class com.northgateis.reality.rsc.RSCException

 

RSCException(String) - Constructor for class com.northgateis.reality.rsc.RSCException

 

RSCParam - class com.northgateis.reality.rsc.RSCParam.

Provides a descriptor for each parameter passed to or from a subroutine.

RSCParam(String, int) - Constructor for class com.northgateis.reality.rsc.RSCParam

 

RSCParam(String, int, int) - Constructor for class com.northgateis.reality.rsc.RSCParam

 

run() - Method in class com.northgateis.realweb.RealWeb

Background thread used to timeout connections

runTests() - Method in class com.northgateis.comms.dda.DDATest

 

RwDatabase - class com.northgateis.realweb.RwDatabase.

This class manages the RealWeb database of connection mappings.

S

saveIni() - Method in class com.northgateis.util.IniFiles

Save current object to default file.

saveIni(IniFiles) - Static method in class com.northgateis.realweb.RwDatabase

Update the realweb.ini file and invalidate all cache records.

saveIni(String) - Method in class com.northgateis.util.IniFiles

Save current object to given ini file.

section - Variable in class com.northgateis.realweb.RealWebUrl

The first path component after the servlet name

send(DDAMsg) - Method in class com.northgateis.comms.dda.DDATcp

Send a DDA message.

sendParam(int, int, byte[]) - Method in class com.northgateis.reality.rsc.RSCConnection

Send a parameter to the server

setAvailable() - Method in class com.northgateis.realweb.RealWeb

Clear the busy flag

setData(byte[]) - Method in class com.northgateis.comms.dda.DDAMsg

Set the data block

setData(String) - Method in class com.northgateis.comms.dda.DDAMsg

Set the data block

setDirection(int) - Method in class com.northgateis.reality.rsc.RSCParam

set parameters direction

setFunction(int) - Method in class com.northgateis.comms.dda.DDAMsg

Set the function code

setQualifier(byte[]) - Method in class com.northgateis.comms.dda.DDAMsg

Set the qualifier

setQualifier(String) - Method in class com.northgateis.comms.dda.DDAMsg

Set the qualifier

setReference(int) - Method in class com.northgateis.comms.dda.DDAMsg

Set the reference

setServer(String) - Method in class com.northgateis.comms.dda.DDATcp

Overide the server name used when instantiating the class.

setServer(String) - Method in class com.northgateis.reality.rsc.RSCConnection

Set the server name to connect to.

setTimeout(byte) - Method in class com.northgateis.comms.dda.DDATcp

Set the timeout when making a connection

setTimeout(HttpServletResponse, int) - Method in class com.northgateis.realweb.RealWeb

Sets the connections timeout value (in seconds) and updates the connections end time

setValue(byte[]) - Method in class com.northgateis.reality.rsc.RSCParam

set parameters value as a byte array

setValue(byte[], int, int) - Method in class com.northgateis.reality.rsc.RSCParam

 

setValue(String) - Method in class com.northgateis.reality.rsc.RSCParam

set parameters value as a string

setValue(String, String, boolean) - Method in class com.northgateis.util.IniFiles

Set ini file value to a boolean.

setValue(String, String, int) - Method in class com.northgateis.util.IniFiles

Set ini file value to a integer.

setValue(String, String, long) - Method in class com.northgateis.util.IniFiles

Set ini file value to a long.

setValue(String, String, String) - Method in class com.northgateis.util.IniFiles

Set ini file value to a String.

size() - Method in class com.northgateis.util.Fifo

 

sleepABit(int) - Method in class com.northgateis.comms.dda.DDATest

 

SM - Static variable in class com.northgateis.reality.util.ItemView

Reality segment mark delimiter.

SNI - class com.northgateis.comms.dda.SNI.

Get DDATcp connection parameters from winsni.ini file.

SNI(String, String, String, String) - Constructor for class com.northgateis.comms.dda.SNI

Define a new DDA TCP connection using a winsni.ini file entry.

SVM - Static variable in class com.northgateis.reality.util.ItemView

Reality subvalue mark delimiter.

T

toHex(byte) - Static method in class com.northgateis.util.Util

Convert byte to hex string

toString() - Method in class com.northgateis.comms.dda.DDAMsg

Convert the message to a human readable format

toString() - Method in class com.northgateis.reality.rsc.RSCException

 

toString() - Method in class com.northgateis.reality.rsc.RSCParam

 

toString() - Method in class com.northgateis.realweb.RealWeb

 

toString() - Method in class com.northgateis.realweb.RealWebException

 

U

unescape(String) - Static method in class com.northgateis.util.Util

Decode a Java Script escape() string.

UNKNOWN - Static variable in class com.northgateis.reality.rsc.RSCParam

Parameter direction is unknown

unread(Object) - Method in class com.northgateis.util.Fifo

 

update(Observable, Object) - Method in class com.northgateis.reality.rsc.RSC

 

user - Variable in class com.northgateis.comms.dda.DDAConnectionSpec

 

Util - class com.northgateis.util.Util.

Utility methods with no appropriate class

Util() - Constructor for class com.northgateis.util.Util

 

V

VM - Static variable in class com.northgateis.reality.util.ItemView

Reality value mark delimiter.

VM - Static variable in class com.northgateis.realweb.RealWeb

 

W

write(Object) - Method in class com.northgateis.util.Fifo