A C D E F G H I L M N P Q R S T U V W X _

A

ACL - class uk.org.iscream.cms.util.ACL.

Access Control List for use primarily with the ACLServerSocket.

ACL() - Constructor for class uk.org.iscream.cms.util.ACL

Construct a new Access Control List.

ACL(boolean) - Constructor for class uk.org.iscream.cms.util.ACL

Construct a new Access Control List with a given default mode.

ACL(String) - Constructor for class uk.org.iscream.cms.util.ACL

Construct a new Access Control List with a given String representation of the ACL rules.

ACL.ACLRule - class uk.org.iscream.cms.util.ACL.ACLRule.

Wrapper class for an ACL rule.

ACL.ACLRule(boolean, String, short[], boolean) - Constructor for class uk.org.iscream.cms.util.ACL.ACLRule

Construct an ACL rule.

ACLDatagramSocket - class uk.org.iscream.cms.util.ACLDatagramSocket.

Access Control List DatagramSocket wrapper.

ACLDatagramSocket() - Constructor for class uk.org.iscream.cms.util.ACLDatagramSocket

See relevant DatagramSocket constructor.

ACLDatagramSocket(int) - Constructor for class uk.org.iscream.cms.util.ACLDatagramSocket

See relevant DatagramSocket constructor.

ACLDatagramSocket(int, InetAddress) - Constructor for class uk.org.iscream.cms.util.ACLDatagramSocket

See relevant DatagramSocket constructor.

ACLDatagramSocket(ACL) - Constructor for class uk.org.iscream.cms.util.ACLDatagramSocket

See relevant DatagramSocket constructor, and sets the default acl.

ACLDatagramSocket(ACL, int) - Constructor for class uk.org.iscream.cms.util.ACLDatagramSocket

See relevant DatagramSocket constructor, and sets the default acl.

ACLDatagramSocket(ACL, int, InetAddress) - Constructor for class uk.org.iscream.cms.util.ACLDatagramSocket

See relevant DatagramSocket constructor, and sets the default acl.

ACLServerSocket - class uk.org.iscream.cms.util.ACLServerSocket.

Access Control List ServerSocket wrapper.

ACLServerSocket(int) - Constructor for class uk.org.iscream.cms.util.ACLServerSocket

See relevant ServerSocket constructor.

ACLServerSocket(int, int) - Constructor for class uk.org.iscream.cms.util.ACLServerSocket

See relevant ServerSocket constructor.

ACLServerSocket(int, int, InetAddress) - Constructor for class uk.org.iscream.cms.util.ACLServerSocket

See relevant ServerSocket constructor.

ACLServerSocket(ACL, int) - Constructor for class uk.org.iscream.cms.util.ACLServerSocket

See relevant ServerSocket constructor, and sets the default acl.

ACLServerSocket(ACL, int, int) - Constructor for class uk.org.iscream.cms.util.ACLServerSocket

See relevant ServerSocket constructor, and sets the default acl.

ACLServerSocket(ACL, int, int, InetAddress) - Constructor for class uk.org.iscream.cms.util.ACLServerSocket

See relevant ServerSocket constructor, and sets the default acl.

ALLOW - Static variable in class uk.org.iscream.cms.util.ACL

static to be used when adding an ALLOW rule to the ACL.

accept() - Method in class uk.org.iscream.cms.util.ACLServerSocket

Essentially has the same behaviour as the ServerSocket.accept() method, except won't return a Socket unless it is permitted by the ACL.

add(boolean, String) - Method in class uk.org.iscream.cms.util.ACL

Add a new rule to the ACL immediately after the previous rule.

add(String) - Method in class uk.org.iscream.cms.util.ACL

Add some new rules to the Access Control List in the form of a String.

add(Object) - Method in class uk.org.iscream.cms.util.Queue

This method adds a given object to every queue.

addParam(String, String) - Method in class uk.org.iscream.cms.util.XMLPacket

Add a key and value pair to the HashMap.

algorithms - Static variable in class uk.org.iscream.cms.util.Queue

To allow opposite lookups.

C

characters(char[], int, int) - Method in class uk.org.iscream.cms.util.XMLStringParser

Any text falling within a pair of terminal tags must be added to the XMLPacket.

check(String) - Method in class uk.org.iscream.cms.util.ACL

Check to see if a string is permitted by the ACL.

check(InetAddress) - Method in class uk.org.iscream.cms.util.ACL

Check to see if an InetAddress is permitted by the ACL.

clear() - Method in class uk.org.iscream.cms.util.ACL

Clears the ACL and resets the default mode.

clearQueue(int) - Method in class uk.org.iscream.cms.util.Queue

This method erases the contents of a given queue.

close() - Method in class uk.org.iscream.cms.util.Smtp

Closes down the connection to the server

compareShorts(short[], short[]) - Method in class uk.org.iscream.cms.util.ACL

Compares two short arrays.

containsKey(String) - Method in class uk.org.iscream.cms.util.XMLPacket

Find if a particular key exists in the HashMap.

createXMLPacket(String) - Method in class uk.org.iscream.cms.util.XMLPacketMaker

Method to create an XML packet from the data this class was constructed with.

D

DEFMODE - Static variable in class uk.org.iscream.cms.util.ACL

default setting for the default mode for a new ACL.

DENY - Static variable in class uk.org.iscream.cms.util.ACL

static to be used when adding a DENY rule to the ACL.

DROP - Static variable in class uk.org.iscream.cms.util.Queue

Pass to constructor to drop the new item upon reaching the maximum Queue limit.

DateUtils - class uk.org.iscream.cms.util.DateUtils.

Provides easy to use date functions.

DateUtils() - Constructor for class uk.org.iscream.cms.util.DateUtils

dateString(long) - Static method in class uk.org.iscream.cms.util.DateUtils

Return a nice String representation of the date.

dayName(long) - Static method in class uk.org.iscream.cms.util.DateUtils

Return a String representation of the day name (short format).

daysKey - Static variable in class uk.org.iscream.cms.util.DateUtils

E

elementCount() - Method in class uk.org.iscream.cms.util.Queue

Returns the total numer of elements to have passed through this queue.

endElement(String, String, String) - Method in class uk.org.iscream.cms.util.XMLStringParser

When an XML element is finished with, we must remove the tag name from the tagList and decrement the indent level.

F

FIRST - Static variable in class uk.org.iscream.cms.util.Queue

Pass to constructor to remove the FIRST item from the Queue upon reaching the maximum limit.

FormatName - class uk.org.iscream.cms.util.FormatName.

This class provides static methods to format the name of a calling object.

FormatName() - Constructor for class uk.org.iscream.cms.util.FormatName

A private constructor ensures an instance of this class CANNOT be created.

formatLogLine(String, int, String) - Static method in class uk.org.iscream.cms.util.FormatName

This method generates a nicely formatted line for the log, including the date/time and the source of the message.

formatTime(long) - Static method in class uk.org.iscream.cms.util.DateUtils

Format a long time (in seconds) as a String.

formatTime(long, String) - Static method in class uk.org.iscream.cms.util.DateUtils

Format a long time (in seconds) as a String.

G

get(int) - Method in class uk.org.iscream.cms.util.Queue

This method returns an object from the front of a given queue.

getName(String, String, String) - Static method in class uk.org.iscream.cms.util.FormatName

This method takes a set of information about the calling class and constructs a tidy String name to be returned.

getOutputStream() - Method in class uk.org.iscream.cms.util.Smtp

Gets the PrintWriter allowing data to be sent directly to the SMTP server

getParam(String) - Method in class uk.org.iscream.cms.util.XMLPacket

Return the value associated with a particular key.

getPath() - Method in class uk.org.iscream.cms.util.XMLStringParser

Return the heirarchical string to be used as a key value in the XMLPacket.

getQueue() - Method in class uk.org.iscream.cms.util.Queue

This method assigns a queue to a consumer.

getSet() - Method in class uk.org.iscream.cms.util.XMLPacket

Return a Set of the keys in the HashMap.

getStringPos(String, String[]) - Static method in class uk.org.iscream.cms.util.StringUtils

This method takes an array of String's and a String to look for and returns the position in the array that the string occurs.

getTimeString(long) - Static method in class uk.org.iscream.cms.util.DateUtils

Takes a time period in seconds and converts it to a reasonable message.

getXMLPacket() - Method in class uk.org.iscream.cms.util.XMLStringParser

Accessor to the XMLPacket.

H

hourString(long) - Static method in class uk.org.iscream.cms.util.DateUtils

Return a String representation of the hour.

hoursKey - Static variable in class uk.org.iscream.cms.util.DateUtils

I

InvalidQueueException - exception uk.org.iscream.cms.util.InvalidQueueException.

This exception is thrown if a "consumer" makes a request for a queue that does not exist.

InvalidQueueException(String) - Constructor for class uk.org.iscream.cms.util.InvalidQueueException

Takes a string containing a message detailing specifics about the exception.

InvalidXMLException - exception uk.org.iscream.cms.util.InvalidXMLException.

This exception is thrown if XML cannot be parsed into an XML packet.

InvalidXMLException(String) - Constructor for class uk.org.iscream.cms.util.InvalidXMLException

Takes a string containing a message detailing specifics about the exception.

init() - Method in class uk.org.iscream.cms.util.Smtp

Check the server sends a 220 message, and then send our HELO.

ipStringToShort(String) - Method in class uk.org.iscream.cms.util.ACL

Converts an IP address in String format into a short array of length 4.

L

LAST - Static variable in class uk.org.iscream.cms.util.Queue

Pass to constructor to remove the LAST item from the Queue upon reaching the maximum limit.

M

minsKey - Static variable in class uk.org.iscream.cms.util.DateUtils

N

now() - Static method in class uk.org.iscream.cms.util.DateUtils

Return the number of seconds between the epoch and now.

P

printAll() - Method in class uk.org.iscream.cms.util.XMLPacket

Print out the entire HashMap.

Q

Queue - class uk.org.iscream.cms.util.Queue.

A Queue class designed to operate in a multi-threaded environment, with added support for multiple "consumer" threads.

Queue(int, int) - Constructor for class uk.org.iscream.cms.util.Queue

Constructs a new Queue with a maximum size limit on any individual queue.

Queue() - Constructor for class uk.org.iscream.cms.util.Queue

Constructs a Queue with no maximum size.

QueueMonitor - class uk.org.iscream.cms.util.QueueMonitor.

This class monitors a given Queue at regular intervals, reporting back to a Queue with XML - this could be the same Queue being monitored.

QueueMonitor(Queue, Queue, long, String) - Constructor for class uk.org.iscream.cms.util.QueueMonitor

Construct a new QueueMonitor.

queueSize(int) - Method in class uk.org.iscream.cms.util.Queue

Returns the size of a given queue.

R

RANDOM - Static variable in class uk.org.iscream.cms.util.Queue

Pass to constructor to remove a RANDOM item from the Queue upon reaching the maximum limit.

REVISION - Static variable in class uk.org.iscream.cms.util.ACL

The current CVS revision of this class

REVISION - Static variable in class uk.org.iscream.cms.util.ACLDatagramSocket

The current CVS revision of this class

REVISION - Static variable in class uk.org.iscream.cms.util.ACLServerSocket

The current CVS revision of this class

REVISION - Variable in class uk.org.iscream.cms.util.DateUtils

The current CVS revision of this class

REVISION - Static variable in class uk.org.iscream.cms.util.Queue

The current CVS revision of this class

REVISION - Static variable in class uk.org.iscream.cms.util.QueueMonitor

The current CVS revision of this class

REVISION - Static variable in class uk.org.iscream.cms.util.Smtp

The current CVS revision of this class

REVISION - Static variable in class uk.org.iscream.cms.util.StringUtils

The current CVS revision of this class

REVISION - Variable in class uk.org.iscream.cms.util.XMLPacket

The current CVS revision of this class

REVISION - Variable in class uk.org.iscream.cms.util.XMLPacketMaker

The current CVS revision of this class

REVISION - Variable in class uk.org.iscream.cms.util.XMLStringParser

The current CVS revision of this class

receive(DatagramPacket) - Method in class uk.org.iscream.cms.util.ACLDatagramSocket

Essentially has the same behaviour as the Datagram.receive() method, except won't return unless it is permitted by the ACL.

releaseQueue(int) - Method in class uk.org.iscream.cms.util.Queue

This method releases a get() method that's currently waiting on an empty queue.

removeQueue(int) - Method in class uk.org.iscream.cms.util.Queue

This method sets a entry to null in the list.

removeQueueItem(LinkedList) - Method in class uk.org.iscream.cms.util.Queue

This method removes an item from a Queue, using a method requested at construction.

replaceText(String, String, String) - Static method in class uk.org.iscream.cms.util.StringUtils

Searches a string and replaces all occurences of the given search text with the given replacement text.

run() - Method in class uk.org.iscream.cms.util.QueueMonitor

Loops continuosly polling our source Queue at the given interval, and then logging the results in the destination Queue.

S

Smtp - class uk.org.iscream.cms.util.Smtp.

The Simple Mail Transfer Protocol class.

Smtp(String) - Constructor for class uk.org.iscream.cms.util.Smtp

Connects to the specified SMTP server, on the default (and standard) port 25.

Smtp(String, int) - Constructor for class uk.org.iscream.cms.util.Smtp

Connects to the specified SMTP server on a given port

StringUtils - class uk.org.iscream.cms.util.StringUtils.

A class containing useful methods for manipulating String objects.

StringUtils() - Constructor for class uk.org.iscream.cms.util.StringUtils

secsKey - Static variable in class uk.org.iscream.cms.util.DateUtils

secsPerDay - Static variable in class uk.org.iscream.cms.util.DateUtils

secsPerHour - Static variable in class uk.org.iscream.cms.util.DateUtils

secsPerMin - Static variable in class uk.org.iscream.cms.util.DateUtils

secsPerMonth - Static variable in class uk.org.iscream.cms.util.DateUtils

secsPerWeek - Static variable in class uk.org.iscream.cms.util.DateUtils

sendCommand(String, int) - Method in class uk.org.iscream.cms.util.Smtp

Sends a command to the server

sendMessage() - Method in class uk.org.iscream.cms.util.Smtp

Completes and sends the current message

setACL(ACL) - Method in class uk.org.iscream.cms.util.ACLDatagramSocket

Set the ACL at any point in the operation of the DatagramSocket.

setACL(ACL) - Method in class uk.org.iscream.cms.util.ACLServerSocket

Set the ACL at any point in the operation of the ServerSocket.

setDefaultMode(boolean) - Method in class uk.org.iscream.cms.util.ACL

Changes the default mode of the ACL.

setSender(String) - Method in class uk.org.iscream.cms.util.Smtp

Specify who the message is from

setTo(String) - Method in class uk.org.iscream.cms.util.Smtp

Specify who the message is to be sent to

shortDateString(long) - Static method in class uk.org.iscream.cms.util.DateUtils

Return a nice short String representation of the date.

shutdown() - Method in class uk.org.iscream.cms.util.QueueMonitor

Shuts down this QueueMonitor

startElement(String, String, String, Attributes) - Method in class uk.org.iscream.cms.util.XMLStringParser

Add each tag's attribute to the XMLPacket.

startMonitor(long, Queue, String) - Method in class uk.org.iscream.cms.util.Queue

Start a monitor on our own Queue.

startMonitor(long, String) - Method in class uk.org.iscream.cms.util.Queue

Start a monitor on our own Queue.

startOfToday() - Static method in class uk.org.iscream.cms.util.DateUtils

Return the number of seconds between the epoch and midnight earlier today.

stopMonitor() - Method in class uk.org.iscream.cms.util.Queue

Stop a monitor on our Queue if we have on running.

subtractDays(long, int) - Static method in class uk.org.iscream.cms.util.DateUtils

Accept a long representing the number of seconds since the epoch.

subtractHours(long, int) - Static method in class uk.org.iscream.cms.util.DateUtils

Accept a long representing the number of seconds since the epoch.

subtractMonths(long, int) - Static method in class uk.org.iscream.cms.util.DateUtils

Accept a long representing the number of seconds since the epoch.

subtractWeeks(long, int) - Static method in class uk.org.iscream.cms.util.DateUtils

Accept a long representing the number of seconds since the epoch.

T

tidyClassName(String) - Static method in class uk.org.iscream.cms.util.FormatName

If the class name begins with uk.org.iscream.cms.server this method will trim it off, otherwise it leaves the string unchanged.

timeString(long) - Static method in class uk.org.iscream.cms.util.DateUtils

Return a String representation of the time (short format).

toString() - Method in class uk.org.iscream.cms.util.ACL.ACLRule

Returns a String representation of this rule.

toString() - Method in class uk.org.iscream.cms.util.ACL

Gives a String representation of this ACL.

toString() - Method in class uk.org.iscream.cms.util.ACLDatagramSocket

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.ACLServerSocket

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.DateUtils

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.Queue

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.QueueMonitor

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.Smtp

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.StringUtils

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.XMLPacket

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.XMLPacketMaker

Overrides the Object.toString() method to provide clean logging (every class should have this).

toString() - Method in class uk.org.iscream.cms.util.XMLStringParser

Overrides the Object.toString() method to provide clean logging (every class should have this).

U

uk.org.iscream.cms.util - package uk.org.iscream.cms.util

V

VERBOSITY_NAMES - Static variable in class uk.org.iscream.cms.util.FormatName

An array of names of verbosity levels.

W

wildcardMatch(String, String) - Static method in class uk.org.iscream.cms.util.StringUtils

Checks if a given string matches a wildcard expression.

X

XMLPacket - class uk.org.iscream.cms.util.XMLPacket.

Object in which to store incoming XML data for processing by a component of the system.

XMLPacket() - Constructor for class uk.org.iscream.cms.util.XMLPacket

XMLPacketMaker - class uk.org.iscream.cms.util.XMLPacketMaker.

XMLPacketMaker - Creates an XMLPacket object.

XMLPacketMaker() - Constructor for class uk.org.iscream.cms.util.XMLPacketMaker

XMLStringParser - class uk.org.iscream.cms.util.XMLStringParser.

XMLStringParser - Used to assist in creating XMLPacket objects.

XMLStringParser() - Constructor for class uk.org.iscream.cms.util.XMLStringParser

No-args constructor.

XMLStringParser(XMLPacket) - Constructor for class uk.org.iscream.cms.util.XMLStringParser

Constructor for accepting a reference to an XMLPacket

xmlStatus() - Method in class uk.org.iscream.cms.util.Queue

This method returns an XML textual status of the queues.

_

_acl - Variable in class uk.org.iscream.cms.util.ACL

The ACL is stored in this ArrayList.

_acl - Variable in class uk.org.iscream.cms.util.ACLDatagramSocket

The ACL used by this ACLDatagramSocket.

_acl - Variable in class uk.org.iscream.cms.util.ACLServerSocket

The ACL used by this ACLServerSocket.

_allow - Variable in class uk.org.iscream.cms.util.ACL.ACLRule

Whether this is an ALLOW or DENY rule.

_count - Variable in class uk.org.iscream.cms.util.Queue

A counter so we know how many data items have been passed through, for statistical purposes.

_defaultMode - Variable in class uk.org.iscream.cms.util.ACL

The default mode of this ACL.

_destQueue - Variable in class uk.org.iscream.cms.util.QueueMonitor

The Queue we'll output results to.

_expression - Variable in class uk.org.iscream.cms.util.ACL.ACLRule

What this rule matches.

_factory - Variable in class uk.org.iscream.cms.util.XMLPacketMaker

A reference to the system saxParser factory

_interval - Variable in class uk.org.iscream.cms.util.QueueMonitor

The interval at which we'll check the sourceQueue status.

_ipaddr - Variable in class uk.org.iscream.cms.util.ACL.ACLRule

The IP wildcard, only valid if this is an IP rule.

_iprule - Variable in class uk.org.iscream.cms.util.ACL.ACLRule

Whether this is an IP rule.

_lists - Variable in class uk.org.iscream.cms.util.Queue

The LinkedLists of queues.

_maxSize - Variable in class uk.org.iscream.cms.util.Queue

The maximum size of any Queue.

_name - Variable in class uk.org.iscream.cms.util.ACL

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.ACLDatagramSocket

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.ACLServerSocket

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.DateUtils

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.Queue

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.QueueMonitor

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.Smtp

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.StringUtils

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.XMLPacket

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.XMLPacketMaker

This is the friendly identifier of the component this class is running in.

_name - Variable in class uk.org.iscream.cms.util.XMLStringParser

This is the friendly identifier of the component this class is running in.

_packet - Variable in class uk.org.iscream.cms.util.XMLStringParser

A reference to the XMLPacket we are making

_params - Variable in class uk.org.iscream.cms.util.XMLPacket

A HashMap of parameters

_queueMon - Variable in class uk.org.iscream.cms.util.Queue

A reference to our QueueMonitor, if we have one.

_removeAlgorithm - Variable in class uk.org.iscream.cms.util.Queue

The remove algorithm to use upon a Queue reaching it's maximum size.

_run - Variable in class uk.org.iscream.cms.util.QueueMonitor

Allows us to stop the main loop cleanly.

_socket - Variable in class uk.org.iscream.cms.util.Smtp

A reference to the Socket connected to the server

_socketIn - Variable in class uk.org.iscream.cms.util.Smtp

A reference to the Reader connected to the server

_socketOut - Variable in class uk.org.iscream.cms.util.Smtp

A reference to the Writer connected to the server

_sourceQueue - Variable in class uk.org.iscream.cms.util.QueueMonitor

The Queue we're monitoring.

_srcName - Variable in class uk.org.iscream.cms.util.QueueMonitor

The name to identify the source Queue

_tagList - Variable in class uk.org.iscream.cms.util.XMLStringParser

A LinkedList of tags

A C D E F G H I L M N P Q R S T U V W X _