Class FBManager
- java.lang.Object
- 
- org.firebirdsql.management.FBManager
 
- 
- All Implemented Interfaces:
- java.lang.AutoCloseable,- FBManagerMBean
 
 public class FBManager extends java.lang.Object implements FBManagerMBean A tool for creating and dropping databases.In particular, they can be created and dropped using the jboss service lifecycle operations start and stop. See FBManagerMBeanfor documentation.- Version:
- 1.0
- Author:
- David Jencks
 
- 
- 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Alias forFBManagerMBean.stop()voidcreateDatabase(java.lang.String fileName, java.lang.String user, java.lang.String password)Create a database with the specified file name, user name and password on the specifiedserverandport.voiddropDatabase(java.lang.String fileName, java.lang.String user, java.lang.String password)Drop a database with the specified file name, user name and password on the specifiedserverandport.java.lang.StringgetDefaultCharacterSet()intgetDialect()java.lang.StringgetFileName()java.lang.StringgetName()intgetPageSize()java.lang.StringgetPassword()intgetPort()java.lang.StringgetServer()java.lang.StringgetState()java.lang.StringgetType()java.lang.StringgetUserName()booleanisCreateOnStart()Get if the database will be created when callingFBManagerMBean.start().booleanisDatabaseExists(java.lang.String fileName, java.lang.String user, java.lang.String password)Check if a database exists with the specified file name, user name and password on the specifiedserverandport.booleanisDropOnStop()Get if the database will be created when callingFBManagerMBean.stop().booleanisForceCreate()Get if the database will be be dropped if exists when creating a database.voidsetCreateOnStart(boolean createOnStart)Set if the database will be created when callingFBManagerMBean.start().voidsetDefaultCharacterSet(java.lang.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().voidsetFileName(java.lang.String fileName)Set the file name or alias of the database.voidsetForceCreate(boolean forceCreate)Set if the database will be be dropped if exists when creating a database.voidsetPageSize(int pageSize)Set the page size to use when creating a new database.voidsetPassword(java.lang.String password)Set the password.voidsetPort(int port)Set the port of the Firebird server.voidsetServer(java.lang.String host)Set the host name of the Firebird server.voidsetType(java.lang.String type)Set the GDS plugin type to use.voidsetUserName(java.lang.String userName)Set the user name.voidstart()Start this manager.voidstop()Stop this manager.
 
- 
- 
- 
Constructor Detail- 
FBManagerpublic FBManager() 
 - 
FBManagerpublic FBManager(GDSType type) 
 - 
FBManagerpublic FBManager(java.lang.String type) 
 
- 
 - 
Method Detail- 
startpublic void start() throws java.lang.ExceptionDescription 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 interface- FBManagerMBean
- Throws:
- java.lang.IllegalStateException- If this manager is not started
- java.lang.Exception- For failures to start or create the database
 
 - 
stoppublic void stop() throws java.lang.ExceptionDescription 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 interface- FBManagerMBean
- Throws:
- java.lang.Exception- For failures to drop the database.
 
 - 
closepublic void close() throws java.lang.ExceptionDescription copied from interface:FBManagerMBeanAlias forFBManagerMBean.stop()- Specified by:
- closein interface- java.lang.AutoCloseable
- Specified by:
- closein interface- FBManagerMBean
- Throws:
- java.lang.Exception
 
 - 
getStatepublic java.lang.String getState() - Specified by:
- getStatein interface- FBManagerMBean
- Returns:
- Current state ("Stopped"or"Started"
 
 - 
getNamepublic java.lang.String getName() - Specified by:
- getNamein interface- FBManagerMBean
- Returns:
- Descriptive name of this manager
 
 - 
setServerpublic void setServer(java.lang.String host) Description copied from interface:FBManagerMBeanSet the host name of the Firebird server.- Specified by:
- setServerin interface- FBManagerMBean
- Parameters:
- host- Hostname
 
 - 
getServerpublic java.lang.String getServer() - Specified by:
- getServerin interface- FBManagerMBean
- Returns:
- The host name of the Firebird server (default is "localhost")
 
 - 
setPortpublic void setPort(int port) Description copied from interface:FBManagerMBeanSet the port of the Firebird server.- Specified by:
- setPortin interface- FBManagerMBean
- Parameters:
- port- Port of the Firebird server
 
 - 
getPortpublic int getPort() - Specified by:
- getPortin interface- FBManagerMBean
- Returns:
- The port of the Firebird server (default is 3050)
 
 - 
getFileNamepublic java.lang.String getFileName() - Specified by:
- getFileNamein interface- FBManagerMBean
- Returns:
- File name or alias of the database
 
 - 
setFileNamepublic void setFileName(java.lang.String fileName) Description copied from interface:FBManagerMBeanSet the file name or alias of the database.- Specified by:
- setFileNamein interface- FBManagerMBean
- Parameters:
- fileName- File name or alias of the database
 
 - 
getTypepublic java.lang.String getType() - Specified by:
- getTypein interface- FBManagerMBean
- Returns:
- GDS plugin type name (default is GDSFactory.getDefaultGDSType())
 
 - 
setTypepublic void setType(java.lang.String type) Description copied from interface:FBManagerMBeanSet the GDS plugin type to use.- Specified by:
- setTypein interface- FBManagerMBean
- Parameters:
- type- GDS plugin type name (- PURE_JAVA,- NATIVE,- EMBEDDED,- LOCAL)
 
 - 
getUserNamepublic java.lang.String getUserName() - Specified by:
- getUserNamein interface- FBManagerMBean
- Returns:
- User name
 
 - 
setUserNamepublic void setUserName(java.lang.String userName) Description copied from interface:FBManagerMBeanSet the user name.- Specified by:
- setUserNamein interface- FBManagerMBean
- Parameters:
- userName- User name
 
 - 
getPasswordpublic java.lang.String getPassword() - Specified by:
- getPasswordin interface- FBManagerMBean
- Returns:
- password
 
 - 
setPasswordpublic void setPassword(java.lang.String password) Description copied from interface:FBManagerMBeanSet the password.- Specified by:
- setPasswordin interface- FBManagerMBean
- Parameters:
- password- Password
 
 - 
setDialectpublic void setDialect(int dialect) Description copied from interface:FBManagerMBeanSet the database dialect to use when creating a new database.- Specified by:
- setDialectin interface- FBManagerMBean
- Parameters:
- dialect- Database dialect (1 or 3)
- See Also:
- FBManagerMBean.getDialect()
 
 - 
getDialectpublic int getDialect() - Specified by:
- getDialectin interface- FBManagerMBean
- Returns:
- Database dialect (either 1 or 3), default is 3.
 
 - 
setPageSizepublic 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 interface- FBManagerMBean
- Parameters:
- pageSize- The page size to be used in the created database, see- PageSizeConstants
- See Also:
- PageSizeConstants
 
 - 
getPageSizepublic int getPageSize() - Specified by:
- getPageSizein interface- FBManagerMBean
- Returns:
- The page size to be used when creating a database, or -1if the database default is used.
 
 - 
setDefaultCharacterSetpublic void setDefaultCharacterSet(java.lang.String firebirdCharsetName) Description copied from interface:FBManagerMBeanSet the default database character set to use when creating a new database.- Specified by:
- setDefaultCharacterSetin interface- FBManagerMBean
- 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.
 
 - 
getDefaultCharacterSetpublic java.lang.String getDefaultCharacterSet() - Specified by:
- getDefaultCharacterSetin interface- FBManagerMBean
- Returns:
- The default character set name, nullmeans not set.
- See Also:
- FBManagerMBean.setDefaultCharacterSet(String)
 
 - 
isCreateOnStartpublic boolean isCreateOnStart() Description copied from interface:FBManagerMBeanGet if the database will be created when callingFBManagerMBean.start().- Specified by:
- isCreateOnStartin interface- FBManagerMBean
- Returns:
- truewhen the database will be created on start,- falseotherwise.
 
 - 
setCreateOnStartpublic void setCreateOnStart(boolean createOnStart) Description copied from interface:FBManagerMBeanSet if the database will be created when callingFBManagerMBean.start().- Specified by:
- setCreateOnStartin interface- FBManagerMBean
- Parameters:
- createOnStart-- trueto create the database on start,- falseto not create on start (default)
 
 - 
isDropOnStoppublic boolean isDropOnStop() Description copied from interface:FBManagerMBeanGet if the database will be created when callingFBManagerMBean.stop().- Specified by:
- isDropOnStopin interface- FBManagerMBean
- Returns:
- trueto drop the database on stop,- falseotherwise
 
 - 
setDropOnStoppublic void setDropOnStop(boolean dropOnStop) Description copied from interface:FBManagerMBeanSet if the database will be created when callingFBManagerMBean.stop().- Specified by:
- setDropOnStopin interface- FBManagerMBean
- Parameters:
- dropOnStop-- trueto drop the database on stop,- falseto not drop on stop (default)
 
 - 
isForceCreatepublic boolean isForceCreate() Description copied from interface:FBManagerMBeanGet if the database will be be dropped if exists when creating a database.- Specified by:
- isForceCreatein interface- FBManagerMBean
- Returns:
- trueto drop existing database on create,- falseto not create a database if it exists.
 
 - 
setForceCreatepublic void setForceCreate(boolean forceCreate) Description copied from interface:FBManagerMBeanSet if the database will be be dropped if exists when creating a database.- Specified by:
- setForceCreatein interface- FBManagerMBean
- Parameters:
- forceCreate-- trueto drop existing database on create,- falseto not create a database if it exists.
 
 - 
createDatabasepublic void createDatabase(java.lang.String fileName, java.lang.String user, java.lang.String password) throws java.lang.ExceptionDescription copied from interface:FBManagerMBeanCreate a database with the specified file name, user name 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 interface- FBManagerMBean
- Parameters:
- fileName- Database file name or alias
- user- User name
- password- Password
- Throws:
- java.lang.IllegalStateException- If this manager is not started
- java.lang.Exception- If database creation fails.
 
 - 
dropDatabasepublic void dropDatabase(java.lang.String fileName, java.lang.String user, java.lang.String password) throws java.lang.ExceptionDescription copied from interface:FBManagerMBeanDrop a database with the specified file name, user name and password on the specifiedserverandport.- Specified by:
- dropDatabasein interface- FBManagerMBean
- Parameters:
- fileName- Database file name or alias
- user- User name
- password- Password
- Throws:
- java.lang.Exception- If this manager is not started or database drop fails.
 
 - 
isDatabaseExistspublic boolean isDatabaseExists(java.lang.String fileName, java.lang.String user, java.lang.String password) throws java.lang.ExceptionDescription copied from interface:FBManagerMBeanCheck if a database exists with the specified file name, user name 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 interface- FBManagerMBean
- Parameters:
- fileName- Database file name or alias
- user- User name
- password- Password
- Returns:
- trueif the database exists and can be connected,- falseif the database does not exist or any other error occurred.
- Throws:
- java.lang.Exception- Currently no other exception is thrown, this may change in the future
 
 
- 
 
-