A C F G H L M O R S T U V _

A

authenticateWithCore() - Method in interface osnap.api.model.ModuleInterface

Called when the module needs to authenticate with core.

C

connected - Variable in class osnap.api.net.HeartBeat

CoreMessage - Class in osnap.api.model

A message passed between a module and core only

CoreMessage(CoreMessageCode, String, String) - Constructor for class osnap.api.model.CoreMessage

Creates a CoreMessage.

CoreMessageCode - Enum in osnap.api.model

The different types of CoreMessageCode that can be used by a CoreMessage

CoreMessageCode() - Constructor for enum osnap.api.model.CoreMessageCode

CoreReconnecter - Class in osnap.api.net

A class designed to try reconnecting to Core in case of a lost connection.

CoreReconnecter(Socket, ModuleInterface) - Constructor for class osnap.api.net.CoreReconnecter

Constructor for creating this object.

CoreReconnecter(String, int, ModuleInterface) - Constructor for class osnap.api.net.CoreReconnecter

Constructor for creating this object.

F

findHashTags(String) - Static method in class osnap.api.functionality.MessageFunctionality

Finds any hashtags in a string

findQuestions(String) - Static method in class osnap.api.functionality.MessageFunctionality

Can find questions in Norwegian and English

G

getCode() - Method in class osnap.api.model.CoreMessage

Gets the keyword contained in this message.

getDescription() - Method in class osnap.api.model.CoreMessage

Gets the description of the message

getDescription() - Method in interface osnap.api.model.MessageInterface

Returns the information contained in the message

getDescription() - Method in class osnap.api.model.SocialNetworkMessage

Gets the description of the message

getHashTags() - Method in class osnap.api.model.SocialNetworkMessage

Gets the hashtags attached to the message

getID() - Method in class osnap.api.model.SocialNetworkMessage

Returns the id of the message from the social network

getName() - Method in interface osnap.api.model.ModuleInterface

Called when the module api sends a heartbeat ping to the core.

getNotes() - Method in class osnap.api.model.SocialNetworkMessage

Get any notes contained in this message

getOSNAPUsername() - Method in class osnap.api.model.CoreMessage

Gets the OSNAP Username contained in the message

getOSNAPUsername() - Method in interface osnap.api.model.MessageInterface

Returns the OSNAP username

getOSNAPUsername() - Method in class osnap.api.model.SocialNetworkMessage

Gets the OSNAP Username this message came from

getPosted() - Method in class osnap.api.model.SocialNetworkMessage

Gets the date this message was posted

getRealname() - Method in class osnap.api.model.SocialNetworkMessage

Gets the Realname attached to the message

getURL() - Method in class osnap.api.model.SocialNetworkMessage

Returns the URL the message originated from

getUsername() - Method in class osnap.api.model.SocialNetworkMessage

Returns the username attached to the message

H

hasHashTags() - Method in class osnap.api.model.SocialNetworkMessage

Checks if the message has hashtags attached to it

hasID() - Method in class osnap.api.model.SocialNetworkMessage

Checks if the message has an id attached to it

hasRealname() - Method in class osnap.api.model.SocialNetworkMessage

Checks if the message has a realname attached to it

hasURL() - Method in class osnap.api.model.SocialNetworkMessage

Checks if the message has a URL attached to it

hasUsername() - Method in class osnap.api.model.SocialNetworkMessage

Checks if the message has a username attached to it

HeartBeat - Class in osnap.api.net

A class designed to check if the connection to Core is still valid.

HeartBeat(Socket, ModuleInterface) - Constructor for class osnap.api.net.HeartBeat

Constructor for creating this object.

L

logEntry(String, String) - Static method in class osnap.api.functionality.LogWriter

Appends a message to a log file.

LogWriter - Class in osnap.api.functionality

Software using the ModuleAPI can use this class as an easy way to create and append to logfiles.

LogWriter() - Constructor for class osnap.api.functionality.LogWriter

M

messageFromCore(MessageInterface) - Method in interface osnap.api.model.ModuleInterface

Called when the module receives a message from Core

MessageFunctionality - Class in osnap.api.functionality

This class provides extra functionality

MessageFunctionality() - Constructor for class osnap.api.functionality.MessageFunctionality

MessageInterface - Interface in osnap.api.model

Basic methods all message objects passed between core and modules should have

MessageReceiver - Class in osnap.api.net

The MessageReceiver is used by modules to receive messages from Core

MessageReceiver(Socket, ModuleInterface) - Constructor for class osnap.api.net.MessageReceiver

Creates a new MessageReceiver

MessageSender - Class in osnap.api.net

MessageSender can be used by both modules and Core to send messages in forms of MessageInterface

MessageSender() - Constructor for class osnap.api.net.MessageSender

ModuleInterface - Interface in osnap.api.model

Interface to be used by all Modules.

O

osnap.api.functionality - package osnap.api.functionality

osnap.api.model - package osnap.api.model

osnap.api.net - package osnap.api.net

R

run() - Method in class osnap.api.net.CoreReconnecter

Tries to reconnect in intervals of 30 seconds.

run() - Method in class osnap.api.net.HeartBeat

Sends a heartbeat, a ping, to the Core in intervals of 30 seconds.

run() - Method in class osnap.api.net.MessageReceiver

This thread will listen for new messages from Core.

S

SendMessage(Socket, MessageInterface) - Static method in class osnap.api.net.MessageSender

A static method for sending messages in MessageInterface format.

sendMessageToNetwork(SocialNetworkMessage) - Method in interface osnap.api.model.ModuleInterface

Send a message to the Social Network

serialVersionUID - Static variable in class osnap.api.model.CoreMessage

serialVersionUID - Static variable in class osnap.api.model.SocialNetworkMessage

setCode(CoreMessageCode) - Method in class osnap.api.model.CoreMessage

Sets the keyword for this message;

setCoreSocket(Socket) - Method in interface osnap.api.model.ModuleInterface

Set the socket used to connect and maintain a connection to Core

setDescription(String) - Method in class osnap.api.model.CoreMessage

Sets the description for the message

setDescription(String) - Method in interface osnap.api.model.MessageInterface

Sets the information contained in the message

setDescription(String) - Method in class osnap.api.model.SocialNetworkMessage

Sets the description of the message

setHashTags(ArrayList<String>) - Method in class osnap.api.model.SocialNetworkMessage

Sets the hashtags attached to the message

setID(String) - Method in class osnap.api.model.SocialNetworkMessage

Sets the ID of the message

setMessageReceiver(MessageReceiver) - Method in interface osnap.api.model.ModuleInterface

Sets a new MessageReceiver

setNotes(String) - Method in class osnap.api.model.SocialNetworkMessage

Set notes in this message

setOSNAPUsername(String) - Method in class osnap.api.model.CoreMessage

Sets the type of network the message came from/is going to

setPosted(Date) - Method in class osnap.api.model.SocialNetworkMessage

Sets the date this message was posted

setRealname(String) - Method in class osnap.api.model.SocialNetworkMessage

Sets the Realname of the message

setSocialNetworkName(String) - Method in class osnap.api.model.SocialNetworkMessage

Sets the OSNAP Username this message came from

setURL(String) - Method in class osnap.api.model.SocialNetworkMessage

Sets the URL from where the message originated from

setUsername(String) - Method in class osnap.api.model.SocialNetworkMessage

Sets the username of the message

SocialNetworkMessage - Class in osnap.api.model

A universal message object to be used with all modules and Core

SocialNetworkMessage(String, Date, String) - Constructor for class osnap.api.model.SocialNetworkMessage

Creates a universal message object which is to be used for all message handling in modules and Core

SocialNetworkMessage(String, Date, String, String, String, String) - Constructor for class osnap.api.model.SocialNetworkMessage

Creates a universal message object which is to be used for all message handling in modules, core and messagehandler

SocialNetworkMessage() - Constructor for class osnap.api.model.SocialNetworkMessage

Creates a parameterless version of this object

stackTraceMessage(String, Exception) - Static method in class osnap.api.functionality.LogWriter

Appends a message to a stacktrace log file.

T

toString() - Method in class osnap.api.model.SocialNetworkMessage

Returns the message in a readable form Contains the date, description and network the message came from

U

updateStatus(String) - Method in interface osnap.api.model.ModuleInterface

Updates the status on the Social Network

V

valueOf(String) - Static method in enum osnap.api.model.CoreMessageCode

Returns the enum constant of this type with the specified name.

values() - Static method in enum osnap.api.model.CoreMessageCode

Returns an array containing the constants of this enum type, in the order they are declared.

_

_code - Variable in class osnap.api.model.CoreMessage

_coreSocket - Variable in class osnap.api.net.CoreReconnecter

_coreSocket - Variable in class osnap.api.net.HeartBeat

_coreSocket - Variable in class osnap.api.net.MessageReceiver

_description - Variable in class osnap.api.model.CoreMessage

_description - Variable in class osnap.api.model.SocialNetworkMessage

_hashtags - Variable in class osnap.api.model.SocialNetworkMessage

_hostname - Variable in class osnap.api.net.CoreReconnecter

_id - Variable in class osnap.api.model.SocialNetworkMessage

_module - Variable in class osnap.api.net.CoreReconnecter

_module - Variable in class osnap.api.net.HeartBeat

_module - Variable in class osnap.api.net.MessageReceiver

_notes - Variable in class osnap.api.model.SocialNetworkMessage

_osnapUsername - Variable in class osnap.api.model.CoreMessage

_osnapUsername - Variable in class osnap.api.model.SocialNetworkMessage

_port - Variable in class osnap.api.net.CoreReconnecter

_realname - Variable in class osnap.api.model.SocialNetworkMessage

_reconnectSocket - Variable in class osnap.api.net.CoreReconnecter

_timestamp - Variable in class osnap.api.model.SocialNetworkMessage

_URL - Variable in class osnap.api.model.SocialNetworkMessage

_username - Variable in class osnap.api.model.SocialNetworkMessage

A C F G H L M O R S T U V _