BBjAdminBase

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, java.rmi.Remote, java.io.Serializable
```
public interface BBjAdminBase
extends BBjAdminCommitPropertyWriter, java.io.Serializable
```
This is the main interface and entrypoint for accessing BBj administration functionality. Server information and configuration settings are all expressed as properties for simplicity and to allow for easy extension. Constants are declared in the API so that properties can be easily addressed even though they are all Strings at the base level. Changes to property values or setting values for new properties must be committed. This allows the user to completely configure property settings and then commit or roll back all of the changes as a group.

Do not directly create a BBjAdminBase instance from one of its implementation classes. Instead, use the com.basis.api.admin.BBjAdminFactory class to acquire an instance/connection. The following sample code shows how to acquire a connection using Java and BBj code:

Java Sample
import com.basis.api.admin.BBjAdminFactory; import com.basis.api.admin.BBjAdminBase; import com.basis.api.admin.BBjAdminDatabase; import java.net.InetAddress; ... BBjAdminBase api = BBjAdminFactory.getBBjAdmin(InetAddress.getByName("myserver"), 2002, true, "admin", "mypassword"); BBjAdminSet databases = api.getDatabases(); ...
BBj Sample
use com.basis.api.admin.BBjAdminFactory use com.basis.api.admin.BBjAdminBase use com.basis.api.admin.BBjAdminDatabase use java.net.InetAddress ... declare BBjAdminBase api! declare BBjAdminSet databases! api! = BBjAdminFactory.getBBjAdmin(InetAddress.getByName("myserver"), 2002, true, "admin", "mypassword") databases! = api!.getDatabases() ...

Since:

10.00

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.logging.Logger`	`LOG`
`static int`	`PERMISSION_ADD_USER` Permission flag to allow user to add a new user account.
`static int`	`PERMISSION_ALLOW_ADMIN` Permission flag to allow user to use the Enterprise Manager.
`static int`	`PERMISSION_ALLOW_ALL` Permission flag to allow user to perform all administrative related tasks on a server.
`static int`	`PERMISSION_ASYNCH_TRIGGER` Permission flag to allow user to manage asynchronous triggers.
`static int`	`PERMISSION_ATTACH_EXISTING_DB` Permission flag to allow user to attach to an existing data dictionary.
`static int`	`PERMISSION_AUDITING` Permission flag to allow user to manage change audit jobs.
`static int`	`PERMISSION_CLOSE_FILES` Permission flag to allow user to force-close currently open file channels.
`static int`	`PERMISSION_CONNECTION_POOLS` Permission flag to allow user to view/manage the list of connection pools.
`static int`	`PERMISSION_COPY_JOBS` Permission flag to allow user to view/manage the list of currently configured online copy jobs.
`static int`	`PERMISSION_CREATE_NEW_DB` Permission flag to allow user to create a new database including new data dictionary.
`static int`	`PERMISSION_CREATE_NEW_TRIGGER` Permission flag to allow user to create a new file trigger.
`static int`	`PERMISSION_DELETE_DB` Permission flag to allow user to drop a database.
`static int`	`PERMISSION_DELETE_USER` Permission flag to allow user to delete a user account.
`static int`	`PERMISSION_DOCUMENT_INDEXES` Permission flag to allow user to manage document indexes.
`static int`	`PERMISSION_EMAIL_SERVICES` Permission flag to allow user to manage email services.
`static int`	`PERMISSION_JDBC_CONNECTIONS` Permission flag to allow user to view/manage the list of currently open JDBC/ODBC connections.
`static int`	`PERMISSION_METRICS` Permission flag to allow user to view current metrics page.
`static int`	`PERMISSION_OPEN_FILES` Permission flag to allow user to view the currently open file channels.
`static int`	`PERMISSION_PROCESSES` Permission flag to allow user to view/manage the currently running BBj processes.
`static int`	`PERMISSION_REPLICATION` Permission flag to allow user to manage replication jobs.
`static int`	`PERMISSION_SCHEDULING` Permission flag to allow user to configure scheduled and autorun jobs.
`static int`	`PERMISSION_SERVER_CONFIG` Permission flag to allow user to configure the server.
`static int`	`PERMISSION_SET_PASSWORDS` Permission flag to allow user to change a user's password other than their own.
`static int`	`PERMISSION_SET_PERMISSIONS` Permission flag to allow user to set permissions for other users.
`static int`	`PERMISSION_TABLE_ANALYSIS_QUEUE` Permission flag to allow user to view/manage the table analysis queue.
`static java.lang.String`	`SUPPORT_UPLOAD_COMPANY` Company name to use when sending a support upload to BASIS.
`static java.lang.String`	`SUPPORT_UPLOAD_SENDER_EMAIL` Email address to use to let BASIS support know who sent a support upload.
`static java.lang.String`	`SUPPORT_UPLOAD_SUPPORT_INCIDENT_ID` Support incident ID to use when sending a support upload to BASIS.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abortSupportUploadJob(java.lang.String p_uploadId)` Cancels the specified support upload job.
`void`	`acceptLdapCertificate(java.lang.String p_certificate)` Called to accept the LDAP certificate and add it to the accepted certificate list.
`void`	`addReplicationJob(BBjAdminReplicationJob job)` Add the specified replication job to the list of running jobs.
`BBjAdminUserPermissions`	`addUser(java.lang.String p_user, java.lang.String p_password)` Create a new user (committed).
`BBjAdminDatabase`	`attachDatabaseOnDisk(java.lang.String p_name, java.lang.String p_dictionary)` Attach to an existing database on disk.
`BBjAdminDatabase`	`attachDatabaseOnDisk(java.lang.String p_name, java.lang.String p_dictionary, boolean p_errorOnBadDictionary)` Attach to an existing database on disk.
`void`	`changePassword(java.lang.String p_user, java.lang.String p_password)` Change user password.
`boolean`	`checkUserPermission(int p_permission)` Returns true if the user logged into the API has the specified permission.
`void`	`clearCache()` Clear the BBj program cache.
`void`	`clearFileOpenInfo()` Clears the file open statistics gathered when a file is opened.
`void`	`commit(java.lang.String p_message)` Specify a specific commit message that will accompany the commit to the configuration Git archive.
`BBjAdminAsynchTriggerJob`	`createAsynchTriggerJob(java.lang.String p_name, java.lang.String p_address, int p_port, double p_kbps, boolean p_ssl, java.lang.String p_user, java.lang.String p_password, java.lang.String p_workingDir, java.lang.String p_config, boolean p_useDefaultAlias, java.lang.String p_writeProgram, java.lang.String p_removeProgram)` Creates a new asynchronous trigger job.
`BBjAdminAuditReplicationJob`	`createAuditReplicationJob(java.lang.String p_name, java.lang.String p_dbRoot, boolean p_synchronous, int p_rolloverType, int p_rolloverFrequency)` Creates a new filesystem audit job.
`<E> BBjAdminList<E>`	`createBBjAdminList()` Create a new BBjAdminList instance.
`<K,V> BBjAdminMap<K,V>`	`createBBjAdminMap()` Create a BBjAdminMap.
`<E> BBjAdminSet<E>`	`createBBjAdminSet()` Create a BBjAdminSet.
`BBjAdminBBjReplicationJob`	`createBBjReplicationJob(java.lang.String p_name, boolean p_synchronous)` Creates a new BBj replication job.
`BBjAdminBBjReplicationJob`	`createBBjReplicationJob(java.lang.String p_name, java.lang.String p_address, int p_port, boolean p_ssl, java.lang.String p_user, java.lang.String p_pwd, boolean p_synchronous)` Creates a new BBj replication job with the specified configuration info.
`BBjAdminBBjReplicationJob`	`createBBjReplicationJob(java.lang.String p_name, java.lang.String p_address, int p_port, double p_kbps, boolean p_ssl, java.lang.String p_user, java.lang.String p_pwd, boolean p_synchronous)` Creates a new BBj replication job with the specified configuration info.
`BBjAdminBBjReplicationJob`	createBBjReplicationJob(java.lang.String p_name, java.lang.String p_address, int p_port, double p_kbps, boolean p_ssl, java.lang.String p_user, java.lang.String p_pwd, boolean p_synchronous, java.lang.String p_eventHandlerProgram, java.lang.String p_eventHandlerUser, java.lang.String p_eventHandlerPassword, java.lang.String p_eventHandlerConfig, java.lang.String p_eventHandlerWorkingDir, java.lang.String p_eventHandlerClasspath, java.lang.String p_eventEmailService, java.lang.String p_eventEmailRecipients) Creates a new BBj replication job with the specified configuration info.
`BBjAdminBuiApplication`	`createBuiApplication()` Deprecated. See `createRemoteApplication()`
`BBjAdminDatabase`	`createDatabaseOnDisk(java.lang.String p_name, java.lang.String p_dictionary, BBjAdminDatabase.DatabaseType p_type)` Create a new database and create the data dictionary files.
`void`	`createDirectory(java.lang.String p_fullPath, boolean p_recursive)` Creates the specified directory on the server.
`BBjAdminDocumentIndex`	`createDocumentIndex(java.lang.String p_name, java.lang.String p_type)` Creates a new BBjAdminDocumentIndex with the given name.
`BBjAdminOnlineCopyJobConfig`	`createOnlineCopyJobConfig()` Create an empty OnlineCopyJob.
`BBjAdminOnlineCopyJobConfig`	`createOnlineCopyJobConfig(java.lang.String p_file)` Create an OnlineCopyJob from a file.
`BBjAdminAppDeploymentApplication`	`createRemoteApplication()` Create a new remote application configuration.
`BBjAdminServer`	`createServerConfiguration(BBjAdminServer.ServerType p_type)` Create an empty server configuration of the specified type.
`BBjAdminSQLReplicationJob`	`createSQLReplicationJob()` Creates a new SQL replication job.
`BBjAdminWebService`	`createWebService()` Returns a new instance of a Web service.
`void`	`dropDatabase(java.lang.String p_name, boolean p_deleteAllFiles)` Drop a database by name, optionally deleting all files.
`void`	`dropDocumentIndex(java.lang.String p_name)` Drops the specified document index.
`void`	`dropSecurityGroup(java.lang.String p_group)` Drops the specified security group (committed).
`void`	`dropUser(java.lang.String p_user)` Drop a user (committed).
`void`	`dumpHeap()` Dump the memory heap to the log.
`void`	`dumpThreads()` Dump JVM threads to the log.
`void`	`exportReplicationJob(BBjAdminReplicationJob p_job, java.lang.String p_filename)` Exports the replication job in a format that can then be read in using the import() method.
`void`	`generateWebStartCertificate(java.lang.String p_company, java.lang.String p_host, int p_port)` Tells BBj Services to have BASIS generate the Web Start certificates on the server.
`java.lang.String`	`getAbsolutePath(java.lang.String p_filename)` Returns the absolute path for the specified file or directory as a string.
`java.util.List<BBjAdminLicenseFeatureInfo>`	`getAllLicenseFeatureInfo()` Returns a list of BBjAdminLicenseFeatureInfo object for each feature the license uses.
`BBjAdminList<BBjAdminAsynchTriggerJob>`	`getAsynchTriggerJobs()` Returns a list of all the asynchronous trigger jobs currently configured on the system.
`BBjAdminList<BBjAdminAsynchTriggerTarget>`	`getAsynchTriggerTargets()` Returns a list of all the asynchronous trigger job targets on this machine.
`BBjAdminAuditDB`	`getAuditDatabase(java.lang.String p_dbName)`
`BBjAdminList<BBjAdminAuditReplicationJob>`	`getAuditJobs()` Returns a list of all the audit jobs currently configured on the server.
`BBjAdminList<BBjAdminAuditReplicationTarget>`	`getAuditTargets()` Returns a list of all the audit target currently on this server.
`BBjAdminAutorun`	`getAutorunConfiguration()` Get the autorun configuration.
`BBjAdminList<BBjAdminSystemPermission>`	`getAvailableSystemPermissions()` Returns a list of the system permissions that are available on the server.
`BBjAdminBBjFile`	`getBBjFile(java.lang.String p_path)` Returns a BBjAdminBBjFile for the specified full path.
`byte[]`	`getBBjFileRecord(java.lang.String p_path, int p_recNum)` Reads the record at the specified record location and returns the contents of the record as a byte[].
`BBjAdminBBjProcess`	`getBBjProcess(java.lang.String p_id)` Returns the BBjAdminBBjProcess for the specified ID.
`java.util.List<BBjAdminBBjProcess>`	`getBBjProcesses()` Get the set of BBj processes (read-only).
`java.util.Properties`	`getBBjProperties()` Returns a Map containing all the properties and their values found in the BBj.properties file.
`java.lang.String`	`getBBjPropertiesFile()` Returns a read-only copy of the contents of the BBj.properties file.
`BBjAdminBuiConfiguration`	`getBuiConfiguration()` Deprecated. See `getRemoteConfiguration()`
`BBjAdminList<java.lang.String>`	`getClasspath(java.lang.String p_cpName)` Returns the list of items that make up the specified classpath.
`BBjAdminList<java.lang.String>`	`getClasspathNames()` Returns a list of the session specific classpaths on the server.
`BBjAdminClientBBjProcess`	`getClientBBjProcess(java.lang.String p_id)` Returns the BBjAdminBBjProcess for the specified ID.
`java.util.List<BBjAdminClientBBjProcess>`	`getClientBBjProcesses()` Get the set of BBj processes (read-only).
`java.util.List<BBjAdminClientOpenFile>`	`getClientOpenFiles()` Get the list of open files (read-only).
`java.util.List<BBjAdminClientReplicationJob>`	`getClientReplicationJobs()` Returns a list of the replication jobs currently running on the system.
`java.lang.String`	`getConfigCommitDiffText(java.lang.String p_commitId1, java.lang.String p_commitId2)` Returns the Git diff patch text between two commits.
`java.util.List<BBjAdminGitCommit>`	`getConfigCommits(int startDate, int endDate)` Returns a list of the config directory commits that have occurred during the optional range of dates.
`BBjAdminConfiguration`	`getConfiguration()` Returns an object which provides access to server configuration settings.
`BBjAdminConnectionPool`	`getConnectionPool(java.lang.String p_poolName)` Returns the specified connection pool for administration purposes.
`BBjAdminList<BBjAdminConnectionPool>`	`getConnectionPools()` Returns a list of available connection pools for administration purposes.
`BBjAdminDatabase`	`getDatabase(java.lang.String p_name)` Get a single existing database.
`java.util.Set<java.lang.String>`	`getDatabaseNames()` Get the names of all accessible databases.
`BBjAdminSet<BBjAdminDatabase>`	`getDatabases()` Get all accessible databases.
`BBjAdminDocumentIndex`	`getDocumentIndex(java.lang.String p_name)` Returns a document index for the specified name.
`BBjAdminList<BBjAdminDocumentIndex>`	`getDocumentIndexes()` Returns a list of all the document indexes available on the server.
`BBjAdminEmailService`	`getEmailService(java.lang.String p_name)` Get the email service with the specified name.
`BBjAdminList<BBjAdminEmailService>`	`getEmailServices()` Returns a list of the currently configured email services on the server.
`BBjAdminList<BBjAdminReplicationJob>`	`getEnabledReplicationJobs()` Returns a list of all the currently enabled replication jobs.
`BBjAdminEventManager`	`getEventManager()` The event manager manages the system events that may occur on the server.
`BBjAdminFile`	`getFile(java.lang.String p_fullPath)` Returns a BBjAdminFile for the specified full path.
`BBjAdminMap<BBjAdminFileOpenInfoKey,BBjAdminFileOpenInfoValue>`	`getFileOpenInfo()` Returns the file open statistics gathered when a file is opened.
`long`	`getFreeSpace(java.lang.String p_path)` Returns the number of free bytes available
`BBjAdminSet<BBjAdminIndexBuilderJob>`	`getIndexBuilderJobs()` Returns a list of the currently running index builder jobs on the server.
`java.util.List<java.lang.String>`	`getJarIndexJars(java.lang.String p_jarFilePath)` Returns a list of the jars referenced in a JarIndex if one is present in the specified jar file.
`java.util.Properties`	`getJavaInfo(java.lang.String p_javaHome, boolean p_server)` Returns the information about the Java Virtual Machine located at the specified location.
`BBjAdminJnlpConfiguration`	`getJnlpConfiguration()` Returns the configuration object for managing the JNLP applications and settings on the server.
`BBjAdminLicenseFeatureInfo`	`getLicenseFeatureInfo(java.lang.String p_feature)` Returns the license information for the specified feature.
`java.lang.String`	`getLocaleString()` Returns the Locale as a string.
`java.util.List<BBjAdminMemoryUsage>`	`getMemoryUsageData(java.lang.String p_alternateLocation)`
`BBjAdminList<java.lang.String>`	`getMountedTriggerDirectories()` Returns a list of the trigger directories that are currently mounted by the server.
`BBjAdminSet<BBjAdminOnlineCopyJobRun>`	`getOnlineCopyJobs()` Get all currently running Online Copy Jobs.
`BBjAdminOpenFile`	`getOpenFile(java.lang.String p_id)` Get the open file (read-only) with the specified ID.
`java.util.List<BBjAdminOpenFile>`	`getOpenFiles()` Get the set of open files (read-only).
`java.util.List<BBjAdminClientOSFile>`	`getOSFiles(BBjAdminClientOSFile p_parent, java.lang.String[] p_filenameFilter, java.util.Date p_modifiedFilterStart, java.util.Date p_modifiedFilterEnd)` Returns a list of files from the operating system.
`java.lang.String`	`getPassword()` Deprecated.
`BBjAdminAppDeploymentConfiguration`	`getRemoteConfiguration()` Returns the configuration object for managing the remote-launch applications (including BUI) and settings on the server.
`BBjAdminReplicationJob`	`getReplicationJob(java.lang.String p_uuid)` Returns the replication job running on the system that has the specified UUID.
`BBjAdminList<BBjAdminReplicationJob>`	`getReplicationJobs()` Returns a list of the replication jobs currently running on the system.
`BBjAdminList<BBjAdminReplicationTarget>`	`getReplicationTargets()` Returns a list of the replication targets on the system.
`BBjAdminList<java.lang.String>`	`getRoots()` Returns a list of all the roots or drives on the machine.
`BBjAdminList<java.lang.String>`	`getSecurityGroupNames()` Returns a list of available security group names.
`BBjAdminList<BBjAdminSecurityGroup>`	`getSecurityGroups()` Returns a list of available security groups.
`BBjAdminMap<BBjAdminServer.ServerType,BBjAdminSet<BBjAdminServer>>`	`getServerConfigurations()` Get the server configuration.
`BBjAdminSet<BBjAdminServer>`	`getServerConfigurations(BBjAdminServer.ServerType p_type)` Get the server configurations for a single type of server.
`BBjAdminUserPermissions`	`getSingleUserPermissions(java.lang.String p_user)` Get the permissions for a single user.
`BBjAdminSet<BBjAdminSQLConnection>`	`getSQLConnections()` Get the set of SQL connections (read-only).
`java.lang.String`	`getStartTime()` Returns the time that the currently running BBjServices was started as a formatted timestamp string including the timezone.
`BBjAdminList<BBjAdminStartupException>`	`getStartupExceptions()` Returns a list of any startup exceptions that occured while BBj Services was attempting to start.
`BBjAdminSupportUploadJob`	`getSupportUploadJob(java.lang.String p_uploadId)` Returns an instance of BBjAdminSupportUploadJob containing the information about the current status of the specified upload job ID.
`BBjAdminList<BBjAdminSupportUploadJob>`	`getSupportUploadJobs()` Returns a list of all the currently running support upload jobs.
`java.lang.String`	`getSystemProperty(java.lang.String p_property, java.lang.String p_default)` Returns a system property from the server.
`BBjAdminSet<BBjAdminTableAnalysisJob>`	`getTableAnalysisJobs()` Returns a list of the currently queued and/or running table analysis jobs on the server.
`BBjAdminTaskQueue`	`getTaskQueue()` Returns a list of all the currently configured task groups on the server.
`java.lang.String`	`getTemplateForFile(java.lang.String p_filename)` Returns a string template (if one can be found) for the specified data file.
`java.lang.String`	`getTextFileContents(java.lang.String p_fullPath)` Returns the contents of the specified file from the remote machine as a string.
`java.lang.String`	`getTokenValue()`
`long`	`getTotalSpace(java.lang.String p_path)` Returns the total space available on the specified root or drive.
`BBjAdminTriggers`	`getTriggers(java.lang.String p_filename)` Get the trigger configuration for a file.
`java.lang.String`	`getUser()` Get the name of the user who got this BBjAdmin instance.
`java.util.List<java.lang.String>`	`getUserNames()` Get the names of users.
`BBjAdminList<BBjAdminUserPermissions>`	`getUserPermissions()` Get the permissions for all users.
`BBjAdminWebAppServer`	`getWebAppServer()` Get the Web App Server configuration.
`BBjAdminWebService`	`getWebService(java.lang.String p_name)` Returns the BBjAdminWebService instance for the specified service, or null if no service by that name exists.
`BBjAdminList<BBjAdminWebService>`	`getWebServices()` Returns a list of available web services.
`void`	`hardResetConfigCommit(java.lang.String p_commitId, java.lang.String p_name, java.lang.String p_email)` Performs a hard reset of the configuration, returning it to the specified commit ID state.
`BBjAdminReplicationJob`	`importReplicationJob(java.lang.String p_filename, java.lang.String p_user, java.lang.String p_password)` Loads the contents of a replication job export file into the object.
`boolean`	`isAddressSameAsServer(java.lang.String p_address)` Returns true if the specified host address resolves to the same address as the machine running the Admin Server.
`boolean`	`isAdminOnlyMode()` Asks the server if it is currently set to admin only mode.
`boolean`	`isOSWindows()` Returns true if the server side OS is MS Windows of some type.
`java.lang.String`	`isReplicationAllowed()` Asks the server if it is allowed to peform replication jobs.
`boolean`	`isRunningAdminOnlyMode()` Asks the server if it is currently RUNNING in admin only mode.
`boolean`	`isWS3Allowed()` Checks if Version 3 WebServices are available.
`java.lang.String`	`jsonExecute(java.lang.String json)` Executes some server-side processing defined by the supplied JSON string.
`void`	`migrateToEnhancedDatabase(java.lang.String p_sourceDatabase, java.lang.String p_destinationDatabase, java.lang.String p_destinationDirectory)` Creates a new data dictionary in the specified format at the specified destination location using the dictionary at p_sourceDictionary.
`void`	`mountTriggerDirectory(java.lang.String p_fullPath)` Mounts a directory to be listed when asking for a list of mounted trigger directories.
`BBjAdminConnectionPool`	`newConnectionPool()` Returns a new connection pool definition.
`BBjAdminDatabase`	`newDatabaseInstance(java.util.Map<java.lang.String,java.lang.Object> p_map)` Returns a new, empty database instance.
`BBjAdminEmailService`	`newEmailService()` Creates and returns a new Email Service that provides the ability to send email messages using the Admin API or easily configure various parts of the system to send notifications via email such as replication problems, etc.
`BBjAdminLDAPSearch`	`newLDAPSearch()` Returns a new, blank LDAP search instance.
`BBjAdminSecurityGroup`	`newSecurityGroup(java.lang.String p_groupName)` Returns a new SecurityGroup instance.
`BBjAdminTask`	`newTask(BBjAdminTask.TaskType p_type)` Returns a new task of the specified type.
`BBjAdminTaskGroup`	`newTaskGroup()` Returns a new task group from the server.
`void`	`refresh()` Refresh properties that may have changed on the server, locally changed properties will not be overridden.
`void`	`release()` Release resources held.
`void`	`reloadDatabaseConfig()` Reload the Database configuration file.
`void`	`removeBuiApplication(java.lang.String p_name)` Removes the specified BUI application configuration.
`void`	`removeConnectionPool(java.lang.String p_poolName)` Removes the specified connection pool from the server.
`void`	`removeEmailService(java.lang.String p_name)` Removes the specified email service configuration from the server.
`void`	`removeReplicationJob(java.lang.String p_uuid, boolean p_erase)` Removes the replication job identified by the specified UUID.
`void`	`removeReplicationTarget(java.lang.String p_uuid, boolean p_erase)` Removes the replication target identified by the specified UUID.
`void`	`removeTaskGroup(BBjAdminTaskGroup p_group)` Removes the specified task group from the server.
`void`	`removeTriggers(java.lang.String p_filename)` Removes the trigger from the specified file.
`void`	`removeWebService(java.lang.String p_name)` Removes the specified web service from the server.
`void`	`restartBBjServices(boolean p_waitForClients)` Tells the remote BBj Services to shutdown and restart.
`void`	`setAdminOnlyMode(boolean p_adminOnly)` Tells the server to set itself into admin only mode the next time it is restarted.
`void`	`setAutorunConfiguration(BBjAdminAutorun p_autorun)` Set the autorun configuration (not committed).
`void`	`setClasspath(java.lang.String p_cpName, java.util.List<java.lang.String> p_values)` Sets the list of items that make up the specified named classpath.
`void`	`setReplicationJobEnabled(java.lang.String p_replicationID, boolean p_enabled)` Enables/Disables the specified replication job.
`void`	`setServerConfigurations(BBjAdminMap<BBjAdminServer.ServerType,BBjAdminSet<BBjAdminServer>> p_config)` Set the server configuration (not committed).
`void`	`setServerConfigurations(BBjAdminServer.ServerType p_type, BBjAdminSet<BBjAdminServer> p_servers)` Set the server configurations for a single type of server (not committed).
`void`	`setSingleUserPermissions(BBjAdminUserPermissions p_permissions)` Set an individual user's permissions (not committed).
`void`	`setTableAnalysisEnabled(java.lang.String p_database, boolean p_enabled)` Enables or disabled the ability to perform a table analysis on the specified database.
`void`	`setTriggers(BBjAdminTriggers p_triggers)` Set the trigger configuration for a file (not committed).
`void`	`setUserPermissions(BBjAdminSet<BBjAdminUserPermissions> p_permissions)` Set permissions for a whole set of users (not committed).
`void`	`shutdownBBjServices(boolean p_waitForClients)` Tells BBj Services to shutdown.
`BBjAdminOnlineCopyJobRun`	`startOnlineCopyJob(BBjAdminOnlineCopyJobConfig p_config)` Start an online copy job.
`void`	`testJdbcConnection(java.lang.String p_driver, java.lang.String p_url, java.lang.String p_user, java.lang.String p_password)` Tests connecting with the specified JDBC driver, URL, user and password from the server.
`void`	`testRemoteFilesystemAccessibility(java.lang.String p_host, int p_port, boolean p_ssl, java.lang.String p_user, java.lang.String p_password)` Called to test and see if the server can connect to the specified remote filesystem.
`void`	`unmountTriggerDirectory(java.lang.String p_fullPath)` Unmounts a trigger directory.
`void`	`unpinAllPrograms()` Unpin all programs.
`void`	`updateEventManager(BBjAdminEventManager p_manager)`
`void`	`updateReplicationJob(BBjAdminReplicationJob job)` Updates the replication job on the server with the same ID, with the information in the specified replication job.
`java.lang.String`	`uploadSupportFiles(BBjAdminSet<java.lang.String> p_files, BBjAdminMap<java.lang.String,java.lang.String> p_properties)` Send the specified list of files to support.
`void`	`useExistingWebStartCertificate(java.lang.String p_keystore, java.lang.String p_keystorePassword, java.lang.String p_privateKey, java.lang.String p_privateKeyPassword)` Configures BBj Services to use the specified certificate for Web start applications.

Methods inherited from interface com.basis.api.admin.BBjAdminCommitPropertyWriter
getChangedProperties, getClearedProperties, getOriginalProperties

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter
addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader
checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Methods inherited from interface com.basis.api.admin.BBjAdminCommitWriter
commit, rollback

- Field Detail
  - LOG
```
static final java.util.logging.Logger LOG
```
  - PERMISSION_ATTACH_EXISTING_DB
```
static final int PERMISSION_ATTACH_EXISTING_DB
```
    Permission flag to allow user to attach to an existing data dictionary.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_CREATE_NEW_DB
```
static final int PERMISSION_CREATE_NEW_DB
```
    Permission flag to allow user to create a new database including new data dictionary.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_DELETE_DB
```
static final int PERMISSION_DELETE_DB
```
    Permission flag to allow user to drop a database.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_ADD_USER
```
static final int PERMISSION_ADD_USER
```
    Permission flag to allow user to add a new user account.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_DELETE_USER
```
static final int PERMISSION_DELETE_USER
```
    Permission flag to allow user to delete a user account.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_SET_PERMISSIONS
```
static final int PERMISSION_SET_PERMISSIONS
```
    Permission flag to allow user to set permissions for other users.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_SET_PASSWORDS
```
static final int PERMISSION_SET_PASSWORDS
```
    Permission flag to allow user to change a user's password other than their own.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_PROCESSES
```
static final int PERMISSION_PROCESSES
```
    Permission flag to allow user to view/manage the currently running BBj processes.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_OPEN_FILES
```
static final int PERMISSION_OPEN_FILES
```
    Permission flag to allow user to view the currently open file channels. Users with this permission need PERMISSION_CLOSE_FILES in order to force-close an open file.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_JDBC_CONNECTIONS
```
static final int PERMISSION_JDBC_CONNECTIONS
```
    Permission flag to allow user to view/manage the list of currently open JDBC/ODBC connections.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_SERVER_CONFIG
```
static final int PERMISSION_SERVER_CONFIG
```
    Permission flag to allow user to configure the server.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_ALLOW_ADMIN
```
static final int PERMISSION_ALLOW_ADMIN
```
    Permission flag to allow user to use the Enterprise Manager.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_CREATE_NEW_TRIGGER
```
static final int PERMISSION_CREATE_NEW_TRIGGER
```
    Permission flag to allow user to create a new file trigger.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_CONNECTION_POOLS
```
static final int PERMISSION_CONNECTION_POOLS
```
    Permission flag to allow user to view/manage the list of connection pools.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_COPY_JOBS
```
static final int PERMISSION_COPY_JOBS
```
    Permission flag to allow user to view/manage the list of currently configured online copy jobs.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_TABLE_ANALYSIS_QUEUE
```
static final int PERMISSION_TABLE_ANALYSIS_QUEUE
```
    Permission flag to allow user to view/manage the table analysis queue.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_CLOSE_FILES
```
static final int PERMISSION_CLOSE_FILES
```
    Permission flag to allow user to force-close currently open file channels.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_REPLICATION
```
static final int PERMISSION_REPLICATION
```
    Permission flag to allow user to manage replication jobs.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_SCHEDULING
```
static final int PERMISSION_SCHEDULING
```
    Permission flag to allow user to configure scheduled and autorun jobs.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_AUDITING
```
static final int PERMISSION_AUDITING
```
    Permission flag to allow user to manage change audit jobs.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_ASYNCH_TRIGGER
```
static final int PERMISSION_ASYNCH_TRIGGER
```
    Permission flag to allow user to manage asynchronous triggers.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_DOCUMENT_INDEXES
```
static final int PERMISSION_DOCUMENT_INDEXES
```
    Permission flag to allow user to manage document indexes.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_EMAIL_SERVICES
```
static final int PERMISSION_EMAIL_SERVICES
```
    Permission flag to allow user to manage email services.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_METRICS
```
static final int PERMISSION_METRICS
```
    Permission flag to allow user to view current metrics page.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_ALLOW_ALL
```
static final int PERMISSION_ALLOW_ALL
```
    Permission flag to allow user to perform all administrative related tasks on a server.
    
    See Also:
    
    Constant Field Values
  - SUPPORT_UPLOAD_SENDER_EMAIL
```
static final java.lang.String SUPPORT_UPLOAD_SENDER_EMAIL
```
    Email address to use to let BASIS support know who sent a support upload.
    
    See Also:
    
    Constant Field Values
  - SUPPORT_UPLOAD_COMPANY
```
static final java.lang.String SUPPORT_UPLOAD_COMPANY
```
    Company name to use when sending a support upload to BASIS.
    
    See Also:
    
    Constant Field Values
  - SUPPORT_UPLOAD_SUPPORT_INCIDENT_ID
```
static final java.lang.String SUPPORT_UPLOAD_SUPPORT_INCIDENT_ID
```
    Support incident ID to use when sending a support upload to BASIS.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addReplicationJob
```
void addReplicationJob(BBjAdminReplicationJob job)
                throws BBjAdminException
```
    Add the specified replication job to the list of running jobs. The job will also be started.
    
    Parameters:
    
    job -
    
    Throws:
    
    BBjAdminException
  - addUser
```
BBjAdminUserPermissions addUser(java.lang.String p_user,
                                java.lang.String p_password)
                         throws BBjAdminException
```
    Create a new user (committed).
    
    Parameters:
    
    p_user -
    
    p_password -
    
    Throws:
    
    BBjAdminException
  - attachDatabaseOnDisk
```
BBjAdminDatabase attachDatabaseOnDisk(java.lang.String p_name,
                                      java.lang.String p_dictionary)
                               throws BBjAdminException
```
    Attach to an existing database on disk. An existing database consists of a data dictionary and the table's data files. In this step you only specify the data dictionary location. To set the location of the data files, set the DATABASE property on the BBjAdminDatabase instance.
    
    Parameters:
    
    p_name - Name of the new database.
    
    p_dictionary - Existing dictionary directory for the new database.
    
    Returns:
    
    A new BBjAdminDatabase instance with the given name and dictionary location.
    
    Throws:
    
    BBjAdminException
  - attachDatabaseOnDisk
```
BBjAdminDatabase attachDatabaseOnDisk(java.lang.String p_name,
                                      java.lang.String p_dictionary,
                                      boolean p_errorOnBadDictionary)
                               throws BBjAdminException
```
    Attach to an existing database on disk. An existing database consists of a data dictionary and the table's data files. In this step you only specify the data dictionary location. To set the location of the data files, set the DATABASE property on the BBjAdminDatabase instance.
    
    Parameters:
    
    p_name - Name of the new database.
    
    p_dictionary - Existing dictionary directory for the new database.
    
    p_errorOnBadDictionary - True if you want the method to error if the specified dictionary location does not contain a valid data dictionary.
    
    Returns:
    
    A new BBjAdminDatabase instance with the given name and dictionary location.
    
    Throws:
    
    BBjAdminException
  - changePassword
```
void changePassword(java.lang.String p_user,
                    java.lang.String p_password)
             throws BBjAdminException
```
    Change user password. This call immediately changes the user's password and does not require commit() to be called.
    
    Parameters:
    
    p_user - User to change the password for.
    
    p_password - New password for the user.
    
    Throws:
    
    BBjAdminException
  - clearCache
```
void clearCache()
         throws BBjAdminException
```
    Clear the BBj program cache.
    
    Throws:
    
    BBjAdminException
  - createAuditReplicationJob
```
BBjAdminAuditReplicationJob createAuditReplicationJob(java.lang.String p_name,
                                                      java.lang.String p_dbRoot,
                                                      boolean p_synchronous,
                                                      int p_rolloverType,
                                                      int p_rolloverFrequency)
                                               throws BBjAdminException
```
    Creates a new filesystem audit job. Audit jobs allow you to monitor a list of files and/or directories for changes to files. When a change occurs, that change will be logged to the audit database. See Auditing in the BBj Enterprise Manager documentation for more information.
    
    Parameters:
    
    p_name - Name of the audit job.
    
    p_dbRoot - A directory where the audit database will be created. The audit database is a standard BBj database containing special tables that hold the audit data. This location is where the audit database and any subsequent audit databases for this job (when they rollover) will be created.
    
    p_synchronous - Always set this to false.
    
    p_rolloverType - Rollover type is the when the audit log should rollover. Valid options are in the BBjAdminAuditReplicationJob interface and are: ROLLOVER_NONE, ROLLOVER_DAILY, ROLLOVER_WEEKLY, ROLLOVER_MONTHLY, ROLLOVER_YEARLY.
    
    Returns:
    
    A new BBjAdminAuditReplicationJob.
    
    Throws:
    
    BBjAdminException
  - createBBjAdminList
```
<E> BBjAdminList<E> createBBjAdminList()
                                throws BBjAdminException
```
    Create a new BBjAdminList instance. Always use this method to create a new BBjAdminList rather than directly using one of its implementation classes.
    
    Type Parameters:
    
    E -
    
    Returns:
    
    New BBjAdminList.
    
    Throws:
    
    BBjAdminException
  - createBBjAdminMap
```
<K,V> BBjAdminMap<K,V> createBBjAdminMap()
                                  throws BBjAdminException
```
    Create a BBjAdminMap. Always use this method to create a new BBjAdminMap rather than directly using one of its implementation classes.
    
    Returns:
    
    New BBjAdminMap
    
    Throws:
    
    BBjAdminException
  - createBBjAdminSet
```
<E> BBjAdminSet<E> createBBjAdminSet()
                              throws BBjAdminException
```
    Create a BBjAdminSet. Always use this method to create a new BBjAdminSet rather than directly using one of its implementation classes.
    
    Type Parameters:
    
    E -
    
    Returns:
    
    New BBjAdminSet.
    
    Throws:
    
    BBjAdminException
  - createBBjReplicationJob
```
BBjAdminBBjReplicationJob createBBjReplicationJob(java.lang.String p_name,
                                                  boolean p_synchronous)
                                           throws BBjAdminException
```
    Creates a new BBj replication job.
    
    Parameters:
    
    p_name - Name of the replication job.
    
    p_synchronous - Whether the job's replication operations should occur synchronously or asynchronously. This value SHOULD ALMOST ALWAYS BE false.
    
    Returns:
    
    New BBjAdminReplicationJob.
    
    Throws:
    
    BBjAdminException
  - createBBjReplicationJob
```
BBjAdminBBjReplicationJob createBBjReplicationJob(java.lang.String p_name,
                                                  java.lang.String p_address,
                                                  int p_port,
                                                  boolean p_ssl,
                                                  java.lang.String p_user,
                                                  java.lang.String p_pwd,
                                                  boolean p_synchronous)
                                           throws BBjAdminException
```
    Creates a new BBj replication job with the specified configuration info. Target is the machine destination for the replicated data while the source is the machine where the data being replicated resides.
    
    Parameters:
    
    p_name - Name of the replication job.
    
    p_address - Host name of the target filesystem server to connect to.
    
    p_port - Port number for the target filesystem server to connect to. Usually 2000.
    
    p_ssl - Whether the target filesystem server you are connecting to uses SSL. Must match the server's configuration.
    
    p_user - Username to use to connect to the target filesystem server.
    
    p_pwd - Password to use to connect to the target filesystem server.
    
    p_synchronous - Whether the job's replication operations should occur synchronously or asynchronously. This value SHOULD ALMOST ALWAYS BE false.
    
    Returns:
    
    New BBjAdminReplication job.
    
    Throws:
    
    BBjAdminException
  - createBBjReplicationJob
```
BBjAdminBBjReplicationJob createBBjReplicationJob(java.lang.String p_name,
                                                  java.lang.String p_address,
                                                  int p_port,
                                                  double p_kbps,
                                                  boolean p_ssl,
                                                  java.lang.String p_user,
                                                  java.lang.String p_pwd,
                                                  boolean p_synchronous,
                                                  java.lang.String p_eventHandlerProgram,
                                                  java.lang.String p_eventHandlerUser,
                                                  java.lang.String p_eventHandlerPassword,
                                                  java.lang.String p_eventHandlerConfig,
                                                  java.lang.String p_eventHandlerWorkingDir,
                                                  java.lang.String p_eventHandlerClasspath,
                                                  java.lang.String p_eventEmailService,
                                                  java.lang.String p_eventEmailRecipients)
                                           throws BBjAdminException
```
    Creates a new BBj replication job with the specified configuration info. This method allows you to specify an event hanlder BBj program. The event handler will be executed when a change occurs in the status of the replication job such as when it is paused, resumed, etc.
    
    Parameters:
    
    p_name - Name of the replication job.
    
    p_address - Host name of the target filesystem server to connect to.
    
    p_port - Port number for the target filesystem server to connect to. Usually 2000.
    
    p_kbps - Optional way to limit the rate of replication. Kilobits per seconds to send replication operations.
    
    p_ssl - Whether the target filesystem server you are connecting to uses SSL. Must match the server's configuration.
    
    p_user - Username to use to connect to the target filesystem server.
    
    p_pwd - Password to use to connect to the target filesystem server.
    
    p_synchronous - Whether the job's replication operations should occur synchronously or asynchronously. This value SHOULD ALMOST ALWAYS BE false.
    
    p_eventHandlerProgram - BBj program to use to handle replication events. This program will be executed when each replication operation occurs. The program should decide how to handle each operation.
    
    p_eventHandlerUser - User to use to run the handler program.
    
    p_eventHandlerPassword - Password to use to run the handler program.
    
    p_eventHandlerConfig - config.bbx file to use for the interpreter that runs the handler program.
    
    p_eventHandlerWorkingDir - Working directory to use for the handler program.
    
    p_eventHandlerClasspath - Optional session specific classpath (SSCP) to use for the handler program.
    
    p_eventEmailService - Email service to be used to send notifications. See Email Services for more info.
    
    p_eventEmailRecipients - Comma separated list of email recipients for notifications.
    
    Returns:
    
    New replication job.
    
    Throws:
    
    BBjAdminException
  - createBBjReplicationJob
```
BBjAdminBBjReplicationJob createBBjReplicationJob(java.lang.String p_name,
                                                  java.lang.String p_address,
                                                  int p_port,
                                                  double p_kbps,
                                                  boolean p_ssl,
                                                  java.lang.String p_user,
                                                  java.lang.String p_pwd,
                                                  boolean p_synchronous)
                                           throws BBjAdminException
```
    Creates a new BBj replication job with the specified configuration info.
    
    Parameters:
    
    p_name - Name of the replication job.
    
    p_address - Host name of the target filesystem server to connect to.
    
    p_port - Port number for the target filesystem server to connect to. Usually 2000.
    
    p_kbps - Optional way to limit the rate of replication. Kilobits per seconds to send replication operations.
    
    p_ssl - Whether the target filesystem server you are connecting to uses SSL. Must match the server's configuration.
    
    p_user - Username to use to connect to the target filesystem server.
    
    p_pwd - Password to use to connect to the target filesystem server.
    
    p_synchronous - Whether the job's replication operations should occur synchronously or asynchronously. This value SHOULD ALMOST ALWAYS BE false.
    
    Returns:
    
    New BBjAdminReplication job.
    
    Throws:
    
    BBjAdminException
  - createDatabaseOnDisk
```
BBjAdminDatabase createDatabaseOnDisk(java.lang.String p_name,
                                      java.lang.String p_dictionary,
                                      BBjAdminDatabase.DatabaseType p_type)
                               throws BBjAdminException
```
    Create a new database and create the data dictionary files. Used for creating a new database entirely from scratch.
    
    Parameters:
    
    p_name - Name of the new database.
    
    p_dictionary - Dictionary directory for the new database data dictionary files. Must be empty.
    
    p_type - Type of database to create. Valid types are in BBjAdminDatabase.DatabaseType enum and include LEGACY, ENHANCED, and LINKED.
    
    Returns:
    
    New BBjAdminDatabase instance.
    
    Throws:
    
    BBjAdminException
  - createDirectory
```
void createDirectory(java.lang.String p_fullPath,
                     boolean p_recursive)
              throws BBjAdminException
```
    Creates the specified directory on the server. This uses the BBj Filesystem to create the directory which means it supports using the data server syntax in file names (i.e. //mypath)
    
    Parameters:
    
    p_fullPath - Full path to data file. Supports BBj data server syntax.
    
    p_recursive - True if it should create all parent directories. If false and one of the parent directories does not exist, it will throw an exception.
    
    Throws:
    
    BBjAdminException
  - createOnlineCopyJobConfig
```
BBjAdminOnlineCopyJobConfig createOnlineCopyJobConfig()
                                               throws BBjAdminException
```
    Create an empty OnlineCopyJob. To run the copy job, call the startOnlineCopyJob() method, passing in the BBjAdminOnlineCopyJobConfig instance returned by this method.
    
    Throws:
    
    BBjAdminException
  - createOnlineCopyJobConfig
```
BBjAdminOnlineCopyJobConfig createOnlineCopyJobConfig(java.lang.String p_file)
                                               throws BBjAdminException
```
    Create an OnlineCopyJob from a file. To run the copy job, call the startOnlineCopyJob() method, passing in the BBjAdminOnlineCopyJobConfig instance returned by this method.
    
    Parameters:
    
    p_file - Name of the file.
    
    Throws:
    
    BBjAdminException
  - createServerConfiguration
```
BBjAdminServer createServerConfiguration(BBjAdminServer.ServerType p_type)
                                  throws BBjAdminException
```
    Create an empty server configuration of the specified type.
    
    Parameters:
    
    p_type -
    
    Throws:
    
    BBjAdminException
  - createBuiApplication
```
@Deprecated
BBjAdminBuiApplication createBuiApplication()
                                                  throws BBjAdminException
```
    Deprecated. See createRemoteApplication()
    
    Create a new BUI application configuration. Make changes to the application configuration object and then call the commit() method to save the changes.
    
    Throws:
    
    BBjAdminException
  - createRemoteApplication
```
BBjAdminAppDeploymentApplication createRemoteApplication()
                                                  throws BBjAdminException
```
    Create a new remote application configuration. Make changes to the application configuration object and then call the commit() method to save the changes. This includes BUI and remote-launch exe application.
    
    Throws:
    
    BBjAdminException
  - createSQLReplicationJob
```
BBjAdminSQLReplicationJob createSQLReplicationJob()
                                           throws BBjAdminException
```
    Creates a new SQL replication job.
    
    Throws:
    
    BBjAdminException
  - dropDatabase
```
void dropDatabase(java.lang.String p_name,
                  boolean p_deleteAllFiles)
           throws BBjAdminException
```
    Drop a database by name, optionally deleting all files.
    
    Parameters:
    
    p_name -
    
    p_deleteAllFiles -
    
    Throws:
    
    BBjAdminException
  - dropUser
```
void dropUser(java.lang.String p_user)
       throws BBjAdminException
```
    Drop a user (committed).
    
    Parameters:
    
    p_user -
    
    Throws:
    
    BBjAdminException
  - dropSecurityGroup
```
void dropSecurityGroup(java.lang.String p_group)
                throws BBjAdminException
```
    Drops the specified security group (committed). This does not affect any of the users who are members of the group.
    
    Parameters:
    
    p_group -
    
    Throws:
    
    BBjAdminException
  - dumpHeap
```
void dumpHeap()
       throws BBjAdminException
```
    Dump the memory heap to the log.
    
    Throws:
    
    BBjAdminException
  - dumpThreads
```
void dumpThreads()
          throws BBjAdminException
```
    Dump JVM threads to the log.
    
    Throws:
    
    BBjAdminException
  - getAbsolutePath
```
java.lang.String getAbsolutePath(java.lang.String p_filename)
                          throws BBjAdminException
```
    Returns the absolute path for the specified file or directory as a string. Use this method to ask the server to resolve the file path according to its current working directory and OS.
    
    Parameters:
    
    p_filename -
    
    Throws:
    
    BBjAdminException
  - getAuditDatabase
```
BBjAdminAuditDB getAuditDatabase(java.lang.String p_dbName)
                          throws BBjAdminException
```
    Throws:
    
    BBjAdminException
  - getAuditJobs
```
BBjAdminList<BBjAdminAuditReplicationJob> getAuditJobs()
                                                throws BBjAdminException
```
    Returns a list of all the audit jobs currently configured on the server.
    
    Throws:
    
    BBjAdminException
  - getAuditTargets
```
BBjAdminList<BBjAdminAuditReplicationTarget> getAuditTargets()
                                                      throws BBjAdminException
```
    Returns a list of all the audit target currently on this server.
    
    Throws:
    
    BBjAdminException
  - getAutorunConfiguration
```
BBjAdminAutorun getAutorunConfiguration()
                                 throws BBjAdminException
```
    Get the autorun configuration.
    
    Throws:
    
    BBjAdminException
  - getAvailableSystemPermissions
```
BBjAdminList<BBjAdminSystemPermission> getAvailableSystemPermissions()
                                                              throws BBjAdminException
```
    Returns a list of the system permissions that are available on the server. This information is used to find out which permissions the server supports getting and setting.
    
    Throws:
    
    BBjAdminException
  - getBBjFile
```
BBjAdminBBjFile getBBjFile(java.lang.String p_path)
                    throws BBjAdminException
```
    Returns a BBjAdminBBjFile for the specified full path. This type of object is generated by examining the file using the BBj file system so the information is related to the specific types of BBj data and program files.
    
    Parameters:
    
    p_path -
    
    Throws:
    
    BBjAdminException
  - getBBjFileRecord
```
byte[] getBBjFileRecord(java.lang.String p_path,
                        int p_recNum)
                 throws BBjAdminException
```
    Reads the record at the specified record location and returns the contents of the record as a byte[]. Access to the file is granted based on the Admin API connected user's access permissions to the file.
    
    Parameters:
    
    p_path - Full path to the data file. This does not take into account any prefixes defined.
    
    p_recNum - Zero-based record number for the record of interest.
    
    Returns:
    
    Contents of the record. Returns null if there is no record at the specified record number.
    
    Throws:
    
    BBjAdminException - If there is a problem accessing the file.
  - getBBjProcess
```
BBjAdminBBjProcess getBBjProcess(java.lang.String p_id)
                          throws BBjAdminException
```
    Returns the BBjAdminBBjProcess for the specified ID. Use this to get a current fresh copy of the process information.
    
    Parameters:
    
    p_id -
    
    Throws:
    
    BBjAdminException
  - getBBjProcesses
```
java.util.List<BBjAdminBBjProcess> getBBjProcesses()
                                            throws BBjAdminException
```
    Get the set of BBj processes (read-only).
    
    Throws:
    
    BBjAdminException
  - getBBjProperties
```
java.util.Properties getBBjProperties()
                               throws BBjAdminException
```
    Returns a Map containing all the properties and their values found in the BBj.properties file.
    
    Throws:
    
    BBjAdminException
  - getBBjPropertiesFile
```
java.lang.String getBBjPropertiesFile()
                               throws BBjAdminException
```
    Returns a read-only copy of the contents of the BBj.properties file.
    
    Throws:
    
    BBjAdminException
  - getBuiConfiguration
```
@Deprecated
BBjAdminBuiConfiguration getBuiConfiguration()
                                                   throws BBjAdminException
```
    Deprecated. See getRemoteConfiguration()
    
    Returns the configuration object for managing the BUI applications and settings on the server.
    
    Throws:
    
    BBjAdminException
  - getRemoteConfiguration
```
BBjAdminAppDeploymentConfiguration getRemoteConfiguration()
                                                   throws BBjAdminException
```
    Returns the configuration object for managing the remote-launch applications (including BUI) and settings on the server. This replaces the previous (and now deprecated) getBuiConfiguration() method.
    
    Throws:
    
    BBjAdminException
  - getJnlpConfiguration
```
BBjAdminJnlpConfiguration getJnlpConfiguration()
                                        throws BBjAdminException
```
    Returns the configuration object for managing the JNLP applications and settings on the server.
    
    Throws:
    
    BBjAdminException
  - getWebServices
```
BBjAdminList<BBjAdminWebService> getWebServices()
                                         throws BBjAdminException
```
    Returns a list of available web services.
    
    Throws:
    
    BBjAdminException
  - getWebService
```
BBjAdminWebService getWebService(java.lang.String p_name)
                          throws BBjAdminException
```
    Returns the BBjAdminWebService instance for the specified service, or null if no service by that name exists.
    
    Parameters:
    
    p_name -
    
    Throws:
    
    BBjAdminException
  - removeWebService
```
void removeWebService(java.lang.String p_name)
               throws BBjAdminException
```
    Removes the specified web service from the server.
    
    Parameters:
    
    p_name -
    
    Throws:
    
    BBjAdminException
  - getClientBBjProcess
```
BBjAdminClientBBjProcess getClientBBjProcess(java.lang.String p_id)
                                      throws BBjAdminException
```
    Returns the BBjAdminBBjProcess for the specified ID. Use this to get a current fresh copy of the process information.
    
    Parameters:
    
    p_id -
    
    Throws:
    
    BBjAdminException
  - getClientBBjProcesses
```
java.util.List<BBjAdminClientBBjProcess> getClientBBjProcesses()
                                                        throws BBjAdminException
```
    Get the set of BBj processes (read-only).
    
    Throws:
    
    BBjAdminException
  - getClientReplicationJobs
```
java.util.List<BBjAdminClientReplicationJob> getClientReplicationJobs()
                                                               throws BBjAdminException
```
    Returns a list of the replication jobs currently running on the system. The objects returned are read-only and only contain data but do not implement functionality for any method calls. These are used for display purposes to optimize network performance.
    
    Throws:
    
    BBjAdminException
  - getConfiguration
```
BBjAdminConfiguration getConfiguration()
                                throws BBjAdminException
```
    Returns an object which provides access to server configuration settings.
    
    Throws:
    
    BBjAdminException
  - getConnectionPool
```
BBjAdminConnectionPool getConnectionPool(java.lang.String p_poolName)
                                  throws BBjAdminException
```
    Returns the specified connection pool for administration purposes.
    
    Parameters:
    
    p_poolName -
    
    Throws:
    
    BBjAdminException
  - getConnectionPools
```
BBjAdminList<BBjAdminConnectionPool> getConnectionPools()
                                                 throws BBjAdminException
```
    Returns a list of available connection pools for administration purposes.
    
    Throws:
    
    BBjAdminException
  - getDatabase
```
BBjAdminDatabase getDatabase(java.lang.String p_name)
                      throws BBjAdminException
```
    Get a single existing database.
    
    Parameters:
    
    p_name -
    
    Throws:
    
    BBjAdminException
  - getDatabaseNames
```
java.util.Set<java.lang.String> getDatabaseNames()
                                          throws BBjAdminException
```
    Get the names of all accessible databases.
    
    Throws:
    
    BBjAdminException
  - getDatabases
```
BBjAdminSet<BBjAdminDatabase> getDatabases()
                                    throws BBjAdminException
```
    Get all accessible databases.
    
    Throws:
    
    BBjAdminException
  - getFile
```
BBjAdminFile getFile(java.lang.String p_fullPath)
              throws BBjAdminException
```
    Returns a BBjAdminFile for the specified full path. If null, the object will contain all the roots for the file system on the remote machine.
    
    Parameters:
    
    p_fullPath -
    
    Throws:
    
    BBjAdminException
  - getFreeSpace
```
long getFreeSpace(java.lang.String p_path)
           throws BBjAdminException
```
    Returns the number of free bytes available
    
    Throws:
    
    BBjAdminException
  - getLocaleString
```
java.lang.String getLocaleString()
                          throws BBjAdminException
```
    Returns the Locale as a string.
    
    Throws:
    
    BBjAdminException
  - getMountedTriggerDirectories
```
BBjAdminList<java.lang.String> getMountedTriggerDirectories()
                                                     throws BBjAdminException
```
    Returns a list of the trigger directories that are currently mounted by the server. We keep track of directories that are mounted for triggers so that we can provide a nice interface to the user for looking at triggers. We only show those that are mounted because it would be too difficult to search the entire drive for all files that have a trigger on them. So, this is a convenience method.
    
    Throws:
    
    BBjAdminException
  - getOnlineCopyJobs
```
BBjAdminSet<BBjAdminOnlineCopyJobRun> getOnlineCopyJobs()
                                                 throws BBjAdminException
```
    Get all currently running Online Copy Jobs.
    
    Throws:
    
    BBjAdminException
  - getOpenFiles
```
java.util.List<BBjAdminOpenFile> getOpenFiles()
                                       throws BBjAdminException
```
    Get the set of open files (read-only).
    
    Throws:
    
    BBjAdminException
  - getOpenFile
```
BBjAdminOpenFile getOpenFile(java.lang.String p_id)
                      throws BBjAdminException
```
    Get the open file (read-only) with the specified ID.
    
    Throws:
    
    BBjAdminException
  - getClientOpenFiles
```
java.util.List<BBjAdminClientOpenFile> getClientOpenFiles()
                                                   throws BBjAdminException
```
    Get the list of open files (read-only). This is different from getOpenFiles() in that it returns a list of objects that are not connected to the server making calls on these objects much faster.
    
    Throws:
    
    BBjAdminException
  - getOSFiles
```
java.util.List<BBjAdminClientOSFile> getOSFiles(BBjAdminClientOSFile p_parent,
                                                java.lang.String[] p_filenameFilter,
                                                java.util.Date p_modifiedFilterStart,
                                                java.util.Date p_modifiedFilterEnd)
                                         throws BBjAdminException
```
    Returns a list of files from the operating system. This does NOT use the BBj filesystem handling code, but rather, looks at the files on the operating system.
    
    Parameters:
    
    p_parent -
    
    p_filenameFilter -
    
    p_modifiedFilterStart -
    
    p_modifiedFilterEnd -
    
    Throws:
    
    BBjAdminException
  - getPassword
```
@Deprecated
java.lang.String getPassword()
                                   throws BBjAdminException
```
    Deprecated.
    
    Get the password of the user who got this BBjAdmin instance. THIS IS DEPRECATED. You should no longer use this method as it presents a security vulnerability to provide access to a user password once they've been authenticated.
    
    Throws:
    
    BBjAdminException
  - getReplicationJob
```
BBjAdminReplicationJob getReplicationJob(java.lang.String p_uuid)
                                  throws BBjAdminException
```
    Returns the replication job running on the system that has the specified UUID.
    
    Parameters:
    
    p_uuid -
    
    Throws:
    
    BBjAdminException
  - getReplicationJobs
```
BBjAdminList<BBjAdminReplicationJob> getReplicationJobs()
                                                 throws BBjAdminException
```
    Returns a list of the replication jobs currently running on the system.
    
    Throws:
    
    BBjAdminException
  - getEnabledReplicationJobs
```
BBjAdminList<BBjAdminReplicationJob> getEnabledReplicationJobs()
                                                        throws BBjAdminException
```
    Returns a list of all the currently enabled replication jobs. Any jobs currently paused (disabled) will not show in this list.
    
    Returns:
    
    List of all enabled replication jobs.
    
    Throws:
    
    BBjAdminException
  - getReplicationTargets
```
BBjAdminList<BBjAdminReplicationTarget> getReplicationTargets()
                                                       throws BBjAdminException
```
    Returns a list of the replication targets on the system. A replication target is a job that is replicating from a machine, to this machine.
    
    Throws:
    
    BBjAdminException
  - getRoots
```
BBjAdminList<java.lang.String> getRoots()
                                 throws BBjAdminException
```
    Returns a list of all the roots or drives on the machine.
    
    Throws:
    
    BBjAdminException
  - getSecurityGroupNames
```
BBjAdminList<java.lang.String> getSecurityGroupNames()
                                              throws BBjAdminException
```
    Returns a list of available security group names.
    
    Throws:
    
    BBjAdminException
  - getSecurityGroups
```
BBjAdminList<BBjAdminSecurityGroup> getSecurityGroups()
                                               throws BBjAdminException
```
    Returns a list of available security groups.
    
    Throws:
    
    BBjAdminException
  - getServerConfigurations
```
BBjAdminMap<BBjAdminServer.ServerType,BBjAdminSet<BBjAdminServer>> getServerConfigurations()
                                                                                    throws BBjAdminException
```
    Get the server configuration.
    
    Throws:
    
    BBjAdminException
  - getServerConfigurations
```
BBjAdminSet<BBjAdminServer> getServerConfigurations(BBjAdminServer.ServerType p_type)
                                             throws BBjAdminException
```
    Get the server configurations for a single type of server.
    
    Parameters:
    
    p_type -
    
    Throws:
    
    BBjAdminException
  - getSingleUserPermissions
```
BBjAdminUserPermissions getSingleUserPermissions(java.lang.String p_user)
                                          throws BBjAdminException
```
    Get the permissions for a single user.
    
    Parameters:
    
    p_user -
    
    Throws:
    
    BBjAdminException
  - getSQLConnections
```
BBjAdminSet<BBjAdminSQLConnection> getSQLConnections()
                                              throws BBjAdminException
```
    Get the set of SQL connections (read-only).
    
    Throws:
    
    BBjAdminException
  - getStartupExceptions
```
BBjAdminList<BBjAdminStartupException> getStartupExceptions()
                                                     throws BBjAdminException
```
    Returns a list of any startup exceptions that occured while BBj Services was attempting to start. If any server fails to start, a startup exception will be in this list for it.
    
    Throws:
    
    BBjAdminException
  - getSystemProperty
```
java.lang.String getSystemProperty(java.lang.String p_property,
                                   java.lang.String p_default)
                            throws BBjAdminException
```
    Returns a system property from the server. Basically it is the equivalent to calling System.getProperty() on the server side.
    
    Parameters:
    
    p_property -
    
    p_default -
    
    Throws:
    
    BBjAdminException
  - getTableAnalysisJobs
```
BBjAdminSet<BBjAdminTableAnalysisJob> getTableAnalysisJobs()
                                                    throws BBjAdminException
```
    Returns a list of the currently queued and/or running table analysis jobs on the server.
    
    Returns:
    
    List of the queued and running table analysis jobs.
    
    Throws:
    
    BBjAdminException
  - getIndexBuilderJobs
```
BBjAdminSet<BBjAdminIndexBuilderJob> getIndexBuilderJobs()
                                                  throws BBjAdminException
```
    Returns a list of the currently running index builder jobs on the server.
    
    Returns:
    
    List of running index builder jobs.
    
    Throws:
    
    BBjAdminException
  - getTaskQueue
```
BBjAdminTaskQueue getTaskQueue()
                        throws BBjAdminException
```
    Returns a list of all the currently configured task groups on the server.
    
    Returns:
    
    List of all the configured task groups.
    
    Throws:
    
    BBjAdminException
  - getTemplateForFile
```
java.lang.String getTemplateForFile(java.lang.String p_filename)
                             throws BBjAdminException
```
    Returns a string template (if one can be found) for the specified data file. It searches all the databases to see if there is a table that points to the data file. If if finds one, it returns the string template for that table.
    
    Parameters:
    
    p_filename -
    
    Throws:
    
    BBjAdminException
  - getTextFileContents
```
java.lang.String getTextFileContents(java.lang.String p_fullPath)
                              throws BBjAdminException
```
    Returns the contents of the specified file from the remote machine as a string. This method is only designed to retrieve text based files.
    
    Parameters:
    
    p_fullPath -
    
    Throws:
    
    BBjAdminException
  - getTotalSpace
```
long getTotalSpace(java.lang.String p_path)
            throws BBjAdminException
```
    Returns the total space available on the specified root or drive.
    
    Parameters:
    
    p_path -
    
    Throws:
    
    BBjAdminException
  - getTriggers
```
BBjAdminTriggers getTriggers(java.lang.String p_filename)
                      throws BBjAdminException
```
    Get the trigger configuration for a file.
    
    Parameters:
    
    p_filename -
    
    Throws:
    
    BBjAdminException
  - getUser
```
java.lang.String getUser()
                  throws BBjAdminException
```
    Get the name of the user who got this BBjAdmin instance.
    
    Throws:
    
    BBjAdminException
  - getTokenValue
```
java.lang.String getTokenValue()
                        throws BBjAdminException
```
    Throws:
    
    BBjAdminException
  - getUserNames
```
java.util.List<java.lang.String> getUserNames()
                                       throws BBjAdminException
```
    Get the names of users.
    
    Throws:
    
    BBjAdminException
  - getUserPermissions
```
BBjAdminList<BBjAdminUserPermissions> getUserPermissions()
                                                  throws BBjAdminException
```
    Get the permissions for all users.
    
    Throws:
    
    BBjAdminException
  - getWebAppServer
```
BBjAdminWebAppServer getWebAppServer()
                              throws BBjAdminException
```
    Get the Web App Server configuration.
    
    Throws:
    
    BBjAdminException
  - isAddressSameAsServer
```
boolean isAddressSameAsServer(java.lang.String p_address)
                       throws BBjAdminException
```
    Returns true if the specified host address resolves to the same address as the machine running the Admin Server.
    
    Parameters:
    
    p_address -
    
    Throws:
    
    BBjAdminException
  - isAdminOnlyMode
```
boolean isAdminOnlyMode()
                 throws BBjAdminException
```
    Asks the server if it is currently set to admin only mode. If you need to know if the server is currently running in admin only mode, call isRunningAdminOnlyMode() instead.
    
    Throws:
    
    BBjAdminException
  - isOSWindows
```
boolean isOSWindows()
             throws BBjAdminException
```
    Returns true if the server side OS is MS Windows of some type. Otherwise it returns false. Since Mac follows Unix path and other information of that nature we typically are only concerned with whether it is Windows or Mac/Unix. If you need detailed OS information, access this by calling the getServerConfiguration() method, and then calling the getAdminProperties() method on the BBjAdminServerConfiguration instance.
    
    Throws:
    
    BBjAdminException
  - isReplicationAllowed
```
java.lang.String isReplicationAllowed()
                               throws BBjAdminException
```
    Asks the server if it is allowed to peform replication jobs.
    
    Throws:
    
    BBjAdminException
  - isRunningAdminOnlyMode
```
boolean isRunningAdminOnlyMode()
                        throws BBjAdminException
```
    Asks the server if it is currently RUNNING in admin only mode.
    
    Throws:
    
    BBjAdminException
  - isWS3Allowed
```
boolean isWS3Allowed()
              throws BBjAdminException
```
    Checks if Version 3 WebServices are available.
    
    Returns:
    
    a boolean value
    
    Throws:
    
    BBjAdminException
  - migrateToEnhancedDatabase
```
void migrateToEnhancedDatabase(java.lang.String p_sourceDatabase,
                               java.lang.String p_destinationDatabase,
                               java.lang.String p_destinationDirectory)
                        throws BBjAdminException
```
    Creates a new data dictionary in the specified format at the specified destination location using the dictionary at p_sourceDictionary. This Allows you to create a new-format data dictionary.
    
    Parameters:
    
    p_sourceDatabase -
    
    p_destinationDatabase -
    
    p_destinationDirectory -
    
    Throws:
    
    BBjAdminException
  - mountTriggerDirectory
```
void mountTriggerDirectory(java.lang.String p_fullPath)
                    throws BBjAdminException
```
    Mounts a directory to be listed when asking for a list of mounted trigger directories. See getMountedTriggerDirectories() for more information.
    
    Parameters:
    
    p_fullPath -
    
    Throws:
    
    BBjAdminException
  - newConnectionPool
```
BBjAdminConnectionPool newConnectionPool()
                                  throws BBjAdminException
```
    Returns a new connection pool definition.
    
    Throws:
    
    BBjAdminException
  - newDatabaseInstance
```
BBjAdminDatabase newDatabaseInstance(java.util.Map<java.lang.String,java.lang.Object> p_map)
                              throws BBjAdminException
```
    Returns a new, empty database instance. Call commit() on the BBjAdminDatabase instance to save the changes you make to it.
    
    Throws:
    
    BBjAdminException
  - newLDAPSearch
```
BBjAdminLDAPSearch newLDAPSearch()
                          throws BBjAdminException
```
    Returns a new, blank LDAP search instance.
    
    Throws:
    
    BBjAdminException
  - newSecurityGroup
```
BBjAdminSecurityGroup newSecurityGroup(java.lang.String p_groupName)
                                throws BBjAdminException
```
    Returns a new SecurityGroup instance.
    
    Parameters:
    
    p_groupName -
    
    Throws:
    
    BBjAdminException
  - newTask
```
BBjAdminTask newTask(BBjAdminTask.TaskType p_type)
              throws BBjAdminException
```
    Returns a new task of the specified type.
    
    Parameters:
    
    p_type -
    
    Throws:
    
    BBjAdminException
  - newTaskGroup
```
BBjAdminTaskGroup newTaskGroup()
                        throws BBjAdminException
```
    Returns a new task group from the server.
    
    Throws:
    
    BBjAdminException
  - newEmailService
```
BBjAdminEmailService newEmailService()
                              throws BBjAdminException
```
    Creates and returns a new Email Service that provides the ability to send email messages using the Admin API or easily configure various parts of the system to send notifications via email such as replication problems, etc.
    
    Returns:
    
    New Email Service instance.
    
    Throws:
    
    BBjAdminException
  - removeEmailService
```
void removeEmailService(java.lang.String p_name)
                 throws BBjAdminException
```
    Removes the specified email service configuration from the server.
    
    Parameters:
    
    p_name -
    
    Throws:
    
    BBjAdminException
  - getEmailServices
```
BBjAdminList<BBjAdminEmailService> getEmailServices()
                                             throws BBjAdminException
```
    Returns a list of the currently configured email services on the server.
    
    Returns:
    
    List of email services.
    
    Throws:
    
    BBjAdminException
  - getEmailService
```
BBjAdminEmailService getEmailService(java.lang.String p_name)
                              throws BBjAdminException
```
    Get the email service with the specified name.
    
    Parameters:
    
    p_name -
    
    Returns:
    
    The BBjAdminEmailService instance by the specified name.
    
    Throws:
    
    BBjAdminException
  - refresh
```
void refresh()
      throws BBjAdminException
```
    Refresh properties that may have changed on the server, locally changed properties will not be overridden.
    
    Throws:
    
    BBjAdminException
  - release
```
void release()
```
    Release resources held.
  - reloadDatabaseConfig
```
void reloadDatabaseConfig()
                   throws BBjAdminException
```
    Reload the Database configuration file.
    
    Throws:
    
    BBjAdminException
  - removeConnectionPool
```
void removeConnectionPool(java.lang.String p_poolName)
                   throws BBjAdminException
```
    Removes the specified connection pool from the server.
    
    Parameters:
    
    p_poolName -
    
    Throws:
    
    BBjAdminException
  - removeReplicationJob
```
void removeReplicationJob(java.lang.String p_uuid,
                          boolean p_erase)
                   throws BBjAdminException
```
    Removes the replication job identified by the specified UUID.
    
    Parameters:
    
    p_uuid -
    
    p_erase -
    
    Throws:
    
    BBjAdminException
  - removeReplicationTarget
```
void removeReplicationTarget(java.lang.String p_uuid,
                             boolean p_erase)
                      throws BBjAdminException
```
    Removes the replication target identified by the specified UUID.
    
    Parameters:
    
    p_uuid - ID for the replication target.
    
    p_erase - True if you want the target(destination) replicated files removed. False otherwise.
    
    Throws:
    
    BBjAdminException
  - removeBuiApplication
```
void removeBuiApplication(java.lang.String p_name)
                   throws BBjAdminException
```
    Removes the specified BUI application configuration.
    
    Parameters:
    
    p_name -
    
    Throws:
    
    BBjAdminException
  - removeTaskGroup
```
void removeTaskGroup(BBjAdminTaskGroup p_group)
              throws BBjAdminException
```
    Removes the specified task group from the server.
    
    Parameters:
    
    p_group -
    
    Throws:
    
    BBjAdminException
  - removeTriggers
```
void removeTriggers(java.lang.String p_filename)
             throws BBjAdminException
```
    Removes the trigger from the specified file. Does not simply disable it, but actually removes the trigger definition file for that particular file.
    
    Parameters:
    
    p_filename -
    
    Throws:
    
    BBjAdminException
  - setAdminOnlyMode
```
void setAdminOnlyMode(boolean p_adminOnly)
               throws BBjAdminException
```
    Tells the server to set itself into admin only mode the next time it is restarted. Subsequent restarts will come back in normal mode.
    
    Parameters:
    
    p_adminOnly -
    
    Throws:
    
    BBjAdminException
  - setAutorunConfiguration
```
void setAutorunConfiguration(BBjAdminAutorun p_autorun)
                      throws BBjAdminException
```
    Set the autorun configuration (not committed).
    
    Parameters:
    
    p_autorun - New autorun configuration.
    
    Throws:
    
    BBjAdminException
  - setReplicationJobEnabled
```
void setReplicationJobEnabled(java.lang.String p_replicationID,
                              boolean p_enabled)
                       throws BBjAdminException
```
    Enables/Disables the specified replication job. This is essentially a pause/resume feature that can be used to take a snapshot of the destination replicated database.
    
    Parameters:
    
    p_replicationID -
    
    p_enabled -
    
    Throws:
    
    BBjAdminException
  - setServerConfigurations
```
void setServerConfigurations(BBjAdminMap<BBjAdminServer.ServerType,BBjAdminSet<BBjAdminServer>> p_config)
                      throws BBjAdminException
```
    Set the server configuration (not committed).
    
    Parameters:
    
    p_config -
    
    Throws:
    
    BBjAdminException
  - setServerConfigurations
```
void setServerConfigurations(BBjAdminServer.ServerType p_type,
                             BBjAdminSet<BBjAdminServer> p_servers)
                      throws BBjAdminException
```
    Set the server configurations for a single type of server (not committed).
    
    Parameters:
    
    p_type -
    
    p_servers -
    
    Throws:
    
    BBjAdminException
  - setSingleUserPermissions
```
void setSingleUserPermissions(BBjAdminUserPermissions p_permissions)
                       throws BBjAdminException
```
    Set an individual user's permissions (not committed).
    
    Parameters:
    
    p_permissions -
    
    Throws:
    
    BBjAdminException
  - setTableAnalysisEnabled
```
void setTableAnalysisEnabled(java.lang.String p_database,
                             boolean p_enabled)
                      throws BBjAdminException
```
    Enables or disabled the ability to perform a table analysis on the specified database. It does not change the database configuration (this should be done with the BBjAdminDatabase object property). If BBj Services is restarted, this setting returns to the default of "true".
    
    Parameters:
    
    p_database - Name of database to enable or disable.
    
    p_enabled - True if analysis should be allowed to perform, or false to disable all analysis operations on this database.
    
    Throws:
    
    BBjAdminException
  - setTriggers
```
void setTriggers(BBjAdminTriggers p_triggers)
          throws BBjAdminException
```
    Set the trigger configuration for a file (not committed).
    
    Parameters:
    
    p_triggers -
    
    Throws:
    
    BBjAdminException
  - setUserPermissions
```
void setUserPermissions(BBjAdminSet<BBjAdminUserPermissions> p_permissions)
                 throws BBjAdminException
```
    Set permissions for a whole set of users (not committed).
    
    Parameters:
    
    p_permissions -
    
    Throws:
    
    BBjAdminException
  - shutdownBBjServices
```
void shutdownBBjServices(boolean p_waitForClients)
                  throws BBjAdminException
```
    Tells BBj Services to shutdown.
    
    Parameters:
    
    p_waitForClients - True if you want it to wait for clients to disconnect before shutting down.
    
    Throws:
    
    BBjAdminException
  - startOnlineCopyJob
```
BBjAdminOnlineCopyJobRun startOnlineCopyJob(BBjAdminOnlineCopyJobConfig p_config)
                                     throws BBjAdminException
```
    Start an online copy job. The BBjAdminOnlineCopyJobRun instance returned by this method provides access to the finish(), abort() and getProgress() methods to interact with the running job.
    
    Parameters:
    
    p_config -
    
    Throws:
    
    BBjAdminException
  - testRemoteFilesystemAccessibility
```
void testRemoteFilesystemAccessibility(java.lang.String p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       java.lang.String p_user,
                                       java.lang.String p_password)
                                throws BBjAdminException
```
    Called to test and see if the server can connect to the specified remote filesystem.
    
    Parameters:
    
    p_host -
    
    p_port -
    
    p_ssl -
    
    p_user -
    
    p_password -
    
    Throws:
    
    BBjAdminException
  - unmountTriggerDirectory
```
void unmountTriggerDirectory(java.lang.String p_fullPath)
                      throws BBjAdminException
```
    Unmounts a trigger directory. See mountTriggerDirectory() and getMountedTriggerDirectories() for more information.
    
    Parameters:
    
    p_fullPath -
    
    Throws:
    
    BBjAdminException
  - unpinAllPrograms
```
void unpinAllPrograms()
               throws BBjAdminException
```
    Unpin all programs.
    
    Throws:
    
    BBjAdminException
  - updateReplicationJob
```
void updateReplicationJob(BBjAdminReplicationJob job)
                   throws BBjAdminException
```
    Updates the replication job on the server with the same ID, with the information in the specified replication job.
    
    Parameters:
    
    job -
    
    Throws:
    
    BBjAdminException
  - createWebService
```
BBjAdminWebService createWebService()
                             throws BBjAdminException
```
    Returns a new instance of a Web service. Use commit() to save the changes to the web service.
    
    Throws:
    
    BBjAdminException
  - getJavaInfo
```
java.util.Properties getJavaInfo(java.lang.String p_javaHome,
                                 boolean p_server)
                          throws BBjAdminException
```
    Returns the information about the Java Virtual Machine located at the specified location.
    
    Parameters:
    
    p_javaHome -
    
    p_server -
    
    Throws:
    
    BBjAdminException
  - setClasspath
```
void setClasspath(java.lang.String p_cpName,
                  java.util.List<java.lang.String> p_values)
           throws BBjAdminException
```
    Sets the list of items that make up the specified named classpath. Use empty string for the default classpath or specify a valid sessions specific classpath (SSCP) name.
    
    Parameters:
    
    p_cpName -
    
    p_values -
    
    Throws:
    
    BBjAdminException
  - getClasspath
```
BBjAdminList<java.lang.String> getClasspath(java.lang.String p_cpName)
                                     throws BBjAdminException
```
    Returns the list of items that make up the specified classpath. Use empty string for the default classpath or specify a valid sessions specific classpath (SSCP) name.
    
    Parameters:
    
    p_cpName -
    
    Throws:
    
    BBjAdminException
  - getClasspathNames
```
BBjAdminList<java.lang.String> getClasspathNames()
                                          throws BBjAdminException
```
    Returns a list of the session specific classpaths on the server.
    
    Throws:
    
    BBjAdminException
  - checkUserPermission
```
boolean checkUserPermission(int p_permission)
```
    Returns true if the user logged into the API has the specified permission.
    
    Parameters:
    
    p_permission -
  - getMemoryUsageData
```
java.util.List<BBjAdminMemoryUsage> getMemoryUsageData(java.lang.String p_alternateLocation)
                                                throws BBjAdminException
```
    Throws:
    
    BBjAdminException
  - restartBBjServices
```
void restartBBjServices(boolean p_waitForClients)
                 throws BBjAdminException
```
    Tells the remote BBj Services to shutdown and restart.
    
    Parameters:
    
    p_waitForClients -
    
    Throws:
    
    BBjAdminException
  - generateWebStartCertificate
```
void generateWebStartCertificate(java.lang.String p_company,
                                 java.lang.String p_host,
                                 int p_port)
                          throws BBjAdminException
```
    Tells BBj Services to have BASIS generate the Web Start certificates on the server. This will replace any certificates already in place.
    
    Parameters:
    
    p_company - Your company or organization name that will appear to clients when they run your application.
    
    p_host - Specify the BBj application Jetty server name as seen by your clients (external to the server itself). This can be an IP address. Do not use ‘localhost’ or local IP address if clients on other computers will use Web Start to run applications on this server.
    
    p_port - Port number of the BBj Jetty web server.
    
    Throws:
    
    BBjAdminException
  - useExistingWebStartCertificate
```
void useExistingWebStartCertificate(java.lang.String p_keystore,
                                    java.lang.String p_keystorePassword,
                                    java.lang.String p_privateKey,
                                    java.lang.String p_privateKeyPassword)
                             throws BBjAdminException
```
    Configures BBj Services to use the specified certificate for Web start applications.
    
    Parameters:
    
    p_keystore -
    
    p_keystorePassword -
    
    p_privateKey -
    
    p_privateKeyPassword -
    
    Throws:
    
    BBjAdminException
  - getDocumentIndexes
```
BBjAdminList<BBjAdminDocumentIndex> getDocumentIndexes()
                                                throws BBjAdminException
```
    Returns a list of all the document indexes available on the server. A document index is one or more directories and filters that are monitored for new or modified documents. All documents in a monitored directory that match a filter will be indexed in one of the supported index types such as Lucene or elasticsearch.
    
    Returns:
    
    List of all the document indexes on the server.
    
    Throws:
    
    BBjAdminException
  - getDocumentIndex
```
BBjAdminDocumentIndex getDocumentIndex(java.lang.String p_name)
                                throws BBjAdminException
```
    Returns a document index for the specified name. A document index is one or more directories and filters that are monitored for new or modified documents. All documents in a monitored directory that match a filter will be indexed in one of the supported index types such as Lucene or elasticsearch.
    
    Parameters:
    
    p_name - The name of the document index to retrieve.
    
    Returns:
    
    The index or null if not found.
    
    Throws:
    
    BBjAdminException
  - createDocumentIndex
```
BBjAdminDocumentIndex createDocumentIndex(java.lang.String p_name,
                                          java.lang.String p_type)
                                   throws BBjAdminException
```
    Creates a new BBjAdminDocumentIndex with the given name. If the name is already in use it will throw an exception.
    
    Parameters:
    
    p_name - Name of the document index. Must be unique to the server.
    
    p_type - Type of index. Use one of the types from BBjAdminDocumentIndex.
    
    Returns:
    
    New BBjAdminDocumentIndex with the given name.
    
    Throws:
    
    BBjAdminException - If there is a problem or if the name is already in use.
  - dropDocumentIndex
```
void dropDocumentIndex(java.lang.String p_name)
                throws BBjAdminException
```
    Drops the specified document index.
    
    Parameters:
    
    p_name - Name of the document index to drop.
    
    Throws:
    
    BBjAdminException
  - createAsynchTriggerJob
```
BBjAdminAsynchTriggerJob createAsynchTriggerJob(java.lang.String p_name,
                                                java.lang.String p_address,
                                                int p_port,
                                                double p_kbps,
                                                boolean p_ssl,
                                                java.lang.String p_user,
                                                java.lang.String p_password,
                                                java.lang.String p_workingDir,
                                                java.lang.String p_config,
                                                boolean p_useDefaultAlias,
                                                java.lang.String p_writeProgram,
                                                java.lang.String p_removeProgram)
                                         throws BBjAdminException
```
    Creates a new asynchronous trigger job. See getAsynchTriggerJobs() for complete details on asynchronous trigger jobs.
    
    Parameters:
    
    p_name - Name of the job to display in the Enterprise Manager.
    
    p_address - Host name or IP address of the BBj Services installation to use as a target for this job.
    
    p_port - Port number of the Filesystem Server running on the specified BBj Services installation.
    
    p_kbps - Bandwidth in KBPS that the system should be allowed to use for processing job operations. If zero, it will use all that it needs to.
    
    p_ssl - True if the Filesystem Server of the target is configured to use SSL or false otherwise.
    
    p_user - User to use to connect to the job's target machine.
    
    p_password - Password for the user.
    
    p_workingDir - Optional working directory to use when executing the configured BBj write/remove programs.
    
    p_config - Optional location of the config.bbx file used by the interpreter running the BBj write/remove programs.
    
    p_useDefaultAlias -
    
    p_writeProgram - Absolute path to the location of the program to be executed when any write operation occurs on a monitored file.
    
    p_removeProgram - Absolute path to the location of the program to be executed when any remove operation occurs on a monitored file.
    
    Returns:
    
    Instance of a new BBjAdminAsynchTriggerJob.
    
    Throws:
    
    BBjAdminException
  - getAsynchTriggerJobs
```
BBjAdminList<BBjAdminAsynchTriggerJob> getAsynchTriggerJobs()
                                                     throws BBjAdminException
```
    Returns a list of all the asynchronous trigger jobs currently configured on the system. An asynchronous trigger job consists of a list of directories and/or files to monitor for changes, a BBj program to be run when a monitored file is written to, and another program to execute when a file has a record removed from it.
    
    These triggers differ from standard file triggers in that the file operation does not wait for the trigger operation to complete, before continuing. This means there is almost no overhead on the file system. Further, these triggers can be configured to run on a remote BBj Services installation to allow the administrator to distribute the interpreter workload to another machine.
    
    Returns:
    
    List of all the asynchronous trigger jobs.
    
    Throws:
    
    BBjAdminException
  - getAsynchTriggerTargets
```
BBjAdminList<BBjAdminAsynchTriggerTarget> getAsynchTriggerTargets()
                                                           throws BBjAdminException
```
    Returns a list of all the asynchronous trigger job targets on this machine. See getAsynchTriggerJobs() for information about asynchronous triggers.
    
    Returns:
    
    List of all the asynchronous trigger job targets on this machine.
    
    Throws:
    
    BBjAdminException
  - uploadSupportFiles
```
java.lang.String uploadSupportFiles(BBjAdminSet<java.lang.String> p_files,
                                    BBjAdminMap<java.lang.String,java.lang.String> p_properties)
                             throws BBjAdminException
```
    Send the specified list of files to support. The list of files from the server will be zipped up, server side, and sent to the support upload site. It will include information such as the sender email address, attention of email, support incident ID and a message.
    
    Parameters:
    
    p_properties -
    
    Returns:
    
    Unique identifier for this upload job. This ID will be used to check progress.
    
    Throws:
    
    BBjAdminException
  - getSupportUploadJob
```
BBjAdminSupportUploadJob getSupportUploadJob(java.lang.String p_uploadId)
                                      throws BBjAdminException
```
    Returns an instance of BBjAdminSupportUploadJob containing the information about the current status of the specified upload job ID.
    
    Parameters:
    
    p_uploadId -
    
    Throws:
    
    BBjAdminException
  - getSupportUploadJobs
```
BBjAdminList<BBjAdminSupportUploadJob> getSupportUploadJobs()
                                                     throws BBjAdminException
```
    Returns a list of all the currently running support upload jobs.
    
    Throws:
    
    BBjAdminException
  - abortSupportUploadJob
```
void abortSupportUploadJob(java.lang.String p_uploadId)
                    throws BBjAdminException
```
    Cancels the specified support upload job.
    
    Parameters:
    
    p_uploadId -
    
    Throws:
    
    BBjAdminException
  - acceptLdapCertificate
```
void acceptLdapCertificate(java.lang.String p_certificate)
                    throws BBjAdminException
```
    Called to accept the LDAP certificate and add it to the accepted certificate list.
    
    Parameters:
    
    p_certificate -
    
    Throws:
    
    BBjAdminException
  - getFileOpenInfo
```
BBjAdminMap<BBjAdminFileOpenInfoKey,BBjAdminFileOpenInfoValue> getFileOpenInfo()
                                                                        throws BBjAdminException
```
    Returns the file open statistics gathered when a file is opened. These stats contain information about the prefix examined during the open and the path that it decided to use to open the file. This information is not persisted through BBjServices restart but only contained in memory.
    
    Throws:
    
    BBjAdminException
  - clearFileOpenInfo
```
void clearFileOpenInfo()
                throws BBjAdminException
```
    Clears the file open statistics gathered when a file is opened. These stats contain information about the prefix examined during the open and the path that it decided to use to open the file. This information is not persisted through BBjServices restart but only contained in memory.
    
    Throws:
    
    BBjAdminException
  - testJdbcConnection
```
void testJdbcConnection(java.lang.String p_driver,
                        java.lang.String p_url,
                        java.lang.String p_user,
                        java.lang.String p_password)
                 throws BBjAdminException
```
    Tests connecting with the specified JDBC driver, URL, user and password from the server. This is generally used to test linked database connection information.
    
    Parameters:
    
    p_driver -
    
    p_url -
    
    p_user -
    
    p_password -
    
    Throws:
    
    BBjAdminException
  - getEventManager
```
BBjAdminEventManager getEventManager()
                              throws BBjAdminException
```
    The event manager manages the system events that may occur on the server. There are numerous types of events that can be configured. Events will optionally notify a specified program or send an email notification through a configured email service (see getEmailServices() method). Each type of event may have different configuration options since each event is unique in its requirements. The available events cannot be modified, only the settings of those events returned by calling this method.
    
    Returns:
    
    The event manager from the server.
    
    Throws:
    
    BBjAdminException
  - updateEventManager
```
void updateEventManager(BBjAdminEventManager p_manager)
                 throws BBjAdminException
```
    Throws:
    
    BBjAdminException
  - exportReplicationJob
```
void exportReplicationJob(BBjAdminReplicationJob p_job,
                          java.lang.String p_filename)
                   throws BBjAdminException
```
    Exports the replication job in a format that can then be read in using the import() method. This provides a means for creating an exported replication job that can be imported into another installation.
    
    Parameters:
    
    p_job - Replication job to export.
    
    p_filename - Full path to the replication job export file. The path will be server side.
    
    Throws:
    
    BBjAdminException
  - importReplicationJob
```
BBjAdminReplicationJob importReplicationJob(java.lang.String p_filename,
                                            java.lang.String p_user,
                                            java.lang.String p_password)
                                     throws BBjAdminException
```
    Loads the contents of a replication job export file into the object. Note that this file must be located on the BBjServices machine and the path specified should be the path on that machine, as opposed to a client machine.
    
    Parameters:
    
    p_filename -
    
    Throws:
    
    BBjAdminException
  - jsonExecute
```
java.lang.String jsonExecute(java.lang.String json)
                      throws BBjAdminException
```
    Executes some server-side processing defined by the supplied JSON string. The result should be another JSON string.
    
    Parameters:
    
    json -
    
    Returns:
    
    a JSON String
    
    Throws:
    
    BBjAdminException
  - getConfigCommits
```
java.util.List<BBjAdminGitCommit> getConfigCommits(int startDate,
                                                   int endDate)
                                            throws BBjAdminException
```
    Returns a list of the config directory commits that have occurred during the optional range of dates.
    
    Parameters:
    
    startDate - Number of seconds since the epoch start time range or zero for none.
    
    endDate - Number of seconds since the epoch end time range or zero for none.
    
    Throws:
    
    BBjAdminException
  - hardResetConfigCommit
```
void hardResetConfigCommit(java.lang.String p_commitId,
                           java.lang.String p_name,
                           java.lang.String p_email)
                    throws BBjAdminException
```
    Performs a hard reset of the configuration, returning it to the specified commit ID state. The directory will return to the exact state it was in at the time of the specified commit so any uncommitted changes to files will be lost.
    
    Parameters:
    
    p_commitId - ID of the Git commit to which the state of the directory should return.
    
    p_name - Name of the user committing the changes or null to use the default.
    
    p_email - Email address of the user committing the changes or null to use the default.
    
    Throws:
    
    BBjAdminException
  - getConfigCommitDiffText
```
java.lang.String getConfigCommitDiffText(java.lang.String p_commitId1,
                                         java.lang.String p_commitId2)
                                  throws BBjAdminException
```
    Returns the Git diff patch text between two commits.
    
    Parameters:
    
    p_commitId1 -
    
    p_commitId2 -
    
    Throws:
    
    BBjAdminException
  - commit
```
void commit(java.lang.String p_message)
     throws BBjAdminException
```
    Specify a specific commit message that will accompany the commit to the configuration Git archive.
    
    Parameters:
    
    p_message - Message to accompany the commit.
    
    Throws:
    
    BBjAdminException
  - getStartTime
```
java.lang.String getStartTime()
                       throws BBjAdminException
```
    Returns the time that the currently running BBjServices was started as a formatted timestamp string including the timezone.
    
    Throws:
    
    BBjAdminException
  - getLicenseFeatureInfo
```
BBjAdminLicenseFeatureInfo getLicenseFeatureInfo(java.lang.String p_feature)
                                          throws BBjAdminException
```
    Returns the license information for the specified feature.
    
    Parameters:
    
    p_feature -
    
    Throws:
    
    BBjAdminException
  - getAllLicenseFeatureInfo
```
java.util.List<BBjAdminLicenseFeatureInfo> getAllLicenseFeatureInfo()
                                                             throws BBjAdminException
```
    Returns a list of BBjAdminLicenseFeatureInfo object for each feature the license uses.
    
    Throws:
    
    BBjAdminException
  - getJarIndexJars
```
java.util.List<java.lang.String> getJarIndexJars(java.lang.String p_jarFilePath)
                                          throws BBjAdminException
```
    Returns a list of the jars referenced in a JarIndex if one is present in the specified jar file. To be completely honest, it is highly unlikely anyone will ever use this method outside the BBj Enterprise Manager user interface as this information is not particularly useful in other contexts.
    
    Parameters:
    
    p_jarFilePath - Full path to the jar file to examine.
    
    Returns:
    
    List of jars present in the INDEX.LIST file within the specified jar if such file exists.
    
    Throws:
    
    BBjAdminException

Interface BBjAdminBase

Java Sample

BBj Sample

Field Summary

Method Summary

Methods inherited from interface com.basis.api.admin.BBjAdminCommitPropertyWriter

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

Methods inherited from interface com.basis.api.admin.BBjAdminCommitWriter

Field Detail

LOG

PERMISSION_ATTACH_EXISTING_DB

PERMISSION_CREATE_NEW_DB

PERMISSION_DELETE_DB

PERMISSION_ADD_USER

PERMISSION_DELETE_USER

PERMISSION_SET_PERMISSIONS

PERMISSION_SET_PASSWORDS

PERMISSION_PROCESSES

PERMISSION_OPEN_FILES

PERMISSION_JDBC_CONNECTIONS

PERMISSION_SERVER_CONFIG

PERMISSION_ALLOW_ADMIN

PERMISSION_CREATE_NEW_TRIGGER

PERMISSION_CONNECTION_POOLS

PERMISSION_COPY_JOBS

PERMISSION_TABLE_ANALYSIS_QUEUE

PERMISSION_CLOSE_FILES

PERMISSION_REPLICATION

PERMISSION_SCHEDULING

PERMISSION_AUDITING

PERMISSION_ASYNCH_TRIGGER

PERMISSION_DOCUMENT_INDEXES

PERMISSION_EMAIL_SERVICES

PERMISSION_METRICS

PERMISSION_ALLOW_ALL

SUPPORT_UPLOAD_SENDER_EMAIL

SUPPORT_UPLOAD_COMPANY

SUPPORT_UPLOAD_SUPPORT_INCIDENT_ID

Method Detail

addReplicationJob

addUser

attachDatabaseOnDisk

attachDatabaseOnDisk

changePassword

clearCache

createAuditReplicationJob

createBBjAdminList

createBBjAdminMap

createBBjAdminSet

createBBjReplicationJob

createBBjReplicationJob

createBBjReplicationJob

createBBjReplicationJob

createDatabaseOnDisk

createDirectory

createOnlineCopyJobConfig

createOnlineCopyJobConfig

createServerConfiguration

createBuiApplication

createRemoteApplication

createSQLReplicationJob

dropDatabase

dropUser

dropSecurityGroup

dumpHeap

dumpThreads

getAbsolutePath

getAuditDatabase

getAuditJobs

getAuditTargets

getAutorunConfiguration

getAvailableSystemPermissions

getBBjFile

getBBjFileRecord

getBBjProcess

getBBjProcesses

getBBjProperties

getBBjPropertiesFile

getBuiConfiguration