- All Implemented Interfaces:
AutoCloseable,FBManagerMBean
In particular, they can be created and dropped using the jboss service lifecycle operations start and stop.
See FBManagerMBean for documentation.
- Author:
- David Jencks
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Alias forFBManagerMBean.stop()voidcreateDatabase(String fileName, String user, String password) Create a database with the specified file name, username and password on the specifiedserverandport.voidcreateDatabase(String fileName, String user, String password, String roleName) Create a database with the specified file name, username, password and role on the specifiedserverandport.voiddropDatabase(String fileName, String user, String password) Drop a database with the specified file name, username and password on the specifiedserverandport.voiddropDatabase(String fileName, String user, String password, String roleName) Drop a database with the specified file name, username, password and role on the specifiedserverandport.intgetName()intintgetPort()getState()getType()booleanGet if the database will be created when callingFBManagerMBean.start().booleanisDatabaseExists(String fileName, String user, String password) Check if a database exists with the specified file name, username and password on the specifiedserverandport.booleanGet if the database will be created when callingFBManagerMBean.stop().booleanGet if the database will be dropped if exists when creating a database.voidsetCreateOnStart(boolean createOnStart) Set if the database will be created when callingFBManagerMBean.start().voidsetDefaultCharacterSet(String firebirdCharsetName) Set the default database character set to use when creating a new database.voidsetDialect(int dialect) Set the database dialect to use when creating a new database.voidsetDropOnStop(boolean dropOnStop) Set if the database will be created when callingFBManagerMBean.stop().voidsetEnableProtocol(String enableProtocol) Sets the enable protocol value.voidsetFileName(String fileName) Set the file name or alias of the database.voidsetForceCreate(boolean forceCreate) Set if the database will be dropped if exists when creating a database.voidsetForceWrite(Boolean forceWrite) Control force write behaviour of the created database.voidsetPageSize(int pageSize) Set the page size to use when creating a new database.voidsetPassword(String password) Set the password.voidsetPort(int port) Set the port of the Firebird server.voidsetRoleName(String roleName) voidSet the host name of the Firebird server.voidSet the GDS plugin type to use.voidsetUserName(String userName) Set the username.voidstart()Start this manager.voidstop()Stop this manager.
-
Constructor Details
-
FBManager
public FBManager() -
FBManager
-
FBManager
-
-
Method Details
-
start
Description copied from interface:FBManagerMBeanStart this manager.If
FBManagerMBean.isCreateOnStart()istrue, will attempt to create a new database specified using theserver,port,fileNameand related properties. If the specified already exists, nothing will be created unlessFBManagerMBean.isForceCreate()istrue. WhenforceCreateistruean attempt will be made to drop the database.- Specified by:
startin interfaceFBManagerMBean- Throws:
IllegalStateException- If this manager is not startedException- For failures to start or create the database
-
stop
Description copied from interface:FBManagerMBeanStop this manager.If
FBManagerMBean.isDropOnStop()istrue, will attempt to drop the database specified using theserver,port,fileNameand related properties,If the manager is currently stopped, this method will do nothing.
- Specified by:
stopin interfaceFBManagerMBean- Throws:
Exception- For failures to drop the database.
-
close
Description copied from interface:FBManagerMBeanAlias forFBManagerMBean.stop()- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceFBManagerMBean- Throws:
Exception
-
getState
- Specified by:
getStatein interfaceFBManagerMBean- Returns:
- Current state (
"Stopped"or"Started"
-
getName
- Specified by:
getNamein interfaceFBManagerMBean- Returns:
- Descriptive name of this manager
-
setServer
Description copied from interface:FBManagerMBeanSet the host name of the Firebird server.- Specified by:
setServerin interfaceFBManagerMBean- Parameters:
host- Hostname
-
getServer
- Specified by:
getServerin interfaceFBManagerMBean- Returns:
- The host name of the Firebird server (default is
"localhost")
-
setPort
public void setPort(int port) Description copied from interface:FBManagerMBeanSet the port of the Firebird server.- Specified by:
setPortin interfaceFBManagerMBean- Parameters:
port- Port of the Firebird server
-
getPort
public int getPort()- Specified by:
getPortin interfaceFBManagerMBean- Returns:
- The port of the Firebird server (default is
3050)
-
getFileName
- Specified by:
getFileNamein interfaceFBManagerMBean- Returns:
- File name or alias of the database
-
setFileName
Description copied from interface:FBManagerMBeanSet the file name or alias of the database.- Specified by:
setFileNamein interfaceFBManagerMBean- Parameters:
fileName- File name or alias of the database
-
getType
- Specified by:
getTypein interfaceFBManagerMBean- Returns:
- GDS plugin type name (default is
GDSFactory.getDefaultGDSType())
-
setType
Description copied from interface:FBManagerMBeanSet the GDS plugin type to use.- Specified by:
setTypein interfaceFBManagerMBean- Parameters:
type- GDS plugin type name (PURE_JAVA,NATIVE,EMBEDDED)
-
getUserName
- Specified by:
getUserNamein interfaceFBManagerMBean- Returns:
- User name
-
setUserName
Description copied from interface:FBManagerMBeanSet the username.- Specified by:
setUserNamein interfaceFBManagerMBean- Parameters:
userName- Username
-
getPassword
- Specified by:
getPasswordin interfaceFBManagerMBean- Returns:
- password
-
setPassword
Description copied from interface:FBManagerMBeanSet the password.- Specified by:
setPasswordin interfaceFBManagerMBean- Parameters:
password- Password
-
getRoleName
- Specified by:
getRoleNamein interfaceFBManagerMBean- Returns:
- SQL role to use.
-
setRoleName
- Specified by:
setRoleNamein interfaceFBManagerMBean- Parameters:
roleName- SQL role to use.
-
setEnableProtocol
Description copied from interface:FBManagerMBeanSets the enable protocol value.- Specified by:
setEnableProtocolin interfaceFBManagerMBean- Parameters:
enableProtocol- enable protocol value
-
getEnableProtocol
- Specified by:
getEnableProtocolin interfaceFBManagerMBean- Returns:
- enable protocol value (see also
AttachmentProperties.getEnableProtocol().
-
setDialect
public void setDialect(int dialect) Description copied from interface:FBManagerMBeanSet the database dialect to use when creating a new database.- Specified by:
setDialectin interfaceFBManagerMBean- Parameters:
dialect- Database dialect (1 or 3)- See Also:
-
getDialect
public int getDialect()- Specified by:
getDialectin interfaceFBManagerMBean- Returns:
- Database dialect (either 1 or 3), default is 3.
-
setPageSize
public void setPageSize(int pageSize) Description copied from interface:FBManagerMBeanSet the page size to use when creating a new database.The value for
pageSizemust be one ofPageSizeConstants. The default value depends on the Firebird version.Some values are not valid on all Firebird versions.
- Specified by:
setPageSizein interfaceFBManagerMBean- Parameters:
pageSize- The page size to be used in the created database, seePageSizeConstants- See Also:
-
getPageSize
public int getPageSize()- Specified by:
getPageSizein interfaceFBManagerMBean- Returns:
- The page size to be used when creating a database, or
-1if the database default is used.
-
setDefaultCharacterSet
Description copied from interface:FBManagerMBeanSet the default database character set to use when creating a new database.- Specified by:
setDefaultCharacterSetin interfaceFBManagerMBean- Parameters:
firebirdCharsetName- Character set name, use Firebird names only;nullwill use Firebird default (NONE). Specifying an invalid name will result in an exception during database creation.
-
getDefaultCharacterSet
- Specified by:
getDefaultCharacterSetin interfaceFBManagerMBean- Returns:
- The default character set name,
nullmeans not set. - See Also:
-
setForceWrite
Description copied from interface:FBManagerMBeanControl force write behaviour of the created database.Only use this method if you know what you're doing, and if you can live with data loss and database corruption. In general it is advisable to use the Firebird default (
nullfor this method).- Specified by:
setForceWritein interfaceFBManagerMBean- Parameters:
forceWrite-null- default behaviour (force write enabled after database creation and initialization),true- enable force write at database creation,false- disable force write
-
getForceWrite
- Specified by:
getForceWritein interfaceFBManagerMBean- Returns:
- The forced writes configuration
- See Also:
-
isCreateOnStart
public boolean isCreateOnStart()Description copied from interface:FBManagerMBeanGet if the database will be created when callingFBManagerMBean.start().- Specified by:
isCreateOnStartin interfaceFBManagerMBean- Returns:
truewhen the database will be created on start,falseotherwise.
-
setCreateOnStart
public void setCreateOnStart(boolean createOnStart) Description copied from interface:FBManagerMBeanSet if the database will be created when callingFBManagerMBean.start().- Specified by:
setCreateOnStartin interfaceFBManagerMBean- Parameters:
createOnStart-trueto create the database on start,falseto not create on start (default)
-
isDropOnStop
public boolean isDropOnStop()Description copied from interface:FBManagerMBeanGet if the database will be created when callingFBManagerMBean.stop().- Specified by:
isDropOnStopin interfaceFBManagerMBean- Returns:
trueto drop the database on stop,falseotherwise
-
setDropOnStop
public void setDropOnStop(boolean dropOnStop) Description copied from interface:FBManagerMBeanSet if the database will be created when callingFBManagerMBean.stop().- Specified by:
setDropOnStopin interfaceFBManagerMBean- Parameters:
dropOnStop-trueto drop the database on stop,falseto not drop on stop (default)
-
isForceCreate
public boolean isForceCreate()Description copied from interface:FBManagerMBeanGet if the database will be dropped if exists when creating a database.- Specified by:
isForceCreatein interfaceFBManagerMBean- Returns:
trueto drop existing database on create,falseto not create a database if it exists.
-
setForceCreate
public void setForceCreate(boolean forceCreate) Description copied from interface:FBManagerMBeanSet if the database will be dropped if exists when creating a database.- Specified by:
setForceCreatein interfaceFBManagerMBean- Parameters:
forceCreate-trueto drop existing database on create,falseto not create a database if it exists.
-
createDatabase
Description copied from interface:FBManagerMBeanCreate a database with the specified file name, username and password on the specifiedserverandport.On creation, the following properties will used to configure the database:
dialect,pageSize,defaultCharacterSet.If the database already exists, and
forceCreateistrue, the database will be dropped. Iffalse, no database will be created.- Specified by:
createDatabasein interfaceFBManagerMBean- Parameters:
fileName- Database file name or aliasuser- User namepassword- Password- Throws:
IllegalStateException- If this manager is not startedException- If database creation fails.
-
createDatabase
public void createDatabase(String fileName, String user, String password, String roleName) throws Exception Description copied from interface:FBManagerMBeanCreate a database with the specified file name, username, password and role on the specifiedserverandport.On creation, the following properties will used to configure the database:
dialect,pageSize,defaultCharacterSet.If the database already exists, and
forceCreateistrue, the database will be dropped. Iffalse, no database will be created.- Specified by:
createDatabasein interfaceFBManagerMBean- Parameters:
fileName- Database file name or aliasuser- User namepassword- PasswordroleName- Role name (ornullfor no role)- Throws:
IllegalStateException- If this manager is not startedException- If database creation fails.
-
dropDatabase
Description copied from interface:FBManagerMBeanDrop a database with the specified file name, username and password on the specifiedserverandport.- Specified by:
dropDatabasein interfaceFBManagerMBean- Parameters:
fileName- Database file name or aliasuser- User namepassword- Password- Throws:
Exception- If this manager is not started or database drop fails.
-
dropDatabase
public void dropDatabase(String fileName, String user, String password, String roleName) throws Exception Description copied from interface:FBManagerMBeanDrop a database with the specified file name, username, password and role on the specifiedserverandport.- Specified by:
dropDatabasein interfaceFBManagerMBean- Parameters:
fileName- Database file name or aliasuser- User namepassword- PasswordroleName- Role name (ornullfor no role)- Throws:
Exception- If this manager is not started or database drop fails.
-
isDatabaseExists
Description copied from interface:FBManagerMBeanCheck if a database exists with the specified file name, username and password on the specifiedserverandport.Existence is checked by connecting to the database, so any connection error, including invalid credentials, will report the database as not existing.
- Specified by:
isDatabaseExistsin interfaceFBManagerMBean- Parameters:
fileName- Database file name or aliasuser- User namepassword- Password- Returns:
trueif the database exists and can be connected,falseif the database does not exist or any other error occurred.- Throws:
Exception- Currently no other exception is thrown, this may change in the future
-