Package ghidra.features.bsim.query

Class BSimServerInfo

java.lang.Object

ghidra.features.bsim.query.BSimServerInfo

All Implemented Interfaces:

Comparable<BSimServerInfo>

public class BSimServerInfo
extends Object
implements Comparable<BSimServerInfo>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BSimServerInfo.DBType	Enumerated Database Types

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_ELASTIC_PORT	Default port used for BSimServerInfo.DBType.elastic server
static final int	DEFAULT_POSTGRES_PORT	Default port used for BSimServerInfo.DBType.postgres server
static final String	H2_FILE_EXTENSION	File extension imposed for BSimServerInfo.DBType.file server.

Constructor Summary

Constructors

Constructor	Description
BSimServerInfo(BSimServerInfo.DBType dbType, String host, int port, String dbName)	Construct a new BSimServerInfo object.
BSimServerInfo(BSimServerInfo.DBType dbType, String userinfo, String host, int port, String dbName)	Construct a new BSimServerInfo object
BSimServerInfo(String dbName)	Construct a new BSimServerInfo object for a BSimServerInfo.DBType.file type database.
BSimServerInfo(URL url)	Construct a new BSimServerInfo object from a suitable database URL (i.e., postgresql:, https:, elastic:, file:).

Method Summary

Modifier and Type	Method	Description
int	compareTo(BSimServerInfo o)
boolean	equals(Object obj)
String	getDBName()	Get the DB Name
BSimServerInfo.DBType	getDBType()
FunctionDatabase	getFunctionDatabase(boolean async)	Get a BSim FunctionDatabase instance which corresponds to this DB server info.
int	getPort()	Get the port number.
String	getServerName()	Get the server hostname or IP address as originally specified.
String	getShortDBName()	Get the DB Name.
String	getUserInfo()	Get the remote database user information to be used when establishing a connection.
String	getUserName()	Get the remote database user name to be used when establishing a connection.
boolean	hasDefaultLogin()	Determine if user info was stipulated during construction
int	hashCode()
boolean	hasPassword()	Determine if user information includes password.
boolean	isWindowsFilePath()	Determine if this server info corresponds to Windows OS file path.
void	setUserInfo(org.apache.commons.dbcp2.BasicDataSource bds)
String	toString()
URL	toURL()	Return BSim server info in URL.
String	toURLString()	Return BSim server info in URL format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_POSTGRES_PORT

public static final int DEFAULT_POSTGRES_PORT

Default port used for BSimServerInfo.DBType.postgres server

See Also:

• Constant Field Values

DEFAULT_ELASTIC_PORT

public static final int DEFAULT_ELASTIC_PORT

Default port used for BSimServerInfo.DBType.elastic server

See Also:

• Constant Field Values

H2_FILE_EXTENSION

public static final String H2_FILE_EXTENSION

File extension imposed for BSimServerInfo.DBType.file server. This is a rigid H2 database convention.

See Also:

• Constant Field Values

Constructor Details

BSimServerInfo

public BSimServerInfo(BSimServerInfo.DBType dbType,
 String userinfo,
 String host,
 int port,
 String dbName)

Construct a new BSimServerInfo object

Parameters:

dbType - BSim DB type

userinfo - connection user info, username[:password] (ignored for BSimServerInfo.DBType.file). If blank, ClientUtil.getUserName() is used.

host - host name (ignored for BSimServerInfo.DBType.file)

port - port number (ignored for BSimServerInfo.DBType.file)

dbName - name of database (simple database name except for BSimServerInfo.DBType.file which should reflect an absolute file path. On Windows OS the path may start with a drive letter.

Throws:

IllegalArgumentException - if invalid arguments are specified

BSimServerInfo

public BSimServerInfo(BSimServerInfo.DBType dbType,
 String host,
 int port,
 String dbName)

Construct a new BSimServerInfo object. For non-file database the user's defaut username is used (see ClientUtil.getUserName()).

Parameters:

dbType - BSim DB type

host - host name (ignored for BSimServerInfo.DBType.file)

port - port number (ignored for BSimServerInfo.DBType.file)

dbName - name of database (simple database name except for BSimServerInfo.DBType.file which should reflect an absolute file path. On Windows OS the path may start with a drive letter.

Throws:

IllegalArgumentException - if invalid arguments are specified

BSimServerInfo

public BSimServerInfo(String dbName)

Construct a new BSimServerInfo object for a BSimServerInfo.DBType.file type database.

Parameters:

dbName - name of database which should reflect an absolute file path. On Windows OS the path may start with a drive letter.

Throws:

IllegalArgumentException - if invalid arguments are specified

BSimServerInfo

public BSimServerInfo(URL url)
               throws IllegalArgumentException

Construct a new BSimServerInfo object from a suitable database URL (i.e., postgresql:, https:, elastic:, file:).

Parameters:

url - supported BSim database URL. For non-file URLs, the hostname or address may be preceeded by a DB username (e.g., postgresql://user@host:port/dbname

Throws:

IllegalArgumentException - if unsupported URL protocol specified

Method Details

isWindowsFilePath

public boolean isWindowsFilePath()

Determine if this server info corresponds to Windows OS file path.

Returns:

true if this server info corresponds to Windows OS file path.

toURLString

public String toURLString()

Return BSim server info in URL format. Warning: If userinfo with password has been specified it will be returned in the URL.

Returns:

BSim server info in URL format

toURL

public URL toURL()
          throws MalformedURLException

Return BSim server info in URL. Warning: If userinfo with password has been specified it will be returned in the URL.

Returns:

BSim server info in URL

Throws:

MalformedURLException - if unable to form supported URL

getDBType

public BSimServerInfo.DBType getDBType()

Returns:

BSim database type

setUserInfo

public void setUserInfo(org.apache.commons.dbcp2.BasicDataSource bds)

hasPassword

public boolean hasPassword()

Determine if user information includes password. NOTE: Use of passwords with this object and URLs is discouraged.

Returns:

true if user information includes password which

hasDefaultLogin

public boolean hasDefaultLogin()

Determine if user info was stipulated during construction

Returns:

true if user info was stipulated during construction

getUserName

public String getUserName()

Get the remote database user name to be used when establishing a connection. User name obtained from the user information which was provided during instantiation.

Returns:

remote database user information (null for BSimServerInfo.DBType.file).

getUserInfo

public String getUserInfo()

Get the remote database user information to be used when establishing a connection.

Returns:

remote database user information (null for BSimServerInfo.DBType.file).

getServerName

public String getServerName()

Get the server hostname or IP address as originally specified.

Returns:

hostname or IP address as originally specified

getPort

public int getPort()

Get the port number.

Returns:

port number

getDBName

public String getDBName()

Get the DB Name

Returns:

DB name

getShortDBName

public String getShortDBName()

Get the DB Name. In the case of BSimServerInfo.DBType.file the directory path will be excluded from returned name.

Returns:

shortened DB Name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getFunctionDatabase

public FunctionDatabase getFunctionDatabase(boolean async)

Get a BSim FunctionDatabase instance which corresponds to this DB server info. The Closeable instance should be closed when no longer in-use to ensure that any associated database connection and resources are properly closed.

Parameters:

async - true if database commits should be asynchronous (may not be applicable)

Returns:

BSim function database instance

compareTo

public int compareTo(BSimServerInfo o)

Specified by:

compareTo in interface Comparable<BSimServerInfo>