A B C D E F G H I J K L M N O P R S T U V W X Y

A

add(BotCall) - Method in class com.zion.jbuddy.bots.BotCallSet
Adds a call to this set.
add(BotCall, int) - Method in class com.zion.jbuddy.bots.BotCallSet
Adds a call to this set at the specified index.
add(BotEventHandler) - Method in class com.zion.jbuddy.bots.BotEventHandlerSet
Adds an event handler to this set.
add(BotEventHandler, int) - Method in class com.zion.jbuddy.bots.BotEventHandlerSet
Adds an event handler to this set at the specified index.
add(BotFilter) - Method in class com.zion.jbuddy.bots.BotFilterSet
Adds a filter to this set.
add(BotFilter, int) - Method in class com.zion.jbuddy.bots.BotFilterSet
Adds a filter to this set at the specified index.
add(Pattern) - Method in class com.zion.jbuddy.bots.BotPatternSet
Adds a pattern to this set.
add(BotRoute) - Method in class com.zion.jbuddy.bots.BotRouteSet
Adds a route to this set.
add(BotRoute, int) - Method in class com.zion.jbuddy.bots.BotRouteSet
Adds a route to this set at the specified index.
add(BotTarget) - Method in class com.zion.jbuddy.bots.BotTargetSet
Adds a target to this set.
add(BotTarget, int) - Method in class com.zion.jbuddy.bots.BotTargetSet
Adds a target to this set at the specified index.
addBuddy(String, String, String) - Method in class com.zion.jbuddy.bots.BotClient
Adds a user to the client's buddy list.
addBuddy(BotAddBuddyEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Adds a user to the client's Buddy List.
addBuddy(BotAddBuddyEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
addBuddy(BotAddBuddyEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a user needs to be added to a client's buddy list.
addClient(BotClient) - Method in class com.zion.jbuddy.bots.BotEngine
Adds a client to this engine.
addClient(String, String) - Method in class com.zion.jbuddy.bots.BotEngine
Adds a client to this engine.
addClientConnectionListener(BotClientConnectionListener) - Method in class com.zion.jbuddy.bots.BotEngine
Registers a listener to receive client connection events from this engine.
addDeny(String) - Method in class com.zion.jbuddy.bots.BotClient
Adds a user to the client's deny list.
addDeny(BotAddDenyEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Adds a user to the client's Deny List.
addDeny(BotAddDenyEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
addDeny(BotAddDenyEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a user needs to be added to a client's deny list.
addListener(BotEngineListener) - Method in class com.zion.jbuddy.bots.BotEngine
Registers a listener to receive events from this engine.
addPermit(String) - Method in class com.zion.jbuddy.bots.BotClient
Adds a user to the client's permit list.
addPermit(BotAddPermitEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Adds a user to the client's Permit List.
addPermit(BotAddPermitEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
addPermit(BotAddPermitEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a user needs to be added to a client's permit list.
ALL - Static variable in class com.zion.jbuddy.bots.BotLogLevel
All log messages will be reported.
AUTO - Static variable in class com.zion.jbuddy.bots.BotHTMLTidyMode
Uses HTML Tidy when necessary.
AUTO - Static variable in class com.zion.jbuddy.bots.BotHTTPCompressionType
Uses gzip (preferred) or deflate compression.

B

BOOLEAN - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts true/false values.
BotAction - Class in com.zion.jbuddy.bots
An external process carried out by the bot engine.
BotAction(BotActionType, String) - Constructor for class com.zion.jbuddy.bots.BotAction
Creates an action.
BotActionResultType - Class in com.zion.jbuddy.bots
Available action result types.
BotActionTask - Class in com.zion.jbuddy.bots
An external task that can be called from bot actions.
BotActionTask() - Constructor for class com.zion.jbuddy.bots.BotActionTask
 
BotActionType - Class in com.zion.jbuddy.bots
Available action types.
BotAddBuddyCall - Class in com.zion.jbuddy.bots
Adds a user to a client's buddy list.
BotAddBuddyCall(String, String, String) - Constructor for class com.zion.jbuddy.bots.BotAddBuddyCall
Creates an add buddy call.
BotAddBuddyEvent - Class in com.zion.jbuddy.bots.event
Encapsulates addBuddy event information.
BotAddBuddyEvent(BotClient, String, String, String) - Constructor for class com.zion.jbuddy.bots.event.BotAddBuddyEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotAddDenyCall - Class in com.zion.jbuddy.bots
Adds a user to a client's deny list.
BotAddDenyCall(String) - Constructor for class com.zion.jbuddy.bots.BotAddDenyCall
Creates an add deny call.
BotAddDenyEvent - Class in com.zion.jbuddy.bots.event
Encapsulates addDeny event information.
BotAddDenyEvent(BotClient, String) - Constructor for class com.zion.jbuddy.bots.event.BotAddDenyEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotAddPermitCall - Class in com.zion.jbuddy.bots
Adds a user to a client's permit list.
BotAddPermitCall(String) - Constructor for class com.zion.jbuddy.bots.BotAddPermitCall
Creates an add permit call.
BotAddPermitEvent - Class in com.zion.jbuddy.bots.event
Encapsulates addPermit event information.
BotAddPermitEvent(BotClient, String) - Constructor for class com.zion.jbuddy.bots.event.BotAddPermitEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotCall - Interface in com.zion.jbuddy.bots
A call that can be executed by the engine.
BotCallSet - Class in com.zion.jbuddy.bots
A set of calls.
BotClient - Class in com.zion.jbuddy.bots
Used by the bot engine to communicate with external networks.
BotClient(String, String) - Constructor for class com.zion.jbuddy.bots.BotClient
Creates a bot client.
BotClientConnectionAdapter - Class in com.zion.jbuddy.bots.event
A convenience class that implements BotClientConnectionListener methods to do nothing.
BotClientConnectionAdapter() - Constructor for class com.zion.jbuddy.bots.event.BotClientConnectionAdapter
 
BotClientConnectionEvent - Class in com.zion.jbuddy.bots.event
Encapsulates BotClientConnectionListener event information.
BotClientConnectionEvent(BotClient) - Constructor for class com.zion.jbuddy.bots.event.BotClientConnectionEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotClientConnectionEvent(BotClient, Exception) - Constructor for class com.zion.jbuddy.bots.event.BotClientConnectionEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotClientConnectionListener - Interface in com.zion.jbuddy.bots.event
Receives client connection events from a BotEngine.
BotClientEvent - Class in com.zion.jbuddy.bots.event
Encapsulates BotEngineListener client event information.
BotClientEvent(BotClient) - Constructor for class com.zion.jbuddy.bots.event.BotClientEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotContent - Class in com.zion.jbuddy.bots
Sends content to a user.
BotContent(RichContent) - Constructor for class com.zion.jbuddy.bots.BotContent
Creates content.
BotContent(String) - Constructor for class com.zion.jbuddy.bots.BotContent
Creates content, using the specified XHTML as its body.
BotDateTimeStyle - Class in com.zion.jbuddy.bots
Available date/time styles.
BotEngine - Class in com.zion.jbuddy.bots
Acts as a bot, processing user input and generating responses.
BotEngine() - Constructor for class com.zion.jbuddy.bots.BotEngine
Creates a bot engine.
BotEngineAdapter - Class in com.zion.jbuddy.bots.event
An adapter class for receiving bot engine events.
BotEngineAdapter() - Constructor for class com.zion.jbuddy.bots.event.BotEngineAdapter
 
BotEngineListener - Interface in com.zion.jbuddy.bots.event
The listener interface for receiving bot engine events.
BotEventHandler - Class in com.zion.jbuddy.bots
An event handler.
BotEventHandler(BotEventType) - Constructor for class com.zion.jbuddy.bots.BotEventHandler
Creates an event handler.
BotEventHandlerSet - Class in com.zion.jbuddy.bots
A set of event handlers.
BotEventType - Class in com.zion.jbuddy.bots
Available event types.
BotExcludeFilter - Class in com.zion.jbuddy.bots
Tells the engine NOT to allow events that match this filter.
BotExcludeFilter() - Constructor for class com.zion.jbuddy.bots.BotExcludeFilter
Creates an exclude filter.
BotFile - Class in com.zion.jbuddy.bots
Sends a file to a user.
BotFile(String) - Constructor for class com.zion.jbuddy.bots.BotFile
Creates a file.
BotFilter - Class in com.zion.jbuddy.bots
Tells the engine to allow (or disallow) events based on patterns.
BotFilterSet - Class in com.zion.jbuddy.bots
A set of filters.
BotGateway - Class in com.zion.jbuddy.bots
Provides functionality to a bot via an external network or source.
BotGateway() - Constructor for class com.zion.jbuddy.bots.BotGateway
 
BotHTMLTidyMode - Class in com.zion.jbuddy.bots
Available HTML Tidy modes.
BotHTTPCompressionType - Class in com.zion.jbuddy.bots
Available HTTP compression types.
BotHTTPMethod - Class in com.zion.jbuddy.bots
Available HTTP/1.1 methods.
BotIncludeFilter - Class in com.zion.jbuddy.bots
Tells the engine to allow events which match this filter.
BotIncludeFilter() - Constructor for class com.zion.jbuddy.bots.BotIncludeFilter
Creates an include filter.
BotLogLevel - Class in com.zion.jbuddy.bots
Available log levels.
BotMenu - Class in com.zion.jbuddy.bots
Organizes targets (and other menus) into a hierarchy.
BotMenu() - Constructor for class com.zion.jbuddy.bots.BotMenu
Creates a menu.
BotMessage - Class in com.zion.jbuddy.bots
Sends a message to a user.
BotMessage(String, RichContent) - Constructor for class com.zion.jbuddy.bots.BotMessage
Creates a message.
BotMessage(String, String) - Constructor for class com.zion.jbuddy.bots.BotMessage
Creates a message, using the specified type and XHTML body.
BotParameter - Class in com.zion.jbuddy.bots
Asks a user for input.
BotParameter(BotParameterType, String) - Constructor for class com.zion.jbuddy.bots.BotParameter
Creates a parameter.
BotParameterType - Class in com.zion.jbuddy.bots
Available parameter types.
BotPasswordEncrypter - Class in com.zion.jbuddy.bots
A command-line utility used to encrypt client passwords.
BotPasswordEncrypter() - Constructor for class com.zion.jbuddy.bots.BotPasswordEncrypter
 
BotPatternSet - Class in com.zion.jbuddy.bots
A set of patterns.
BotRemoveBuddyCall - Class in com.zion.jbuddy.bots
Removes a user from a client's buddy list.
BotRemoveBuddyCall(String, String) - Constructor for class com.zion.jbuddy.bots.BotRemoveBuddyCall
Creates a remove buddy call.
BotRemoveBuddyEvent - Class in com.zion.jbuddy.bots.event
Encapsulates removeBuddy event information.
BotRemoveBuddyEvent(BotClient, String, String) - Constructor for class com.zion.jbuddy.bots.event.BotRemoveBuddyEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotRemoveDenyCall - Class in com.zion.jbuddy.bots
Removes a user from a client's deny list.
BotRemoveDenyCall(String) - Constructor for class com.zion.jbuddy.bots.BotRemoveDenyCall
Creates a remove deny call.
BotRemoveDenyEvent - Class in com.zion.jbuddy.bots.event
Encapsulates removeDeny event information.
BotRemoveDenyEvent(BotClient, String) - Constructor for class com.zion.jbuddy.bots.event.BotRemoveDenyEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotRemovePermitCall - Class in com.zion.jbuddy.bots
Removes a user from a client's permit list.
BotRemovePermitCall(String) - Constructor for class com.zion.jbuddy.bots.BotRemovePermitCall
Creates a remove permit call.
BotRemovePermitEvent - Class in com.zion.jbuddy.bots.event
Encapsulates removePermit event information.
BotRemovePermitEvent(BotClient, String) - Constructor for class com.zion.jbuddy.bots.event.BotRemovePermitEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotRoute - Class in com.zion.jbuddy.bots
Routes are used to transfer call processing to clients/users that may not have been involved with the initial command or event.
BotRoute() - Constructor for class com.zion.jbuddy.bots.BotRoute
Creates a route.
BotRouteSet - Class in com.zion.jbuddy.bots
A set of routes.
BotRunner - Class in com.zion.jbuddy.bots
A command-line utility used to run a Bot Definition File.
BotSendFileEvent - Class in com.zion.jbuddy.bots.event
Encapsulates sendFile event information.
BotSendFileEvent(BotClient, String, BotFile) - Constructor for class com.zion.jbuddy.bots.event.BotSendFileEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotSendMessageEvent - Class in com.zion.jbuddy.bots.event
Encapsulates sendMessage event information.
BotSendMessageEvent(BotClient, String, BotMessage) - Constructor for class com.zion.jbuddy.bots.event.BotSendMessageEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotSetPermitModeCall - Class in com.zion.jbuddy.bots
Sets a bot's permit mode.
BotSetPermitModeCall(String) - Constructor for class com.zion.jbuddy.bots.BotSetPermitModeCall
Creates a set permit mode call.
BotSetPermitModeEvent - Class in com.zion.jbuddy.bots.event
Encapsulates setPermitMode event information.
BotSetPermitModeEvent(BotClient, String) - Constructor for class com.zion.jbuddy.bots.event.BotSetPermitModeEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotSetStatusCall - Class in com.zion.jbuddy.bots
Sets a bot's status.
BotSetStatusCall(String) - Constructor for class com.zion.jbuddy.bots.BotSetStatusCall
Creates a set status call.
BotSetStatusEvent - Class in com.zion.jbuddy.bots.event
Encapsulates setStatus event information.
BotSetStatusEvent(BotClient, String, String) - Constructor for class com.zion.jbuddy.bots.event.BotSetStatusEvent
This constructor is called from BotEngine and should not be used by outside implementations.
BotStatistics - Class in com.zion.jbuddy.bots
Various statistics.
BotTarget - Class in com.zion.jbuddy.bots
A group of calls executed by the engine in response to an event.
BotTarget() - Constructor for class com.zion.jbuddy.bots.BotTarget
Creates a target.
BotTargetSet - Class in com.zion.jbuddy.bots
A set of targets.
BotTester - Class in com.zion.jbuddy.bots
A command-line utility used to test a Bot Definition File.
BotUser - Class in com.zion.jbuddy.bots
Represents a bot user session.

C

clear() - Method in class com.zion.jbuddy.bots.BotCallSet
Removes all calls from this set.
clear() - Method in class com.zion.jbuddy.bots.BotEventHandlerSet
Removes all event handlers from this set.
clear() - Method in class com.zion.jbuddy.bots.BotFilterSet
Removes all filters from this this set.
clear() - Method in class com.zion.jbuddy.bots.BotPatternSet
Removes all patterns from this set.
clear() - Method in class com.zion.jbuddy.bots.BotRouteSet
Removes all routes from this set.
clear() - Method in class com.zion.jbuddy.bots.BotTargetSet
Removes all targets from this set.
clone() - Method in class com.zion.jbuddy.bots.BotAction
Returns an exact copy of this action.
clone() - Method in class com.zion.jbuddy.bots.BotAddBuddyCall
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotAddDenyCall
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotAddPermitCall
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotCallSet
Returns an exact copy of this set.
clone() - Method in class com.zion.jbuddy.bots.BotContent
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotEventHandler
Returns an exact copy of this event handler.
clone() - Method in class com.zion.jbuddy.bots.BotEventHandlerSet
Returns an exact copy of this set.
clone() - Method in class com.zion.jbuddy.bots.BotFile
Returns an exact copy of this file.
clone() - Method in class com.zion.jbuddy.bots.BotFilter
Makes an exact copy of this filter.
clone() - Method in class com.zion.jbuddy.bots.BotFilterSet
Returns an exact copy of this set.
clone() - Method in class com.zion.jbuddy.bots.BotMenu
Returns an exact copy of this menu.
clone() - Method in class com.zion.jbuddy.bots.BotMessage
Returns an exact copy of this message.
clone() - Method in class com.zion.jbuddy.bots.BotParameter
Makes an exact copy of this parameter.
clone() - Method in class com.zion.jbuddy.bots.BotPatternSet
Returns an exact copy of this set.
clone() - Method in class com.zion.jbuddy.bots.BotRemoveBuddyCall
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotRemoveDenyCall
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotRemovePermitCall
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotRoute
Returns an exact copy of this route.
clone() - Method in class com.zion.jbuddy.bots.BotRouteSet
Returns an exact copy of this set.
clone() - Method in class com.zion.jbuddy.bots.BotSetPermitModeCall
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotSetStatusCall
Returns an exact copy of this call.
clone() - Method in class com.zion.jbuddy.bots.BotTarget
Returns an exact copy of this target.
clone() - Method in class com.zion.jbuddy.bots.BotTargetSet
Returns an exact copy of this set.
com.zion.jbuddy.bots - package com.zion.jbuddy.bots
Classes used to build an interactive bot.
com.zion.jbuddy.bots.event - package com.zion.jbuddy.bots.event
Classes used to receive events from a bot.
command - Variable in class com.zion.jbuddy.bots.BotActionTask
The command the user entered, or null.
commandValue - Variable in class com.zion.jbuddy.bots.BotActionTask
The command value the user entered, or null.
connect() - Method in class com.zion.jbuddy.bots.BotClient
Connects this client to an external network.
connect() - Method in class com.zion.jbuddy.bots.BotGateway
Connects this gateway.
connected(BotClientConnectionEvent) - Method in class com.zion.jbuddy.bots.event.BotClientConnectionAdapter
 
connected(BotClientConnectionEvent) - Method in interface com.zion.jbuddy.bots.event.BotClientConnectionListener
Fired when a BotClient has connected successfully to a BotGateway.
connecting(BotClientConnectionEvent) - Method in class com.zion.jbuddy.bots.event.BotClientConnectionAdapter
 
connecting(BotClientConnectionEvent) - Method in interface com.zion.jbuddy.bots.event.BotClientConnectionListener
Fired when a BotClient begins connecting to a BotGateway.
couldNotConnect(BotClientConnectionEvent) - Method in class com.zion.jbuddy.bots.event.BotClientConnectionAdapter
 
couldNotConnect(BotClientConnectionEvent) - Method in interface com.zion.jbuddy.bots.event.BotClientConnectionListener
Fired when a BotClient could not connect to a BotGateway for some reason.
createClassLoader() - Method in class com.zion.jbuddy.bots.BotEngine
Returns the class loader used by this engine to load resources, such as action tasks, resource bundles, and XSL transformations.
CURRENCY - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts numeric currency values.

D

DATE - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts date values.
DATE_TIME - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts combined date/time values.
DEBUG - Static variable in class com.zion.jbuddy.bots.BotLogLevel
Debug messages (or higher) will be reported.
DEFLATE - Static variable in class com.zion.jbuddy.bots.BotHTTPCompressionType
Uses deflate compression.
DELETE - Static variable in class com.zion.jbuddy.bots.BotHTTPMethod
The DELETE method requests that the origin server delete the resource identified by the Request-URI.
disconnect() - Method in class com.zion.jbuddy.bots.BotClient
Disconnects this client from the external network.
disconnect() - Method in class com.zion.jbuddy.bots.BotGateway
Disconnects this gateway.
disconnected(BotClientConnectionEvent) - Method in class com.zion.jbuddy.bots.event.BotClientConnectionAdapter
 
disconnected(BotClientConnectionEvent) - Method in interface com.zion.jbuddy.bots.event.BotClientConnectionListener
Fired when a BotClient lost its connection to a BotGateway for some reason.
dispose() - Method in class com.zion.jbuddy.bots.BotGateway
Disposes of resources used by this gateway.
DOUBLE - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts floating-point numbers between 2-1074 and (2 - 2-52) x 21023, inclusive.

E

encryptPassword(String, String) - Static method in class com.zion.jbuddy.bots.BotEngine
Encrypts a password for use in a Bot Definition File.
engine - Variable in class com.zion.jbuddy.bots.BotActionTask
The bot engine associated with the action.
equals(BotClient) - Method in class com.zion.jbuddy.bots.BotClient
Returns true if this client is equal to the specified client.
equals(Object) - Method in class com.zion.jbuddy.bots.BotClient
 
equals(Object) - Method in class com.zion.jbuddy.bots.BotUser
 
ERROR - Static variable in class com.zion.jbuddy.bots.BotLogLevel
Only error messages will be reported.
EXCEPTION - Static variable in class com.zion.jbuddy.bots.BotLogLevel
Exception messages (or higher) will be reported.
execute() - Method in class com.zion.jbuddy.bots.BotActionTask
Executes this task.

F

FILE - Static variable in class com.zion.jbuddy.bots.BotActionResultType
Results are written to a temporary file and sent to the user as a BotFile.
FULL - Static variable in class com.zion.jbuddy.bots.BotDateTimeStyle
A full style pattern.

G

GET - Static variable in class com.zion.jbuddy.bots.BotHTTPMethod
The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI.
get(String) - Static method in class com.zion.jbuddy.bots.BotParameterType
 
getBody() - Method in class com.zion.jbuddy.bots.BotContent
Returns this content's body.
getBody() - Method in class com.zion.jbuddy.bots.BotMessage
Returns this message's body.
getBooleanValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a boolean parameter value.
getBotParameter(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the specified parameter.
getBotParameters() - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the parameters submitted to this action task, mapped by their associated names (key = String, value = BotParameter).
getByCommand(String) - Method in class com.zion.jbuddy.bots.BotTargetSet
Returns the first target with the specified command, or null.
getByID(String) - Method in class com.zion.jbuddy.bots.BotEventHandlerSet
Returns the event handler with the specified ID, or null.
getByID(String) - Method in class com.zion.jbuddy.bots.BotTargetSet
Returns the target with the specified ID, or null.
getCalls() - Method in class com.zion.jbuddy.bots.BotCallSet
Returns a List of calls in this set.
getCalls() - Method in class com.zion.jbuddy.bots.BotEventHandler
Returns the calls executed by this event handler.
getCalls() - Method in class com.zion.jbuddy.bots.BotMenu
Throws an UnsupportedOperationException, as menus may not execute calls.
getCalls() - Method in class com.zion.jbuddy.bots.BotTarget
Returns the calls executed by this target.
getCancelCommand() - Method in class com.zion.jbuddy.bots.BotParameter
Returns the cancel command.
getClient() - Method in class com.zion.jbuddy.bots.BotGateway
Returns the client this gateway is associated with.
getClient() - Method in class com.zion.jbuddy.bots.BotUser
Returns the client this user is associated with.
getClient() - Method in class com.zion.jbuddy.bots.event.BotClientEvent
Returns the client associated with this event.
getClientPatterns() - Method in class com.zion.jbuddy.bots.BotFilter
Returns the patterns used to match client names.
getClients() - Method in class com.zion.jbuddy.bots.BotEngine
Returns a List of clients in this engine.
getCommand() - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the command the user entered, or null.
getCommand() - Method in class com.zion.jbuddy.bots.BotTarget
Returns the command used to trigger this target.
getCommandValue() - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the command value the user entered, or null.
getConnectTimeout() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's connect timeout value, in milliseconds.
getCreationTime() - Method in class com.zion.jbuddy.bots.BotUser
Returns the system time when this user was created.
getCurrencyValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a currency parameter value.
getCustomProperty(String) - Method in class com.zion.jbuddy.bots.BotClient
Returns a custom property value.
getCustomProperty(String) - Method in class com.zion.jbuddy.bots.BotUser
Returns a custom property value.
getDateFormat() - Method in class com.zion.jbuddy.bots.BotParameter
Returns the date format to use.
getDateStyle() - Method in class com.zion.jbuddy.bots.BotParameter
Returns the date style to use.
getDateTimeValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a date-time parameter value.
getDateValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a date parameter value.
getDescription() - Method in class com.zion.jbuddy.bots.BotAction
Returns this action's description.
getDescription() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's description.
getDescription() - Method in class com.zion.jbuddy.bots.BotFile
Returns this file's description.
getDescription() - Method in class com.zion.jbuddy.bots.BotMenu
Returns this menu's description.
getDescription() - Method in class com.zion.jbuddy.bots.BotParameter
Returns this parameter's description.
getDisplayName() - Method in class com.zion.jbuddy.bots.BotAddBuddyCall
Returns the user's display name.
getDisplayName() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's display name.
getDisplayName() - Method in class com.zion.jbuddy.bots.BotUser
Returns this user's display name.
getDisplayName() - Method in class com.zion.jbuddy.bots.event.BotAddBuddyEvent
Returns the user's display name.
getDoubleValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a double parameter value.
getEngine() - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the bot engine associated with the action.
getEngine() - Method in class com.zion.jbuddy.bots.BotClient
Returns the engine this client is associated with.
getEventHandlers() - Method in class com.zion.jbuddy.bots.BotEngine
Returns this engine's event handlers.
getEventHandlers() - Method in class com.zion.jbuddy.bots.BotEventHandlerSet
Returns a List of event handlers in this set.
getEventHandlers() - Method in class com.zion.jbuddy.bots.BotMenu
Returns this menu's local event handlers.
getEventHandlers() - Method in class com.zion.jbuddy.bots.BotUser
Returns this user's event handlers.
getException() - Method in class com.zion.jbuddy.bots.event.BotClientConnectionEvent
Returns the exception that occurred.
getFile() - Method in class com.zion.jbuddy.bots.event.BotSendFileEvent
Returns the file being sent.
getFilters() - Method in class com.zion.jbuddy.bots.BotEventHandler
Returns this event handler's filters.
getFilters() - Method in class com.zion.jbuddy.bots.BotFilterSet
Returns a List of filters in this set.
getFilters() - Method in class com.zion.jbuddy.bots.BotTarget
Returns this target's filters.
getGatewayClass() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's BotGateway class.
getGroup() - Method in class com.zion.jbuddy.bots.BotAddBuddyCall
Returns the group to add the user to.
getGroup() - Method in class com.zion.jbuddy.bots.BotRemoveBuddyCall
Returns the group to remove the user from.
getGroup() - Method in class com.zion.jbuddy.bots.event.BotAddBuddyEvent
Returns the group to add the user to.
getGroup() - Method in class com.zion.jbuddy.bots.event.BotRemoveBuddyEvent
Returns the group to remove the user from.
getHost() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's host address.
getHTMLTidyMode() - Method in class com.zion.jbuddy.bots.BotAction
Returns the HTML Tidy mode to use.
getHTTPCompressionType() - Method in class com.zion.jbuddy.bots.BotAction
Returns the requested HTTP compression type to use.
getHTTPMethod() - Method in class com.zion.jbuddy.bots.BotAction
Returns the HTTP/1.1 request method to use.
getHTTPUserAgent() - Method in class com.zion.jbuddy.bots.BotAction
Returns the HTTP User-Agent value to use.
getID() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's identifier.
getID() - Method in class com.zion.jbuddy.bots.BotEventHandler
Returns this event handler's identifier.
getID() - Method in class com.zion.jbuddy.bots.BotTarget
Returns this target's identifier.
getIntValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns an int parameter value.
getJBuddyClient() - Method in class com.zion.jbuddy.bots.BotClient
Returns the JBuddy SDK client being used.
getLocale() - Method in class com.zion.jbuddy.bots.BotParameter
Returns the locale to use for this parameter.
getLogLevel() - Method in class com.zion.jbuddy.bots.BotEngine
Returns this engine's log level.
getLogOutput() - Method in class com.zion.jbuddy.bots.BotEngine
Returns this engine's log output.
getLongValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a long parameter value.
getMenuHistorySize() - Method in class com.zion.jbuddy.bots.BotEngine
Returns the user menu history size.
getMessage() - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the message the user entered, or null.
getMessage() - Method in class com.zion.jbuddy.bots.BotSetStatusCall
Returns the status message.
getMessage() - Method in class com.zion.jbuddy.bots.event.BotSendMessageEvent
Returns the message being sent.
getMessage() - Method in class com.zion.jbuddy.bots.event.BotSetStatusEvent
Returns the status message.
getMessagePatterns() - Method in class com.zion.jbuddy.bots.BotFilter
Returns the patterns used to match message bodies.
getMessagesReceived() - Method in class com.zion.jbuddy.bots.BotStatistics
Returns the number of messages received since the engine was started.
getMessagesSent() - Method in class com.zion.jbuddy.bots.BotStatistics
Returns the number of messages sent since the engine was started.
getMessageTypePatterns() - Method in class com.zion.jbuddy.bots.BotFilter
Returns the patterns used to match message types.
getName() - Method in class com.zion.jbuddy.bots.BotAddBuddyCall
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.BotAddDenyCall
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.BotAddPermitCall
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's unique name.
getName() - Method in class com.zion.jbuddy.bots.BotParameter
Returns this parameter's name.
getName() - Method in class com.zion.jbuddy.bots.BotRemoveBuddyCall
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.BotRemoveDenyCall
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.BotRemovePermitCall
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.BotUser
Returns this user's unique name.
getName() - Method in class com.zion.jbuddy.bots.event.BotAddBuddyEvent
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.event.BotAddDenyEvent
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.event.BotAddPermitEvent
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.event.BotRemoveBuddyEvent
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.event.BotRemoveDenyEvent
Returns the user's name.
getName() - Method in class com.zion.jbuddy.bots.event.BotRemovePermitEvent
Returns the user's name.
getNumberFormat() - Method in class com.zion.jbuddy.bots.BotParameter
Returns the number format to use.
getNumberValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a number parameter value.
getParameter(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the specified parameter value.
getParameters() - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the parameter values submitted to this action task, mapped by the associated parameter names (key = String, value = Object).
getPassKey() - Method in class com.zion.jbuddy.bots.BotEngine
Returns this engine's pass key.
getPassword() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's password.
getPath() - Method in class com.zion.jbuddy.bots.BotAction
Returns this action's path.
getPath() - Method in class com.zion.jbuddy.bots.BotFile
Returns this file's path.
getPatterns() - Method in class com.zion.jbuddy.bots.BotParameter
Returns this parameter's validation patterns.
getPatterns() - Method in class com.zion.jbuddy.bots.BotPatternSet
Returns a List of patterns in this set.
getPeakSessions() - Method in class com.zion.jbuddy.bots.BotStatistics
Returns the peak (highest) number of concurrent user sessions that occurred since the engine was started.
getPercentValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a percent parameter value.
getPermitMode() - Method in class com.zion.jbuddy.bots.BotClient
Returns the client's permit mode.
getPermitMode() - Method in class com.zion.jbuddy.bots.BotSetPermitModeCall
Returns the permit mode.
getPermitMode() - Method in class com.zion.jbuddy.bots.event.BotSetPermitModeEvent
Returns the permit mode.
getPort() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's port.
getProperties() - Method in class com.zion.jbuddy.bots.BotClient
Returns system properties that pertain to this client.
getProtocol() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's protocol.
getProtocolPatterns() - Method in class com.zion.jbuddy.bots.BotFilter
Returns the patterns used to match protocol names.
getRecipients() - Method in class com.zion.jbuddy.bots.BotFile
Returns this file's recipients.
getRecipients() - Method in class com.zion.jbuddy.bots.BotMessage
Returns the message's recipients.
getRecipients() - Method in class com.zion.jbuddy.bots.BotRoute
Returns the list of user names to send responses to.
getReconnectDelay() - Method in class com.zion.jbuddy.bots.BotGateway
Returns the amount of time the engine must wait before reconnecting this gateway (after disconnecting or a connection attempt fails).
getResourceBundle() - Method in class com.zion.jbuddy.bots.BotEngine
Returns this engine's resource bundle.
getResultType() - Method in class com.zion.jbuddy.bots.BotAction
Returns this action's result type.
getRoutes() - Method in class com.zion.jbuddy.bots.BotEventHandler
Returns this event handler's routes.
getRoutes() - Method in class com.zion.jbuddy.bots.BotRouteSet
Returns a List of routes in this set.
getRoutes() - Method in class com.zion.jbuddy.bots.BotTarget
Returns this target's routes.
getSender() - Method in class com.zion.jbuddy.bots.BotRoute
Returns the id of the client to send responses from.
getSessions() - Method in class com.zion.jbuddy.bots.BotStatistics
Returns the current number of user sessions.
getStatistics() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's statistics.
getStatistics() - Method in class com.zion.jbuddy.bots.BotEngine
Returns this engine's statistics.
getStatus() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's status.
getStatus() - Method in class com.zion.jbuddy.bots.BotSetStatusCall
Returns the status type.
getStatus() - Method in class com.zion.jbuddy.bots.BotUser
Returns this user's status.
getStatus() - Method in class com.zion.jbuddy.bots.event.BotSetStatusEvent
Returns the status.
getStatusMessage() - Method in class com.zion.jbuddy.bots.BotClient
Returns this client's status message.
getStatusMessage() - Method in class com.zion.jbuddy.bots.BotUser
Returns this user's status message.
getStatusMessagePatterns() - Method in class com.zion.jbuddy.bots.BotFilter
Returns the patterns used to match status messages.
getStatusPatterns() - Method in class com.zion.jbuddy.bots.BotFilter
Returns the patterns used to match status types.
getStringValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a string parameter value.
getTargets() - Method in class com.zion.jbuddy.bots.BotEngine
Returns this engine's targets.
getTargets() - Method in class com.zion.jbuddy.bots.BotMenu
Returns this menu's targets.
getTargets() - Method in class com.zion.jbuddy.bots.BotTargetSet
Returns a List of targets in this set.
getTargets() - Method in class com.zion.jbuddy.bots.BotUser
Returns this user's targets.
getTargetsByCommand(String) - Method in class com.zion.jbuddy.bots.BotTargetSet
Returns a List of targets with the specified command.
getThreadPoolSize() - Method in class com.zion.jbuddy.bots.BotEngine
Returns the size of the internal thread pool this bot engine uses to process requests.
getTimeout() - Method in class com.zion.jbuddy.bots.BotAction
Returns this action's timeout value, in milliseconds.
getTimeStyle() - Method in class com.zion.jbuddy.bots.BotParameter
Returns the time style to use.
getTimeValue(String) - Method in class com.zion.jbuddy.bots.BotActionTask
Returns a time parameter value.
getTitle() - Method in class com.zion.jbuddy.bots.BotTarget
Returns this target's title.
getTotalSessions() - Method in class com.zion.jbuddy.bots.BotStatistics
Returns the total number of user sessions handled since the engine was started.
getTransformPath() - Method in class com.zion.jbuddy.bots.BotAction
Returns this action's XSLT path.
getType() - Method in class com.zion.jbuddy.bots.BotAction
Returns this action's type.
getType() - Method in class com.zion.jbuddy.bots.BotEventHandler
Returns the type of event that triggers this event handler.
getType() - Method in class com.zion.jbuddy.bots.BotMessage
Returns this message's type.
getType() - Method in class com.zion.jbuddy.bots.BotParameter
Returns this parameter's type.
getUniqueSessions() - Method in class com.zion.jbuddy.bots.BotStatistics
Returns the number of unique user sessions handled in the last 24 hours since the engine was started.
getUpdateTime() - Method in class com.zion.jbuddy.bots.BotUser
Returns the system time when this user was last updated.
getUser() - Method in class com.zion.jbuddy.bots.BotActionTask
Returns the user associated with the action.
getUser(String) - Method in class com.zion.jbuddy.bots.BotClient
Returns the user session with the specified name.
getUserName() - Method in class com.zion.jbuddy.bots.event.BotSendFileEvent
Returns the name of the user being sent to.
getUserName() - Method in class com.zion.jbuddy.bots.event.BotSendMessageEvent
Returns the name of the user being sent to.
getUserPatterns() - Method in class com.zion.jbuddy.bots.BotFilter
Returns the patterns used to match user names.
getUserTimeout() - Method in class com.zion.jbuddy.bots.BotEngine
Returns the amount of time, in milliseconds, before idle user sessions are timed-out.
getValue() - Method in class com.zion.jbuddy.bots.BotParameter
Returns this parameter's value.
GZIP - Static variable in class com.zion.jbuddy.bots.BotHTTPCompressionType
Uses gzip compression.

H

hashCode() - Method in class com.zion.jbuddy.bots.BotClient
 
hashCode() - Method in class com.zion.jbuddy.bots.BotUser
 
HEAD - Static variable in class com.zion.jbuddy.bots.BotHTTPMethod
The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response.
HTML - Static variable in class com.zion.jbuddy.bots.BotActionResultType
Results are processed as HTML (rich content) and sent to the user as BotContent.

I

INT - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts whole numbers between -232 and 232-1, inclusive.
isAutomaticallyConnectClients() - Method in class com.zion.jbuddy.bots.BotEngine
Returns whether this engine automatically connects clients.
isConnected() - Method in class com.zion.jbuddy.bots.BotClient
Returns whether this client is connected to an external network.
isConnecting() - Method in class com.zion.jbuddy.bots.BotClient
Returns whether this client is in the process of connecting.
isConsume() - Method in class com.zion.jbuddy.bots.BotEventHandler
Returns whether this event handler consumes events.
isDefault() - Method in class com.zion.jbuddy.bots.BotTarget
Returns true if this is a default target.
isGlobal() - Method in class com.zion.jbuddy.bots.BotSetPermitModeCall
Returns whether all clients are affected.
isGlobal() - Method in class com.zion.jbuddy.bots.BotSetStatusCall
Returns whether all clients are affected.
isHidden() - Method in class com.zion.jbuddy.bots.BotParameter
Returns whether this parameter is hidden.
isPasswordEncrypted() - Method in class com.zion.jbuddy.bots.BotClient
Returns whether the password is encrypted.
isRunning() - Method in class com.zion.jbuddy.bots.BotEngine
Returns true if this engine is running (has been started).
isShowBack() - Method in class com.zion.jbuddy.bots.BotMenu
Returns whether the back command is shown as a selection in this menu when a previously viewed menu exists in the user's menu history.
isShowCommands() - Method in class com.zion.jbuddy.bots.BotMenu
Returns whether this menu's available commands are presented to the user.
isShowTitle() - Method in class com.zion.jbuddy.bots.BotMenu
Returns whether this menu's title is shown when a user views this menu.

J

JAVA - Static variable in class com.zion.jbuddy.bots.BotActionType
Loads and processes results from a BotActionTask.

K

key - Variable in class com.zion.jbuddy.bots.BotEventType
 

L

loadDefinition(InputSource) - Method in class com.zion.jbuddy.bots.BotEngine
Loads Bot Definition XML from the specified input source.
loadDefinition(InputStream) - Method in class com.zion.jbuddy.bots.BotEngine
Loads Bot Definition XML from the specified input stream.
loadDefinition(String) - Method in class com.zion.jbuddy.bots.BotEngine
Loads Bot Definition XML from the specified path.
LONG - Static variable in class com.zion.jbuddy.bots.BotDateTimeStyle
A long style pattern.
LONG - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts whole numbers between -263 and 263-1, inclusive.

M

main(String[]) - Static method in class com.zion.jbuddy.bots.BotPasswordEncrypter
 
main(String[]) - Static method in class com.zion.jbuddy.bots.BotRunner
Runs the bot runner.
main(String[]) - Static method in class com.zion.jbuddy.bots.BotTester
Runs the bot tester.
matches(String) - Method in class com.zion.jbuddy.bots.BotPatternSet
Returns true if any of the patterns in this set match the specified string.
MEDIUM - Static variable in class com.zion.jbuddy.bots.BotDateTimeStyle
A medium style pattern.
message - Variable in class com.zion.jbuddy.bots.BotActionTask
The message the user entered, or null.
MESSAGE - Static variable in class com.zion.jbuddy.bots.BotEventType
Represents an incoming message event.

N

NO - Static variable in class com.zion.jbuddy.bots.BotHTMLTidyMode
Disables HTML Tidy.
NONE - Static variable in class com.zion.jbuddy.bots.BotActionResultType
No results are returned.
NONE - Static variable in class com.zion.jbuddy.bots.BotHTTPCompressionType
No compression will occur.
notifyConnected() - Method in class com.zion.jbuddy.bots.BotGateway
Notifies the BotEngine that this gateway has been successfully connected.
notifyCouldNotConnect(Exception, boolean) - Method in class com.zion.jbuddy.bots.BotGateway
Notifies the BotEngine that this gateway could not be connected.
notifyDisconnected(Exception, boolean) - Method in class com.zion.jbuddy.bots.BotGateway
Notifies the BotEngine that this gateway's connection has been closed or severed unexpectedly.
NUMBER - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts numeric values.

O

OFF - Static variable in class com.zion.jbuddy.bots.BotLogLevel
No log messages will be reported.
OPTIONS - Static variable in class com.zion.jbuddy.bots.BotHTTPMethod
The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI.

P

parameters - Variable in class com.zion.jbuddy.bots.BotActionTask
The parameter values submitted to this action task, mapped by the associated parameter names (key = String, value = Object).
PERCENT - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts numeric percentage values.
POST - Static variable in class com.zion.jbuddy.bots.BotHTTPMethod
The POST method is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line.
PRESENCE - Static variable in class com.zion.jbuddy.bots.BotEventType
Represents a user presence event.
processMessage(BotMessage) - Method in class com.zion.jbuddy.bots.BotUser
Processes an incoming message from this user.
processPresence() - Method in class com.zion.jbuddy.bots.BotUser
Processes a presence change from this user.
processXML(Document) - Method in class com.zion.jbuddy.bots.BotUser
Processes Bot Definition XML.
processXML(InputSource) - Method in class com.zion.jbuddy.bots.BotUser
Processes Bot Definition XML.
PUT - Static variable in class com.zion.jbuddy.bots.BotHTTPMethod
The PUT method requests that the enclosed entity be stored under the supplied Request-URI.

R

receiveMessage(String, BotMessage) - Method in class com.zion.jbuddy.bots.BotGateway
Notifies the BotEngine that a message has been received.
remove(BotCall) - Method in class com.zion.jbuddy.bots.BotCallSet
Removes a call from this set.
remove(BotEventHandler) - Method in class com.zion.jbuddy.bots.BotEventHandlerSet
Removes an event handler from this set.
remove(BotFilter) - Method in class com.zion.jbuddy.bots.BotFilterSet
Removes a filter from this set.
remove(Pattern) - Method in class com.zion.jbuddy.bots.BotPatternSet
Removes a pattern from this set.
remove(BotRoute) - Method in class com.zion.jbuddy.bots.BotRouteSet
Removes a route from this set.
remove(BotTarget) - Method in class com.zion.jbuddy.bots.BotTargetSet
Removes a target from this set.
removeBuddy(String) - Method in class com.zion.jbuddy.bots.BotClient
Removes a user from the client's buddy list.
removeBuddy(String, String) - Method in class com.zion.jbuddy.bots.BotClient
Removes a user from the client's buddy list.
removeBuddy(BotRemoveBuddyEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Removes a user from the client's Buddy List.
removeBuddy(BotRemoveBuddyEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
removeBuddy(BotRemoveBuddyEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a user needs to be removed from a client's buddy list.
removeClient(BotClient) - Method in class com.zion.jbuddy.bots.BotEngine
Removes a client from this engine.
removeClientConnectionListener(BotClientConnectionListener) - Method in class com.zion.jbuddy.bots.BotEngine
Stops a listener from receiving client connection events from this engine.
removeDeny(String) - Method in class com.zion.jbuddy.bots.BotClient
Removes a user from the client's deny list.
removeDeny(BotRemoveDenyEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Removes a user from the client's Deny List.
removeDeny(BotRemoveDenyEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
removeDeny(BotRemoveDenyEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a user needs to be removed from a client's deny list.
removeListener(BotEngineListener) - Method in class com.zion.jbuddy.bots.BotEngine
Stops a listener from receiving events from this engine.
removePermit(String) - Method in class com.zion.jbuddy.bots.BotClient
Removes a user from the client's permit list.
removePermit(BotRemovePermitEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Removes a user from the client's Permit List.
removePermit(BotRemovePermitEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
removePermit(BotRemovePermitEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a user needs to be removed from a client's permit list.

S

sendFile(String, BotFile) - Method in class com.zion.jbuddy.bots.BotClient
Sends a file to this user.
sendFile(BotSendFileEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Sends a file to a user.
sendFile(BotSendFileEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
sendFile(BotSendFileEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a file needs to be sent to a user.
sendMessage(String, BotMessage) - Method in class com.zion.jbuddy.bots.BotClient
Sends a message to a user.
sendMessage(BotSendMessageEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Overridden to send an outgoing message.
sendMessage(BotSendMessageEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
sendMessage(BotSendMessageEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a message needs to be sent to a user.
setAutomaticallyConnectClients(boolean) - Method in class com.zion.jbuddy.bots.BotEngine
Sets whether this engine automatically connects clients.
setBody(RichContent) - Method in class com.zion.jbuddy.bots.BotContent
Sets this content's body.
setBody(String) - Method in class com.zion.jbuddy.bots.BotContent
Sets this content's body, using the specified XHTML.
setBody(RichContent) - Method in class com.zion.jbuddy.bots.BotMessage
Sets this message's body.
setBody(String) - Method in class com.zion.jbuddy.bots.BotMessage
Sets this message's body, using the specified XHTML.
setCancelCommand(String) - Method in class com.zion.jbuddy.bots.BotParameter
Sets the cancel command.
setCommand(String) - Method in class com.zion.jbuddy.bots.BotTarget
Sets the command used to trigger this target.
setConnectTimeout(long) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's connect timeout value, in milliseconds.
setConsume(boolean) - Method in class com.zion.jbuddy.bots.BotEventHandler
Sets whether this event handler consumes events.
setCustomProperty(String, Object) - Method in class com.zion.jbuddy.bots.BotClient
Sets a custom property value.
setCustomProperty(String, Object) - Method in class com.zion.jbuddy.bots.BotUser
Sets a custom property value.
setDateFormat(DateFormat) - Method in class com.zion.jbuddy.bots.BotParameter
Sets the date format to use.
setDateStyle(BotDateTimeStyle) - Method in class com.zion.jbuddy.bots.BotParameter
The date style to use.
setDefault(boolean) - Method in class com.zion.jbuddy.bots.BotTarget
Sets whether this is a default target.
setDescription(RichContent) - Method in class com.zion.jbuddy.bots.BotAction
Sets this action's description.
setDescription(String) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's description.
setDescription(RichContent) - Method in class com.zion.jbuddy.bots.BotFile
Sets this file's description.
setDescription(RichContent) - Method in class com.zion.jbuddy.bots.BotMenu
Sets this menu's description.
setDescription(RichContent) - Method in class com.zion.jbuddy.bots.BotParameter
Sets this parameter's description.
setDisplayName(String) - Method in class com.zion.jbuddy.bots.BotAddBuddyCall
Sets the user's display name.
setDisplayName(String) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's display name.
setDisplayName(String) - Method in class com.zion.jbuddy.bots.BotUser
Sets this user's display name.
setGatewayClass(Class) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's BotGateway class.
setGlobal(boolean) - Method in class com.zion.jbuddy.bots.BotSetPermitModeCall
Sets whether all clients are affected.
setGlobal(boolean) - Method in class com.zion.jbuddy.bots.BotSetStatusCall
Sets whether all clients are affected.
setGroup(String) - Method in class com.zion.jbuddy.bots.BotAddBuddyCall
Sets the group to add the user to.
setGroup(String) - Method in class com.zion.jbuddy.bots.BotRemoveBuddyCall
Sets the group to remove the user from.
setHidden(boolean) - Method in class com.zion.jbuddy.bots.BotParameter
Sets whether this parameter is hidden.
setHost(String) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's host address.
setHTMLTidyMode(BotHTMLTidyMode) - Method in class com.zion.jbuddy.bots.BotAction
Sets the HTML Tidy mode to use.
setHTTPCompressionType(BotHTTPCompressionType) - Method in class com.zion.jbuddy.bots.BotAction
Sets the requested HTTP compression type to use.
setHTTPMethod(BotHTTPMethod) - Method in class com.zion.jbuddy.bots.BotAction
Sets the HTTP/1.1 request method to use.
setHTTPUserAgent(String) - Method in class com.zion.jbuddy.bots.BotAction
Sets the HTTP User-Agent value to use.
setID(String) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's identifier, which can be used to reference this client.
setID(String) - Method in class com.zion.jbuddy.bots.BotEventHandler
Sets this event handler's identifier, which can be used by other event handlers to reference this event handler (with the ref attribute).
setID(String) - Method in class com.zion.jbuddy.bots.BotTarget
Sets this target's identifier, which can be used by other targets to reference this target (with the ref attribute).
setLocale(Locale) - Method in class com.zion.jbuddy.bots.BotParameter
Sets the locale to use for this parameter.
setLogLevel(BotLogLevel) - Method in class com.zion.jbuddy.bots.BotEngine
Sets this engine's log level.
setLogOutput(PrintStream) - Method in class com.zion.jbuddy.bots.BotEngine
Sets this engine's log output.
setMenuHistorySize(int) - Method in class com.zion.jbuddy.bots.BotEngine
Sets the user menu history size.
setMessage(String) - Method in class com.zion.jbuddy.bots.BotSetStatusCall
Sets the status message.
setName(String) - Method in class com.zion.jbuddy.bots.BotAddBuddyCall
Sets the user's name.
setName(String) - Method in class com.zion.jbuddy.bots.BotAddDenyCall
Sets the user's name.
setName(String) - Method in class com.zion.jbuddy.bots.BotAddPermitCall
Sets the user's name.
setName(String) - Method in class com.zion.jbuddy.bots.BotParameter
Sets this parameter's name.
setName(String) - Method in class com.zion.jbuddy.bots.BotRemoveBuddyCall
Sets the user's name.
setName(String) - Method in class com.zion.jbuddy.bots.BotRemoveDenyCall
Sets the user's name.
setName(String) - Method in class com.zion.jbuddy.bots.BotRemovePermitCall
Sets the user's name.
setNumberFormat(NumberFormat) - Method in class com.zion.jbuddy.bots.BotParameter
Sets the number format to use.
setPassKey(String) - Method in class com.zion.jbuddy.bots.BotEngine
Sets this engine's pass key.
setPassword(String) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's password.
setPasswordEncrypted(boolean) - Method in class com.zion.jbuddy.bots.BotClient
Sets whether the password is encrypted.
setPath(String) - Method in class com.zion.jbuddy.bots.BotAction
Sets this action's path.
setPath(String) - Method in class com.zion.jbuddy.bots.BotFile
Sets this file's path.
setPermitMode(String) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's permit mode.
setPermitMode(BotSetPermitModeEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Sets the client's Permit Mode.
setPermitMode(String) - Method in class com.zion.jbuddy.bots.BotSetPermitModeCall
Sets the permit mode.
setPermitMode(BotSetPermitModeEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
setPermitMode(BotSetPermitModeEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a client's permit mode needs to be set.
setPort(int) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's port.
setRecipients(String) - Method in class com.zion.jbuddy.bots.BotFile
Sets this file's recipients.
setRecipients(String) - Method in class com.zion.jbuddy.bots.BotMessage
Sets the message's recipients.
setRecipients(String) - Method in class com.zion.jbuddy.bots.BotRoute
Sets the list of user names to send responses to.
setReconnectDelay(long) - Method in class com.zion.jbuddy.bots.BotGateway
Sets the amount of time the engine must wait before reconnecting this gateway (after disconnecting or a connection attempt fails).
setResourceBundle(ResourceBundle) - Method in class com.zion.jbuddy.bots.BotEngine
Sets this engine's resource bundle.
setResultType(BotActionResultType) - Method in class com.zion.jbuddy.bots.BotAction
Sets this action's result type.
setSender(String) - Method in class com.zion.jbuddy.bots.BotRoute
Sets the id of the client to send responses from.
setShowBack(boolean) - Method in class com.zion.jbuddy.bots.BotMenu
Sets whether the back command is shown as a selection in this menu when a previously viewed menu exists in the user's menu history.
setShowCommands(boolean) - Method in class com.zion.jbuddy.bots.BotMenu
Sets whether this menu's available commands are presented to the user.
setShowTitle(boolean) - Method in class com.zion.jbuddy.bots.BotMenu
Sets whether this menu's title is shown when a user views this menu.
setStatus(String, String) - Method in class com.zion.jbuddy.bots.BotClient
Sets this client's status.
setStatus(BotSetStatusEvent) - Method in class com.zion.jbuddy.bots.BotGateway
Sets the client's status.
setStatus(String) - Method in class com.zion.jbuddy.bots.BotSetStatusCall
Sets the status type.
setStatus(String, String) - Method in class com.zion.jbuddy.bots.BotUser
Sets this user's status.
setStatus(BotSetStatusEvent) - Method in class com.zion.jbuddy.bots.event.BotEngineAdapter
 
setStatus(BotSetStatusEvent) - Method in interface com.zion.jbuddy.bots.event.BotEngineListener
Invoked when a client's status needs to be set.
setThreadPoolSize(int) - Method in class com.zion.jbuddy.bots.BotEngine
Sets the size of the internal thread pool this bot engine uses to process requests.
setTimeout(long) - Method in class com.zion.jbuddy.bots.BotAction
Sets this action's timeout value, in milliseconds.
setTimeStyle(BotDateTimeStyle) - Method in class com.zion.jbuddy.bots.BotParameter
Sets the time style to use.
setTitle(RichContent) - Method in class com.zion.jbuddy.bots.BotTarget
Sets this target's title.
setTransformPath(String) - Method in class com.zion.jbuddy.bots.BotAction
Sets this action's XSLT path.
setType(BotActionType) - Method in class com.zion.jbuddy.bots.BotAction
Sets this action's type.
setType(BotEventType) - Method in class com.zion.jbuddy.bots.BotEventHandler
Sets the type of event that triggers this event handler.
setType(String) - Method in class com.zion.jbuddy.bots.BotMessage
Sets this message's type.
setType(BotParameterType) - Method in class com.zion.jbuddy.bots.BotParameter
Sets this parameter's type.
setUserTimeout(long) - Method in class com.zion.jbuddy.bots.BotEngine
Sets the amount of time, in milliseconds, before idle user sessions are timed-out.
setValue(String) - Method in class com.zion.jbuddy.bots.BotParameter
Sets this parameter's value.
SHORT - Static variable in class com.zion.jbuddy.bots.BotDateTimeStyle
A short style pattern.
start() - Method in class com.zion.jbuddy.bots.BotEngine
Starts this engine.
stop() - Method in class com.zion.jbuddy.bots.BotEngine
Stops this engine.
STRING - Static variable in class com.zion.jbuddy.bots.BotActionResultType
Results are processed as a literal string (plain content) and sent to the user as BotContent.
STRING - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts literal strings.
SYSTEM - Static variable in class com.zion.jbuddy.bots.BotActionType
A system command, or executable file, is executed.

T

TIME - Static variable in class com.zion.jbuddy.bots.BotParameterType
Accepts time values.
toString() - Method in class com.zion.jbuddy.bots.BotActionResultType
 
toString() - Method in class com.zion.jbuddy.bots.BotActionType
 
toString() - Method in class com.zion.jbuddy.bots.BotAddBuddyCall
 
toString() - Method in class com.zion.jbuddy.bots.BotAddDenyCall
 
toString() - Method in class com.zion.jbuddy.bots.BotAddPermitCall
 
toString() - Method in class com.zion.jbuddy.bots.BotClient
 
toString() - Method in class com.zion.jbuddy.bots.BotContent
 
toString() - Method in class com.zion.jbuddy.bots.BotDateTimeStyle
 
toString() - Method in class com.zion.jbuddy.bots.BotEventType
 
toString() - Method in class com.zion.jbuddy.bots.BotFile
 
toString() - Method in class com.zion.jbuddy.bots.BotHTMLTidyMode
 
toString() - Method in class com.zion.jbuddy.bots.BotHTTPCompressionType
 
toString() - Method in class com.zion.jbuddy.bots.BotHTTPMethod
 
toString() - Method in class com.zion.jbuddy.bots.BotLogLevel
 
toString() - Method in class com.zion.jbuddy.bots.BotMessage
 
toString() - Method in class com.zion.jbuddy.bots.BotParameter
 
toString() - Method in class com.zion.jbuddy.bots.BotParameterType
 
toString() - Method in class com.zion.jbuddy.bots.BotRemoveBuddyCall
 
toString() - Method in class com.zion.jbuddy.bots.BotRemoveDenyCall
 
toString() - Method in class com.zion.jbuddy.bots.BotRemovePermitCall
 
toString() - Method in class com.zion.jbuddy.bots.BotSetPermitModeCall
 
toString() - Method in class com.zion.jbuddy.bots.BotSetStatusCall
 
toString() - Method in class com.zion.jbuddy.bots.BotUser
 
toString() - Method in class com.zion.jbuddy.bots.event.BotAddBuddyEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotAddDenyEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotAddPermitEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotClientConnectionEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotRemoveBuddyEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotRemoveDenyEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotRemovePermitEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotSendFileEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotSendMessageEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotSetPermitModeEvent
 
toString() - Method in class com.zion.jbuddy.bots.event.BotSetStatusEvent
 
TRACE - Static variable in class com.zion.jbuddy.bots.BotHTTPMethod
The TRACE method is used to invoke a remote, application-layer loop-back of the request message.
TRACE - Static variable in class com.zion.jbuddy.bots.BotLogLevel
Trace messages (or higher) will be reported.

U

URL - Static variable in class com.zion.jbuddy.bots.BotActionType
Loads and processes results from an URL.
user - Variable in class com.zion.jbuddy.bots.BotActionTask
The user associated with the action.

V

values - Static variable in class com.zion.jbuddy.bots.BotEventType
 

W

WARNING - Static variable in class com.zion.jbuddy.bots.BotLogLevel
Warning messages (or higher) will be reported.

X

XHTML - Static variable in class com.zion.jbuddy.bots.BotActionResultType
Results are processed as XHTML (rich content) and sent to the user as BotContent.
XML - Static variable in class com.zion.jbuddy.bots.BotActionResultType
Results are processed as Bot Definition XML.

Y

YES - Static variable in class com.zion.jbuddy.bots.BotHTMLTidyMode
Forces contents to be processed with HTML Tidy.

A B C D E F G H I J K L M N O P R S T U V W X Y

JBuddy is a trademark of Zion Software, LLC in the US and other countries.
Copyright 2000-2008 Zion Software, LLC All Rights Reserved.