Index (Whack, the core library 3.1.0 API)

A B C D E F G H I L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values

A

addComponent(String, Component) - Method in class org.jivesoftware.whack.ExternalComponentManager
addComponent(String, Component, Integer) - Method in class org.jivesoftware.whack.ExternalComponentManager
addHandler(String, ElementHandler) - Method in class org.dom4j.io.XPPPacketReader: Adds the ElementHandler to be called when the specified path is encounted.
addListener(PropertyEventListener) - Static method in class org.jivesoftware.util.PropertyEventDispatcher: Registers a listener to receive events.

B

Base64 - Class in org.jivesoftware.util: Encodes and decodes to and from Base64 notation.
Base64.InputStream - Class in org.jivesoftware.util: A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream - Class in org.jivesoftware.util: A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

C

cancelScheduledTask(TimerTask) - Method in class org.jivesoftware.whack.util.TaskEngine: Cancels the execution of a scheduled task.
close() - Method in class org.jivesoftware.util.Base64.OutputStream: Flushes and closes (I think, in the superclass) the stream.
connect(String, int, String) - Method in class org.jivesoftware.whack.ExternalComponent: Deprecated.
connect(String, int, String, boolean) - Method in class org.jivesoftware.whack.ExternalComponent: Generates a connection with the server and tries to authenticate.
connectionLost() - Method in class org.jivesoftware.whack.ExternalComponent: Notification message that the connection with the server was lost unexpectedly.
createReader(InputStream) - Method in class org.dom4j.io.XPPPacketReader: Factory method to create a Reader from the given InputStream.

D

decode(byte[], int, int, int) - Static method in class org.jivesoftware.util.Base64: Very low-level access to decoding ASCII characters in the form of a byte array.
decode(String) - Static method in class org.jivesoftware.util.Base64: Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
decode(String, int) - Static method in class org.jivesoftware.util.Base64: Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
DECODE - Static variable in class org.jivesoftware.util.Base64: Specify decoding.
decodeBase64(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Decodes a base64 String.
decodeFileToFile(String, String) - Static method in class org.jivesoftware.util.Base64: Reads infile and decodes it to outfile.
decodeFromFile(String) - Static method in class org.jivesoftware.util.Base64: Convenience method for reading a base64-encoded file and decoding it.
decodeToFile(String, String) - Static method in class org.jivesoftware.util.Base64: Convenience method for decoding data to a file.
decodeToObject(String) - Static method in class org.jivesoftware.util.Base64: Attempts to decode Base64 data and deserialize a Java Object within.
deleteProperty(String) - Method in class org.jivesoftware.util.XMLProperties: Deletes the specified property.
dispatchEvent(String, PropertyEventDispatcher.EventType, Map) - Static method in class org.jivesoftware.util.PropertyEventDispatcher: Dispatches an event to all listeners.
DONT_BREAK_LINES - Static variable in class org.jivesoftware.util.Base64: Don't break lines when encoding (violates strict Base64 specification)

E

ENCODE - Static variable in class org.jivesoftware.util.Base64: Specify encoding.
encodeBase64(byte[]) - Static method in class org.jivesoftware.whack.util.StringUtils: Encodes a byte array into a base64 String.
encodeBase64(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Encodes a String as a base64 String.
encodeBytes(byte[]) - Static method in class org.jivesoftware.util.Base64: Encodes a byte array into Base64 notation.
encodeBytes(byte[], int) - Static method in class org.jivesoftware.util.Base64: Encodes a byte array into Base64 notation.
encodeBytes(byte[], int, int) - Static method in class org.jivesoftware.util.Base64: Encodes a byte array into Base64 notation.
encodeBytes(byte[], int, int, int) - Static method in class org.jivesoftware.util.Base64: Encodes a byte array into Base64 notation.
encodeFileToFile(String, String) - Static method in class org.jivesoftware.util.Base64: Reads infile and encodes it to outfile.
encodeFromFile(String) - Static method in class org.jivesoftware.util.Base64: Convenience method for reading a binary file and base64-encoding it.
encodeHex(byte[]) - Static method in class org.jivesoftware.whack.util.StringUtils: Turns an array of bytes into a String representing each byte as an unsigned hex number.
encodeObject(Serializable) - Static method in class org.jivesoftware.util.Base64: Serializes an object and returns the Base64-encoded version of that serialized object.
encodeObject(Serializable, int) - Static method in class org.jivesoftware.util.Base64: Serializes an object and returns the Base64-encoded version of that serialized object.
encodeToFile(byte[], String) - Static method in class org.jivesoftware.util.Base64: Convenience method for encoding data to a file.
escapeForXML(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Escapes all necessary characters in the String so that it can be used in an XML doc.
ExternalComponent - Class in org.jivesoftware.whack: ExternalComponents are responsible for connecting and authenticating with a remote server and for sending and processing received packets.
ExternalComponent(Component, ExternalComponentManager) - Constructor for class org.jivesoftware.whack.ExternalComponent
ExternalComponent(Component, ExternalComponentManager, int) - Constructor for class org.jivesoftware.whack.ExternalComponent
ExternalComponent(Component, ExternalComponentManager, ExecutorService) - Constructor for class org.jivesoftware.whack.ExternalComponent
ExternalComponentManager - Class in org.jivesoftware.whack: Implementation of the ComponentManager interface for external components.
ExternalComponentManager(String) - Constructor for class org.jivesoftware.whack.ExternalComponentManager: Constructs a new ExternalComponentManager that will make connections to the specified XMPP server on the default external component port (5275).
ExternalComponentManager(String, int) - Constructor for class org.jivesoftware.whack.ExternalComponentManager: Deprecated.
ExternalComponentManager(String, int, boolean) - Constructor for class org.jivesoftware.whack.ExternalComponentManager

F

FastDateFormat - Class in org.jivesoftware.util: Similar to SimpleDateFormat, but faster and thread-safe.
flushBase64() - Method in class org.jivesoftware.util.Base64.OutputStream: Method added by PHIL.
format(Calendar) - Method in class org.jivesoftware.util.FastDateFormat
format(Calendar, StringBuffer) - Method in class org.jivesoftware.util.FastDateFormat
format(Date) - Method in class org.jivesoftware.util.FastDateFormat
format(Date, StringBuffer) - Method in class org.jivesoftware.util.FastDateFormat
FULL - Static variable in class org.jivesoftware.util.FastDateFormat: Style pattern

G

getAttribute(String, String) - Method in class org.jivesoftware.util.XMLProperties: Returns the value of the attribute of the given property name or null if it doesn't exist.
getChildProperties(String) - Method in class org.jivesoftware.util.XMLProperties: Return all values who's path matches the given property name as a String array, or an empty array if the if there are no children.
getChildrenProperties(String) - Method in class org.jivesoftware.util.XMLProperties: Return all children property names of a parent property as a String array, or an empty array if the if there are no children.
getComponent() - Method in class org.jivesoftware.whack.ExternalComponent
getConnectTimeout() - Method in class org.jivesoftware.whack.ExternalComponentManager: Returns the timeout (in milliseconds) to use when trying to connect to the server.
getDateInstance(Object, TimeZone, Locale) - Static method in class org.jivesoftware.util.FastDateFormat
getDateTimeInstance(Object, Object, TimeZone, Locale) - Static method in class org.jivesoftware.util.FastDateFormat
getDescription() - Method in class org.jivesoftware.whack.ExternalComponent
getDispatchHandler() - Method in class org.dom4j.io.XPPPacketReader
getDocumentFactory() - Method in class org.dom4j.io.XPPPacketReader
getDomain() - Method in class org.jivesoftware.whack.ExternalComponent: Returns the domain provided by this component in the connected server.
getInstance() - Static method in class org.jivesoftware.util.FastDateFormat
getInstance() - Static method in class org.jivesoftware.whack.util.TaskEngine: Returns a task engine instance (singleton).
getInstance(String) - Static method in class org.jivesoftware.util.FastDateFormat
getInstance(String, DateFormatSymbols) - Static method in class org.jivesoftware.util.FastDateFormat
getInstance(String, Locale) - Static method in class org.jivesoftware.util.FastDateFormat
getInstance(String, TimeZone) - Static method in class org.jivesoftware.util.FastDateFormat
getInstance(String, TimeZone, Locale) - Static method in class org.jivesoftware.util.FastDateFormat
getInstance(String, TimeZone, Locale, DateFormatSymbols) - Static method in class org.jivesoftware.util.FastDateFormat
getLocale() - Method in class org.jivesoftware.util.FastDateFormat
getMaxLengthEstimate() - Method in class org.jivesoftware.util.FastDateFormat: Returns an estimate for the maximum length date that this date formatter will produce.
getName() - Method in class org.jivesoftware.whack.ExternalComponent
getPattern() - Method in class org.jivesoftware.util.FastDateFormat
getProperties(String) - Method in class org.jivesoftware.util.XMLProperties: Return all values who's path matches the given property name as a String array, or an empty array if the if there are no children.
getProperty(String) - Method in class org.jivesoftware.util.XMLProperties: Returns the value of the specified property.
getProperty(String) - Method in class org.jivesoftware.whack.ExternalComponentManager
getSecretKey(String) - Method in class org.jivesoftware.whack.ExternalComponentManager: Returns the secret key for a sub-domain.
getServerName() - Method in class org.jivesoftware.whack.ExternalComponentManager: Returns the domain of the XMPP server where we are connected to or null if this value was never configured.
getSubdomain() - Method in class org.jivesoftware.whack.ExternalComponent: Returns the subdomain provided by this component in the connected server.
getTimeInstance(Object, TimeZone, Locale) - Static method in class org.jivesoftware.util.FastDateFormat
getTimeZone() - Method in class org.jivesoftware.util.FastDateFormat: Returns the time zone used by this formatter, or null if time zone of formatted dates is used instead.
getXPPFactory() - Method in class org.dom4j.io.XPPPacketReader
getXPPParser() - Method in class org.dom4j.io.XPPPacketReader
GZIP - Static variable in class org.jivesoftware.util.Base64: Specify that data should be gzip-compressed.

H

hash(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Hashes a String using the SHA-1 algorithm and returns the result as a String of hexadecimal numbers.

I

initialize(JID, ComponentManager) - Method in class org.jivesoftware.whack.ExternalComponent
InputStream(InputStream) - Constructor for class org.jivesoftware.util.Base64.InputStream: Constructs a Base64.InputStream in DECODE mode.
InputStream(InputStream, int) - Constructor for class org.jivesoftware.util.Base64.InputStream: Constructs a Base64.InputStream in either ENCODE or DECODE mode.
isExternalMode() - Method in class org.jivesoftware.whack.ExternalComponentManager
isMultipleAllowed(String) - Method in class org.jivesoftware.whack.ExternalComponentManager: Returns if we want components to be able to connect multiple times to the same JID.

L

LONG - Static variable in class org.jivesoftware.util.FastDateFormat: Style pattern

M

main(String[]) - Static method in class org.jivesoftware.util.Base64: Encodes or decodes two files from the command line; feel free to delete this method (in fact you probably should) if you're embedding this code into a larger program.
MEDIUM - Static variable in class org.jivesoftware.util.FastDateFormat: Style pattern

N

NO_OPTIONS - Static variable in class org.jivesoftware.util.Base64: No options specified.

O

ORDERED - Static variable in class org.jivesoftware.util.Base64: Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
org.dom4j.io - package org.dom4j.io
org.jivesoftware.util - package org.jivesoftware.util
org.jivesoftware.whack - package org.jivesoftware.whack
org.jivesoftware.whack.util - package org.jivesoftware.whack.util
OutputStream(OutputStream) - Constructor for class org.jivesoftware.util.Base64.OutputStream: Constructs a Base64.OutputStream in ENCODE mode.
OutputStream(OutputStream, int) - Constructor for class org.jivesoftware.util.Base64.OutputStream: Constructs a Base64.OutputStream in either ENCODE or DECODE mode.

P

PacketReader - Class in org.jivesoftware.whack
PacketReader() - Constructor for class org.jivesoftware.whack.PacketReader
parseBareAddress(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Returns the XMPP address with any resource information removed.
parseDate(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Parses a textual representation of a Date based on the XMPP standard format and returns a Date.
parseDocument() - Method in class org.dom4j.io.XPPPacketReader
parseName(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Returns the name portion of a XMPP address.
parseResource(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Returns the resource portion of a XMPP address.
parseServer(String) - Static method in class org.jivesoftware.whack.util.StringUtils: Returns the server portion of a XMPP address.
processPacket(Packet) - Method in class org.jivesoftware.whack.ExternalComponent
property_deleted - Enum constant in enum org.jivesoftware.util.PropertyEventDispatcher.EventType: A property was deleted.
property_set - Enum constant in enum org.jivesoftware.util.PropertyEventDispatcher.EventType: A property was set.
propertyDeleted(String, Map) - Method in interface org.jivesoftware.util.PropertyEventListener: A property was deleted.
PropertyEventDispatcher - Class in org.jivesoftware.util: Dispatches property events.
PropertyEventDispatcher.EventType - Enum in org.jivesoftware.util: Represents valid event types.
PropertyEventListener - Interface in org.jivesoftware.util: Interface to listen for property events.
propertySet(String, Map) - Method in interface org.jivesoftware.util.PropertyEventListener: A property was set.

Q

query(Component, IQ, long) - Method in class org.jivesoftware.whack.ExternalComponentManager
query(Component, IQ, IQResultListener) - Method in class org.jivesoftware.whack.ExternalComponentManager

R

randomString(int) - Static method in class org.jivesoftware.whack.util.StringUtils: Returns a random String of numbers and letters (lower and upper case) of the specified length.
read() - Method in class org.jivesoftware.util.Base64.InputStream: Reads enough of the input stream to convert to/from Base64 and returns the next byte.
read(byte[], int, int) - Method in class org.jivesoftware.util.Base64.InputStream: Calls Base64.InputStream.read() repeatedly until the end of stream is reached or len bytes are read.
read(char[]) - Method in class org.dom4j.io.XPPPacketReader: Reads a Document from the given array of characters
read(File) - Method in class org.dom4j.io.XPPPacketReader: Reads a Document from the given File
read(InputStream) - Method in class org.dom4j.io.XPPPacketReader: Reads a Document from the given stream
read(InputStream, String) - Method in class org.dom4j.io.XPPPacketReader: Reads a Document from the given stream
read(Reader) - Method in class org.dom4j.io.XPPPacketReader: Reads a Document from the given Reader
read(Reader, String) - Method in class org.dom4j.io.XPPPacketReader: Reads a Document from the given Reader
read(String) - Method in class org.dom4j.io.XPPPacketReader: Reads a Document from the given URL or filename.
read(URL) - Method in class org.dom4j.io.XPPPacketReader: Reads a Document from the given URL
removeComponent(String) - Method in class org.jivesoftware.whack.ExternalComponentManager
removeHandler(String) - Method in class org.dom4j.io.XPPPacketReader: Removes the ElementHandler from the event based processor, for the specified path.
removeListener(PropertyEventListener) - Static method in class org.jivesoftware.util.PropertyEventDispatcher: Unregisters a listener to receive events.
resumeEncoding() - Method in class org.jivesoftware.util.Base64.OutputStream: Resumes encoding of the stream.

S

schedule(TimerTask, long) - Method in class org.jivesoftware.whack.util.TaskEngine: Schedules the specified task for execution after the specified delay.
schedule(TimerTask, long, long) - Method in class org.jivesoftware.whack.util.TaskEngine: Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay.
schedule(TimerTask, Date) - Method in class org.jivesoftware.whack.util.TaskEngine: Schedules the specified task for execution at the specified time.
schedule(TimerTask, Date, long) - Method in class org.jivesoftware.whack.util.TaskEngine: Schedules the specified task for repeated fixed-delay execution, beginning at the specified time.
scheduleAtFixedRate(TimerTask, long, long) - Method in class org.jivesoftware.whack.util.TaskEngine: Schedules the specified task for repeated fixed-rate execution, beginning after the specified delay.
scheduleAtFixedRate(TimerTask, Date, long) - Method in class org.jivesoftware.whack.util.TaskEngine: Schedules the specified task for repeated fixed-rate execution, beginning at the specified time.
send(Packet) - Method in class org.jivesoftware.whack.ExternalComponent
sendPacket(Component, Packet) - Method in class org.jivesoftware.whack.ExternalComponentManager
setConnectTimeout(int) - Method in class org.jivesoftware.whack.ExternalComponentManager: Sets the timeout (in milliseconds) to use when trying to connect to the server.
setDefaultHandler(ElementHandler) - Method in class org.dom4j.io.XPPPacketReader: When multiple ElementHandler instances have been registered, this will set a default ElementHandler to be called for any path which does NOT have a handler registered.
setDefaultSecretKey(String) - Method in class org.jivesoftware.whack.ExternalComponentManager: Sets the default secret key, which will be used when connecting if a specific secret key for the component hasn't been sent.
setDispatchHandler(DispatchHandler) - Method in class org.dom4j.io.XPPPacketReader
setDocumentFactory(DocumentFactory) - Method in class org.dom4j.io.XPPPacketReader: This sets the DocumentFactory used to create new documents.
setMultipleAllowed(String, boolean) - Method in class org.jivesoftware.whack.ExternalComponentManager: Sets whether we will tell the XMPP server that we want multiple components to be able to connect to the same JID.
setProperties(String, List<String>) - Method in class org.jivesoftware.util.XMLProperties: Sets a property to an array of values.
setProperties(Map<String, String>) - Method in class org.jivesoftware.util.XMLProperties
setProperty(String, String) - Method in class org.jivesoftware.util.XMLProperties: Sets the value of the specified property.
setProperty(String, String) - Method in class org.jivesoftware.whack.ExternalComponentManager
setSecretKey(String, String) - Method in class org.jivesoftware.whack.ExternalComponentManager: Sets a secret key for a sub-domain, for future use by a component connecting to the server.
setServerName(String) - Method in class org.jivesoftware.whack.ExternalComponentManager: Sets the domain of the XMPP server.
setXPPFactory(XmlPullParserFactory) - Method in class org.dom4j.io.XPPPacketReader
SHORT - Static variable in class org.jivesoftware.util.FastDateFormat: Style pattern
shutdown() - Method in class org.jivesoftware.whack.ExternalComponent
shutdown() - Method in class org.jivesoftware.whack.util.TaskEngine: Shuts down the task engine service.
start() - Method in class org.jivesoftware.whack.ExternalComponent
StringUtils - Class in org.jivesoftware.whack.util: A collection of utility methods for String objects.
submit(Runnable) - Method in class org.jivesoftware.whack.util.TaskEngine: Submits a Runnable task for execution and returns a Future representing that task.
suspendEncoding() - Method in class org.jivesoftware.util.Base64.OutputStream: Suspends encoding of the stream.

T

TaskEngine - Class in org.jivesoftware.whack.util: Performs tasks using worker threads.

U

URL_SAFE - Static variable in class org.jivesoftware.util.Base64: Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html.
UTC_FORMAT - Static variable in class org.jivesoftware.whack.util.StringUtils

V

valueOf(String) - Static method in enum org.jivesoftware.util.PropertyEventDispatcher.EventType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jivesoftware.util.PropertyEventDispatcher.EventType: Returns an array containing the constants of this enum type, in the order they are declared.

W

write(byte[], int, int) - Method in class org.jivesoftware.util.Base64.OutputStream: Calls Base64.OutputStream.write(int) repeatedly until len bytes are written.
write(int) - Method in class org.jivesoftware.util.Base64.OutputStream: Writes the byte to the output stream after converting to/from Base64 notation.

X

xml_property_deleted - Enum constant in enum org.jivesoftware.util.PropertyEventDispatcher.EventType: An XML property was deleted.
xml_property_set - Enum constant in enum org.jivesoftware.util.PropertyEventDispatcher.EventType: An XML property was set.
XMLProperties - Class in org.jivesoftware.util: Provides the the ability to use simple XML property files.
XMLProperties(File) - Constructor for class org.jivesoftware.util.XMLProperties: Creates a new XMLPropertiesTest object.
XMLProperties(InputStream) - Constructor for class org.jivesoftware.util.XMLProperties: Loads XML properties from a stream.
XMLProperties(String) - Constructor for class org.jivesoftware.util.XMLProperties: Creates a new XMLPropertiesTest object.
xmlPropertyDeleted(String, Map) - Method in interface org.jivesoftware.util.PropertyEventListener: An XML property was deleted.
xmlPropertySet(String, Map) - Method in interface org.jivesoftware.util.PropertyEventListener: An XML property was set.
XPPPacketReader - Class in org.dom4j.io: XPPPacketReader is a Reader of DOM4J documents that uses the fast XML Pull Parser 3.x.
XPPPacketReader() - Constructor for class org.dom4j.io.XPPPacketReader
XPPPacketReader(DocumentFactory) - Constructor for class org.dom4j.io.XPPPacketReader

A B C D E F G H I L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values