Autopsy  4.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.events.MessageServiceConnectionInfo Class Reference

Public Member Functions

 MessageServiceConnectionInfo (String host, int port, String userName, String password)
 
String getHost ()
 
String getPassword ()
 
int getPort ()
 
String getUserName ()
 
void tryConnect () throws MessageServiceException
 

Private Attributes

final String host
 
final String password
 
final int port
 
final String userName
 

Static Private Attributes

static final String CONNECTION_REFUSED = "connection refused"
 
static final String CONNECTION_TIMED_OUT = "connection timed out"
 
static final int IS_REACHABLE_TIMEOUT_MS = 1000
 
static final String MESSAGE_SERVICE_URI = "tcp://%s:%s?wireFormat.maxInactivityDuration=0"
 
static final String PASSWORD_OR_USERNAME_BAD = "user name ["
 

Detailed Description

Connection info for a Java Message Service (JMS) provider. Thread-safe.

Definition at line 36 of file MessageServiceConnectionInfo.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.MessageServiceConnectionInfo ( String  host,
int  port,
String  userName,
String  password 
)

Constructs an object containing connection info for a Java Message Service (JMS) provider.

Parameters
hostThe host to use for a message service connection. May be a host name or an IP address.
portThe port number to use for a message service connection.
userNameThe user name to use for a message service connection. May be the empty string.
passwordThe password to use for a message service connection. May be the empty string.

Definition at line 61 of file MessageServiceConnectionInfo.java.

References org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.host, org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.password, org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.port, and org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.userName.

Member Function Documentation

String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.getHost ( )

Gets the host to use for a message service connection. May be a host name or an IP address.

Returns
The host as a string.

Definition at line 92 of file MessageServiceConnectionInfo.java.

References org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.host.

Referenced by org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.tryConnect().

String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.getPassword ( )

Gets the password to use for a message service connection.

Returns
The password as a string. May be empty.

Definition at line 82 of file MessageServiceConnectionInfo.java.

References org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.password.

Referenced by org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.tryConnect().

int org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.getPort ( )

Gets the port number to use for a message service connection.

Returns
The port as an int.

Definition at line 101 of file MessageServiceConnectionInfo.java.

References org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.port.

String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.getUserName ( )

Gets the user name to use for a message service connection.

Returns
The user name as a string. May be empty.

Definition at line 73 of file MessageServiceConnectionInfo.java.

References org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.userName.

Referenced by org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.tryConnect().

void org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.tryConnect ( ) throws MessageServiceException

Verifies connection to messaging service. Throws if we cannot communicate with messaging service.

When issues occur, it attempts to diagnose them by looking at the exception messages, returning the appropriate user-facing text for the exception received. This method expects the Exceptions messages to be in English and compares against English text.

Exceptions
org.sleuthkit.autopsy.events.MessageServiceException

Definition at line 128 of file MessageServiceConnectionInfo.java.

References org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.getHost(), org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.getPassword(), and org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.getUserName().

Referenced by org.sleuthkit.autopsy.corecomponents.MultiUserSettingsPanel.bnTestMessageServiceActionPerformed(), and org.sleuthkit.autopsy.core.ServicesMonitor.checkMessagingServerConnectionStatus().

Member Data Documentation

final String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.CONNECTION_REFUSED = "connection refused"
staticprivate

Definition at line 40 of file MessageServiceConnectionInfo.java.

final String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.CONNECTION_TIMED_OUT = "connection timed out"
staticprivate

Definition at line 39 of file MessageServiceConnectionInfo.java.

final String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.host
private
final int org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.IS_REACHABLE_TIMEOUT_MS = 1000
staticprivate

Definition at line 42 of file MessageServiceConnectionInfo.java.

final String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.MESSAGE_SERVICE_URI = "tcp://%s:%s?wireFormat.maxInactivityDuration=0"
staticprivate

Definition at line 38 of file MessageServiceConnectionInfo.java.

final String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.password
private
final String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.PASSWORD_OR_USERNAME_BAD = "user name ["
staticprivate

Definition at line 41 of file MessageServiceConnectionInfo.java.

final int org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.port
private
final String org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.userName
private

The documentation for this class was generated from the following file:

Copyright © 2012-2016 Basis Technology. Generated on: Mon Jan 2 2017
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.