Package com.basis.api.admin.internal

Class BBjAdminRemoteWrapper

java.lang.Object

com.basis.api.admin.internal.BBjAdminRemoteWrapper

All Implemented Interfaces:

BBjAdminBase, BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Serializable, Remote

public class BBjAdminRemoteWrapper
extends Object
implements BBjAdminBase

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.basis.api.admin.BBjAdminBase

FILTER_OP_CONTAINS, FILTER_OP_EQ, FILTER_OP_GT, FILTER_OP_LT, FILTER_OP_REGEX, LOG, OPEN_FILE_FILTER_ADVISORY, OPEN_FILE_FILTER_EXTRACTED, OPEN_FILE_FILTER_FILENAME, OPEN_FILE_FILTER_IP_ADDRESS, OPEN_FILE_FILTER_LOCKED, OPEN_FILE_FILTER_MESSAGE, OPEN_FILE_FILTER_OPEN_ID, OPEN_FILE_FILTER_OPEN_TYPE, OPEN_FILE_FILTER_READ_ONLY, OPEN_FILE_FILTER_USER, PERMISSION_ADD_USER, PERMISSION_ALLOW_ADMIN, PERMISSION_ALLOW_ALL, PERMISSION_ASYNCH_TRIGGER, PERMISSION_ATTACH_EXISTING_DB, PERMISSION_AUDITING, PERMISSION_CLOSE_FILES, PERMISSION_CONNECTION_POOLS, PERMISSION_COPY_JOBS, PERMISSION_CREATE_NEW_DB, PERMISSION_CREATE_NEW_TRIGGER, PERMISSION_DELETE_DB, PERMISSION_DELETE_USER, PERMISSION_DOCUMENT_INDEXES, PERMISSION_EMAIL_SERVICES, PERMISSION_JDBC_CONNECTIONS, PERMISSION_METRICS, PERMISSION_OPEN_FILES, PERMISSION_PROCESSES, PERMISSION_REPLICATION, PERMISSION_SCHEDULING, PERMISSION_SERVER_CONFIG, PERMISSION_SET_PASSWORDS, PERMISSION_SET_PERMISSIONS, PERMISSION_TABLE_ANALYSIS_QUEUE, SUPPORT_UPLOAD_COMPANY, SUPPORT_UPLOAD_SENDER_EMAIL, SUPPORT_UPLOAD_SUPPORT_INCIDENT_ID

Constructor Summary

Constructors

Constructor	Description
BBjAdminRemoteWrapper(BBjAdminBase p_wrapped, Socket p_socket)

Method Summary

Modifier and Type	Method	Description
void	abortSupportUploadJob(String p_uploadId)	Cancels the specified support upload job.
void	acceptLdapCertificate(String p_certificate)	Called to accept the LDAP certificate and add it to the accepted certificate list.
void	addReplicationJob(BBjAdminReplicationJob p_job)	Add the specified replication job to the list of running jobs.
void	addType(String p_property, BBjAdminType p_type)	Adds a type for the specified property if this object was created with the ability to add new properties.
BBjAdminUserPermissions	addUser(String p_user, String p_password)	Create a new user (committed).
BBjAdminDatabase	attachDatabaseOnDisk(String p_name, String p_dictionary)	Attach to an existing database on disk.
BBjAdminDatabase	attachDatabaseOnDisk(String p_name, String p_dictionary, boolean p_errorOnBadDictionary)	Attach to an existing database on disk.
boolean	canAddNewProperties()	Is the user allowed to add new properties?
boolean	canClear()	Is the user allowed to clear properties?
void	changePassword(String p_user, String p_password)	Change user password.
boolean	check2FACode(String p_secretKey, String p_code, long p_validitySeconds)	Checks to see if the specified code is valid given the specified secret key and the validity in seconds used to generate the secret key.
boolean	checkUserPermission(int p_permission)	Returns true if the user logged into the API has the specified permission.
boolean	checkValueEqual(String p_property, Object p_value)	Is the provided value equal to the current value (if any)?
void	clear()	Clear all properties that are not read only.
void	clearCache()	Clear the BBj program cache.
void	clearFileOpenInfo()	Clears the file open statistics gathered when a file is opened.
boolean	clearProperties(Set<String> p_properties)	Clear a set of properties.
boolean	clearProperty(String p_property)	Clear out the value of a property.
void	commit()	Commit all property changes.
void	commit(String p_message)	Specify a specific commit message that will accompany the commit to the configuration Git archive.
boolean	contains(String p_property)	Does a given property exist?
boolean	contains(Set<String> p_properties)	Do any of a set of properties exist?
void	convertFiles(String[] p_files, int p_targetType)	Converts the list of full paths to files on the BBjServices server to the specified file type.
void	copyDictionaryToTarget(String p_sourceDb, String p_targetDirectory, String p_targetHost, int p_targetPort, boolean p_targetSsl, String p_targetAuthToken)	Copies all the data dictionary files from the source database to the target directory.
BBjAdminAsynchTriggerJob	createAsynchTriggerJob(String p_name, String p_address, int p_port, double p_kbps, boolean p_ssl, String p_user, String p_pwd, String p_workingDir, String p_config, boolean p_useDefaultAlias, String p_writeProgram, String p_removeProgram)	Creates a new asynchronous trigger job.
BBjAdminAsynchTriggerJob	createAsynchTriggerJob(String p_name, String p_user, String p_pwd, String p_workingDir, String p_config, boolean p_useDefaultAlias, String p_writeProgram, String p_removeProgram)	Creates a new asynchronous trigger job that will run on the same machine.
BBjAdminAuditReplicationJob	createAuditReplicationJob(String p_name, 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(String p_name, boolean p_synchronous)	Creates a new BBj replication job.
BBjAdminBBjReplicationJob	createBBjReplicationJob(String p_name, String p_address, int p_port, boolean p_ssl, String p_user, String p_pwd, boolean p_synchronous)	Creates a new BBj replication job with the specified configuration info.
BBjAdminBBjReplicationJob	createBBjReplicationJob(String p_name, String p_address, int p_port, double p_kbps, boolean p_ssl, String p_user, String p_pwd, boolean p_synchronous)	Creates a new BBj replication job with the specified configuration info.
BBjAdminBBjReplicationJob	createBBjReplicationJob(String p_name, String p_address, int p_port, double p_kbps, boolean p_ssl, String p_user, String p_pwd, boolean p_synchronous, String p_eventHandlerProgram, String p_eventHandlerUser, String p_eventHandlerPassword, String p_eventHandlerConfig, String p_eventHandlerWorkingDir, String p_eventHandlerClasspath, String p_eventEmailService, String p_eventEmailRecipients)	Creates a new BBj replication job with the specified configuration info.
BBjAdminBuiApplication	createBuiApplication()	Create a new BUI application configuration.
BBjAdminDatabase	createDatabaseOnDisk(String p_name, String p_dictionary, BBjAdminDatabase.DatabaseType p_type)	Create a new database and create the data dictionary files.
void	createDirectory(String p_fullPath, boolean p_recursive)	Creates the specified directory on the server.
BBjAdminDocumentIndex	createDocumentIndex(String p_name, String p_type)	Creates a new BBjAdminDocumentIndex with the given name.
String	createDownloadPackage(List<String> p_files)	Used to combine the specified list of files into a zip file that can be downloaded from the returned URL.
BBjAdminOnlineCopyJobConfig	createOnlineCopyJobConfig()	Create an empty OnlineCopyJob.
BBjAdminOnlineCopyJobConfig	createOnlineCopyJobConfig(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(String p_name, boolean p_deleteAllFiles)	Drop a database by name, optionally deleting all files.
void	dropDocumentIndex(String p_name)	Drops the specified document index.
void	dropSecurityGroup(String p_group)	Drops the specified security group (committed).
void	dropUser(String p_user)	Drop a user (committed).
void	dumpHeap()	Dump the memory heap to the log.
void	dumpProperties()	Dump the properties currently in memory to a file in the log directory.
void	dumpThreads()	Dump JVM threads to the log.
void	duplicateDatabaseConfig(String p_sourceDb, String p_newName)	Creates a copy of the specified database configuration.
void	exportReplicationJob(BBjAdminReplicationJob p_job, String p_filename)	Exports the replication job in a format that can then be read in using the import() method.
int	forceCloseOpenFiles(String p_filenameMatchRegex, Map<String,String> p_modeMatchRegex)	Forces any open files matching the p_filenameMatchRegex value (null means ignore this match) and/or open files with MODE information matching p_modeMatchRegex.
String	generate2FASecretKey()	Generates a secret key to use for TOTP and the Google Authenticator app.
String	generateKeyPair(String p_user, String p_description)	Generates a public/private key pair.
void	generateWebStartCertificate(String p_company, String p_host, int p_port)	Tells BBj Services to have BASIS generate the Web Start certificates on the server.
String	get2FACode(String p_secretKey, long p_validitySeconds)	Generates a new TOTP code based on the secret key and validity in seconds.
String	getAbsolutePath(String p_filename)	Returns the absolute path for the specified file or directory as a string.
Set<BBjAdminTokenInfo>	getActiveTokens()	Returns all the information about active authorization tokens.
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(String p_dbRoot)
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(String p_parent)	Returns a BBjAdminBBjFile for the specified full path.
byte[]	getBBjFileRecord(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(String p_id)	Returns the BBjAdminBBjProcess for the specified ID.
List<BBjAdminBBjProcess>	getBBjProcesses()	Get the set of BBj processes (read-only).
Properties	getBBjProperties()	Returns a Map containing all the properties and their values found in the BBj.properties file.
String	getBBjPropertiesFile()	Returns a read-only copy of the contents of the BBj.properties file.
boolean	getBoolean(String p_property)	Get a boolean value for a property.
BBjAdminBuiConfiguration	getBuiConfiguration()	Returns the configuration object for managing the BUI applications and settings on the server.
Map<String,Object>	getChangedProperties()	Get the changed properties.
BBjAdminList<String>	getClasspath(String p_cpName)	Returns the list of items that make up the specified classpath.
BBjAdminList<String>	getClasspathNames()	Returns a list of the session specific classpaths on the server.
Set<String>	getClearedProperties()	Get the set of cleared properties.
BBjAdminClientBBjProcess	getClientBBjProcess(String p_id)	Returns the BBjAdminBBjProcess for the specified ID.
List<BBjAdminClientBBjProcess>	getClientBBjProcesses()	Get the set of BBj processes (read-only).
List<BBjAdminClientOpenFile>	getClientOpenFiles()	Get the list of open files (read-only).
List<BBjAdminClientOpenFile>	getClientOpenFiles(int p_field, int p_operator, String p_value)	Get the list of open files (read-only).
List<BBjAdminClientReplicationJob>	getClientReplicationJobs()	Returns a list of the replication jobs currently running on the system.
String	getConfigCommitDiffText(String p_commitId1, String p_commitId2)	Returns the Git diff patch text between two commits.
List<BBjAdminGitCommit>	getConfigCommits(int p_startDate, int p_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(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(String p_name)	Get a single existing database.
Set<String>	getDatabaseNames()	Get the names of all accessible databases.
BBjAdminSet<BBjAdminDatabase>	getDatabases()	Get all accessible databases.
BBjAdminDocumentIndex	getDocumentIndex(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.
double	getDouble(String p_property)	Get a double value for a property.
BBjAdminEmailService	getEmailService(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(String p_parent)	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(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.
int	getInt(String p_property)	Get an integer value for a property.
List<String>	getJarIndexJars(String p_jarFilePath)	Returns a list of the jars referenced in a JarIndex if one is present in the specified jar file.
Properties	getJavaInfo(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.
String	getKeyTemplateForFile(String p_filename, int p_keyNum)	Returns a string template (if one can be found) for the specified data file defining the layout of the key specified in p_keyNum.
BBjAdminLanguageServer	getLanguageServer()	Returns the configuration information for the BBj Language Server.
BBjAdminLicenseFeatureInfo	getLicenseFeatureInfo(String p_feature)	Returns the license information for the specified feature.
BBjAdminLicenseInformation	getLicenseInformation()	Returns information about the license used by BBjServices.
BBjAdminList	getList(String p_property)	Get a BBjAdminList value for a property.
String	getLocaleString()	Returns the Locale as a string.
long	getLong(String p_property)	Get a long value for a property.
List<BBjAdminMemoryUsage>	getMemoryUsageData(String p_alternateLocation)
BBjAdminList<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(String p_id)	Get the open file (read-only) with the specified ID.
List<BBjAdminOpenFile>	getOpenFiles()	Get the set of open files (read-only).
Map<String,Object>	getOriginalProperties()	Get the original properties list.
List<BBjAdminClientOSFile>	getOSFiles(BBjAdminClientOSFile p_parent, String[] p_filenameFilter, Date p_modifiedFilterStart, Date p_modifiedFilterEnd)	Returns a list of files from the operating system.
String	getPassword()	Get the password of the user who got this BBjAdmin instance.
Map<String,Object>	getProperties()	Get a copy of all properties.
List<BBjAdminPublicKey>	getPublicKeys()	Returns a list of all the public key info available on the server for all users.
List<BBjAdminPublicKey>	getPublicKeys(String p_username)	Returns a list of all the public key info available on the server for the specified user.
Set<String>	getReadOnly()	Set the complete set of read-only properties.
BBjAdminAppDeploymentConfiguration	getRemoteConfiguration()	Returns the configuration object for managing the remote-launch applications (including BUI) and settings on the server.
BBjAdminReplicationJob	getReplicationJob(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<String>	getRoots()	Returns a list of all the roots or drives on the machine.
BBjAdminList<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.
List<BBjAdminServerConfig>	getServices()	Get the services configurations.
BBjAdminUserPermissions	getSingleUserPermissions(String p_user)	Get the permissions for a single user.
BBjAdminSet<BBjAdminSQLConnection>	getSQLConnections()	Get the set of SQL connections (read-only).
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.
String	getString(String p_property)	Get a String value for a property.
BBjAdminSupportUploadJob	getSupportUploadJob(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.
String	getSystemProperty(String p_property, 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.
String	getTemplateForFile(String p_filename)	Returns a string template (if one can be found) for the specified data file.
String	getTextFileContents(String p_fullPath)	Returns the contents of the specified file from the remote machine as a string.
BBjAdminTokenInfo	getTokenInfo(String p_tokenOrTokenId)	Takes the specified token and returns the BBjAdminTokenInfo object containing the payload for the token.
String	getTokenValue()	Returns the authorization token that was used to acquire this connection to the Admin API.
long	getTotalSpace(String p_path)	Returns the total space available on the specified root or drive.
BBjAdminTriggers	getTriggers(String p_filename)	Get the trigger configuration for a file.
BBjAdminType	getType(String p_property)	Get the value type of a property.
Map<String,BBjAdminType>	getTypes()	Get a copy of all of the type information.
String	getUser()	Get the name of the user who got this BBjAdmin instance.
BBjAdminUser	getUserInfo(String p_user)	Returns additional user info for the specified user.
List<String>	getUserNames()	Get the names of users.
BBjAdminList<BBjAdminUserPermissions>	getUserPermissions()	Get the permissions for all users.
List<BBjAdminUser>	getUsers()	Returns a list of all users including their additional info such as name, email, etc.
Object	getValue(String p_property)	Get a object value for a property.
BBjAdminWebAppServer	getWebAppServer()	Get the Web App Server configuration.
BBjAdminWebService	getWebService(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(String p_id, String p_name, String p_email)	Performs a hard reset of the configuration, returning it to the specified commit ID state.
boolean	hasChanged()	Have properties been changed?
BBjAdminReplicationJob	importReplicationJob(String p_filename, String p_user, String p_password)	Loads the contents of a replication job export file into the object.
void	invalidateToken(String p_tokenOrTokenId)	Invalidates the specified token.
boolean	isAddressSameAsServer(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.
String	isFulltextIndexesAllowed()	Returns whether FULLTEXT indexes are allowed on this BBj Services installation.
boolean	isOSWindows()	Returns true if the server side OS is MS Windows of some type.
boolean	isReadOnly(String p_property)	Is a given property read-only.
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	isSAM()	Checks to verify that the server has a valid Software Asset Management license available.
boolean	isServiceRunning(BBjAdminServerConfig p_config)	Returns true if the specified service is running.
boolean	isSqlServerSecure()	Returns true or false as to whether the SQL engine server is using SSL.
boolean	isUser2FA(String p_user)	Checks to see if the specified user is using TOTP 2 factor authentication.
boolean	isWebUiAvailable()	Returns true if the WebUI functionality was installed with BBj.
boolean	isWebUiEnabled()	Returns true if the WebUI functionality is enabled on the server.
boolean	isWebUiLicensed()	Returns true if the BBjServices installation has a valid WEBUI license.
boolean	isWS3Allowed()	Checks if Version 3 WebServices are available.
String	jsonExecute(String p_json)	Executes some server-side processing defined by the supplied JSON string.
void	migrateToEnhancedDatabase(String p_sourceDictionary, String p_destinationDatabase, 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(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(Map<String,Object> p_properties)	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(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	notifyAllProcesses(String p_message, String p_title)	Sends a notification to all running processes where it will pop up a message box to display to display the provided message and title to the user of that process.
void	notifyProcess(int p_id, String p_message, String p_title)	Sends a notification to the specified process where it will pop up a message box to display to display the provided message and title to the user of that process.
void	receiveDictionaryFiles(byte[] p_bytes, String p_targetDirectory)
void	reconfigureServices()	This method can be called to reconfigure the services.
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	removeAllPublicKeys(String p_username)	Removes all the public keys for the specified user.
void	removeAsynchTriggerJob(String p_uuid)	Removes the asynchronous trigger job identified by the specified UUID or name.
void	removeBuiApplication(String p_name)	Removes the specified BUI application configuration.
void	removeConnectionPool(String p_poolName)	Removes the specified connection pool from the server.
void	removeEmailService(String p_name)	Removes the specified email service configuration from the server.
void	removePublicKey(String p_username, String p_publicKeyId)	Removes the specified public key if present.
void	removeReplicationJob(String p_uuid, boolean p_erase)	Removes the replication job identified by the specified UUID or name.
void	removeReplicationTarget(String p_uuid, boolean p_erase)	Removes the replication target identified by the specified UUID.
void	removeService(BBjAdminServerConfig p_service)	Removes the specified service configuration.
void	removeTaskGroup(BBjAdminTaskGroup p_group)	Removes the specified task group from the server.
void	removeTriggers(String p_filename)	Removes the trigger from the specified file.
void	removeWebService(String p_name)	Removes the specified web service from the server.
String	renewToken(long p_duration)	Renews the current token for that Admin API connection setting the duration of validity to the value specified in p_duration.
String	renewToken(long p_duration, boolean p_invalidateOld)	Renews the current token for that Admin API connection setting the duration of validity to the value specified in p_duration.
String	renewToken(String p_token, long p_duration)	Renews the current token for that Admin API connection setting the duration of validity to the value specified in p_duration.
void	restartBBjServices(boolean p_waitForClients)	Tells the remote BBj Services to shutdown and restart.
void	rollback()	Roll back all property changes.
boolean	send2FACode(String p_user)	Sends the specified user a 2-factor authentication code via email.
void	send2FASetupEmail(String p_subject, Set<String> p_usernames)	Once 2-factor authorization is enabled in the EM or Admin API, this call will send an email to each user in the specified list of usernames with any setup instructions (e.g.
void	setAdminOnlyMode(boolean p_adminOnly)	Tells the server to set itself into admin only mode the next time it is restarted.
void	setAutoRenewToken(boolean p_autorenew)
void	setAutorunConfiguration(BBjAdminAutorun p_autorun)	Set the autorun configuration (not committed).
void	setBoolean(String p_property, boolean p_value)	Set the boolean value of a property.
void	setClasspath(String p_cpName, List<String> p_values)	Sets the list of items that make up the specified named classpath.
void	setDouble(String p_property, double p_value)	Set the double value of a property.
void	setInt(String p_property, int p_value)	Set the integer value of a property.
void	setLanguageServerConfiguration(BBjAdminLanguageServer p_service)	Updates the configuration for the BBj Language Server.
void	setList(String p_property, BBjAdminList p_value)	Set the BBjAdminList value of a property.
void	setLong(String p_property, long p_value)	Set the long value of a property.
void	setProperties(Map<String,Object> p_properties)	Set properties as a group from a Map.
void	setReplicationJobEnabled(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	setServices(List<BBjAdminServerConfig> p_configs)	Sets the services configurations.
void	setSingleUserPermissions(BBjAdminUserPermissions p_permissions)	Set an individual user's permissions (not committed).
void	setString(String p_property, String p_value)	Set the String value of a property.
void	setTableAnalysisEnabled(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	setUser2FASettings(String p_user, String p_secretKey, boolean p_enabled)	Enables/disables TOTP 2 factor authentication for the specified user.
void	setUserInfo(BBjAdminUser p_info)	Sets additional user info such as first/last/middle name, email, text number, etc.
void	setUserInfo(List<BBjAdminUser> p_infos)	Sets additional user info such as first/last/middle name, email, text number, etc.
void	setUserPermissions(BBjAdminSet<BBjAdminUserPermissions> p_permissions)	Set permissions for a whole set of users (not committed).
void	setValue(String p_property, Object p_value)	Set the object value of a property.
void	shutdownBBjServices(boolean p_waitForClients)	Tells BBj Services to shutdown.
void	startDatabaseReloadHelper(String p_dbName)
void	startLanguageServer()	Start the BBj Language Server using the current configuration.
BBjAdminOnlineCopyJobRun	startOnlineCopyJob(BBjAdminOnlineCopyJobConfig p_config)	Start an online copy job.
void	startService(BBjAdminServerConfig p_config)	Starts the specified service if not running.
void	stopLanguageServer()	Stop the BBj Language Server.
void	stopService(BBjAdminServerConfig p_config)	Stops the specified service if running.
void	testJdbcConnection(String p_driver, String p_url, String p_user, String p_password)	Tests connecting with the specified JDBC driver, URL, user and password from the server.
void	testRemoteFilesystemAccessibility(String p_host, int p_port, boolean p_ssl, String p_user, String p_password)	Called to test and see if the server can connect to the specified remote filesystem.
void	unmountTriggerDirectory(String p_fullPath)	Unmounts a trigger directory.
void	unpinAllPrograms()	Unpin all programs.
void	updateEventManager(BBjAdminEventManager p_manager)
void	updateReplicationJob(BBjAdminReplicationJob p_job)	Updates the replication job on the server with the same ID, with the information in the specified replication job.
String	uploadSupportFiles(BBjAdminSet<String> p_files, BBjAdminMap<String,String> p_properties)	Send the specified list of files to support.
void	useExistingWebStartCertificate(String p_keystore, String p_keystorePassword, String p_privateKey, String p_privateKeyPassword)	Configures BBj Services to use the specified certificate for Web start applications.
boolean	validate2FACode(String p_code)	Validates the specified 2FA code for the user who created this Admin API object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BBjAdminRemoteWrapper

public BBjAdminRemoteWrapper(BBjAdminBase p_wrapped,
 Socket p_socket)

Method Details

addReplicationJob

public void addReplicationJob(BBjAdminReplicationJob p_job)
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Add the specified replication job to the list of running jobs. The job will also be started.

Specified by:

addReplicationJob in interface BBjAdminBase

Throws:

BBjAdminException

addType

public void addType(String p_property,
 BBjAdminType p_type)
             throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Adds a type for the specified property if this object was created with the ability to add new properties.

Specified by:

addType in interface BBjAdminPropertyWriter

Throws:

BBjAdminException

addUser

public BBjAdminUserPermissions addUser(String p_user,
 String p_password)
                                throws BBjAdminException

Description copied from interface: BBjAdminBase

Create a new user (committed).

Specified by:

addUser in interface BBjAdminBase

Throws:

BBjAdminException

attachDatabaseOnDisk

public BBjAdminDatabase attachDatabaseOnDisk(String p_name,
 String p_dictionary)
                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

attachDatabaseOnDisk in interface BBjAdminBase

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

public BBjAdminDatabase attachDatabaseOnDisk(String p_name,
 String p_dictionary,
 boolean p_errorOnBadDictionary)
                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

attachDatabaseOnDisk in interface BBjAdminBase

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

canAddNewProperties

public boolean canAddNewProperties()
                            throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Is the user allowed to add new properties?

Specified by:

canAddNewProperties in interface BBjAdminPropertyWriter

Throws:

BBjAdminException - TODO

canClear

public boolean canClear()
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Is the user allowed to clear properties?

Specified by:

canClear in interface BBjAdminPropertyWriter

Throws:

BBjAdminException - TODO

changePassword

public void changePassword(String p_user,
 String p_password)
                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Change user password. This call immediately changes the user's password and does not require commit() to be called.

Specified by:

changePassword in interface BBjAdminBase

Parameters:

p_user - User to change the password for.

p_password - New password for the user.

Throws:

BBjAdminException

checkUserPermission

public boolean checkUserPermission(int p_permission)

Description copied from interface: BBjAdminBase

Returns true if the user logged into the API has the specified permission.

Specified by:

checkUserPermission in interface BBjAdminBase

checkValueEqual

public boolean checkValueEqual(String p_property,
 Object p_value)
                        throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Is the provided value equal to the current value (if any)?

Specified by:

checkValueEqual in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

clear

public void clear()
           throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Clear all properties that are not read only.

Specified by:

clear in interface BBjAdminPropertyWriter

Throws:

BBjAdminException

clearCache

public void clearCache()
                throws BBjAdminException

Description copied from interface: BBjAdminBase

Clear the BBj program cache.

Specified by:

clearCache in interface BBjAdminBase

Throws:

BBjAdminException

clearProperties

public boolean clearProperties(Set<String> p_properties)
                        throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Clear a set of properties.

Specified by:

clearProperties in interface BBjAdminPropertyWriter

Parameters:

p_properties - Property names.

Returns:

Whether any of the properties has a non-null value.

Throws:

BBjAdminException

clearProperty

public boolean clearProperty(String p_property)
                      throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Clear out the value of a property.

Specified by:

clearProperty in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

Returns:

Whether the property existed.

Throws:

BBjAdminException

commit

public void commit()
            throws BBjAdminException

Description copied from interface: BBjAdminCommitWriter

Commit all property changes.

Specified by:

commit in interface BBjAdminCommitWriter

Throws:

BBjAdminException

commit

public void commit(String p_message)
            throws BBjAdminException

Description copied from interface: BBjAdminBase

Specify a specific commit message that will accompany the commit to the configuration Git archive.

Specified by:

commit in interface BBjAdminBase

Parameters:

p_message - Message to accompany the commit.

Throws:

BBjAdminException

contains

public boolean contains(Set<String> p_properties)
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Do any of a set of properties exist?

Specified by:

contains in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

contains

public boolean contains(String p_property)
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Does a given property exist?

Specified by:

contains in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

createAsynchTriggerJob

public BBjAdminAsynchTriggerJob createAsynchTriggerJob(String p_name,
 String p_address,
 int p_port,
 double p_kbps,
 boolean p_ssl,
 String p_user,
 String p_pwd,
 String p_workingDir,
 String p_config,
 boolean p_useDefaultAlias,
 String p_writeProgram,
 String p_removeProgram)
                                                throws BBjAdminException

Description copied from interface: BBjAdminBase

Creates a new asynchronous trigger job. See getAsynchTriggerJobs() for complete details on asynchronous trigger jobs.

Specified by:

createAsynchTriggerJob in interface BBjAdminBase

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_pwd - 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_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

createAsynchTriggerJob

public BBjAdminAsynchTriggerJob createAsynchTriggerJob(String p_name,
 String p_user,
 String p_pwd,
 String p_workingDir,
 String p_config,
 boolean p_useDefaultAlias,
 String p_writeProgram,
 String p_removeProgram)
                                                throws BBjAdminException

Description copied from interface: BBjAdminBase

Creates a new asynchronous trigger job that will run on the same machine. See getAsynchTriggerJobs() for complete details on asynchronous trigger jobs.

Specified by:

createAsynchTriggerJob in interface BBjAdminBase

Parameters:

p_name - Name of the job to display in the Enterprise Manager.

p_user - User to use to connect to the job's target machine.

p_pwd - 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_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

createAuditReplicationJob

public BBjAdminAuditReplicationJob createAuditReplicationJob(String p_name,
 String p_dbRoot,
 boolean p_synchronous,
 int p_rolloverType,
 int p_rolloverFrequency)
                                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

createAuditReplicationJob in interface BBjAdminBase

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

public <E> BBjAdminList<E> createBBjAdminList()
                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Create a new BBjAdminList instance. Always use this method to create a new BBjAdminList rather than directly using one of its implementation classes.

Specified by:

createBBjAdminList in interface BBjAdminBase

Returns:

New BBjAdminList.

Throws:

BBjAdminException

createBBjAdminMap

public <K,
V> BBjAdminMap<K,V> createBBjAdminMap()
                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Create a BBjAdminMap. Always use this method to create a new BBjAdminMap rather than directly using one of its implementation classes.

Specified by:

createBBjAdminMap in interface BBjAdminBase

Returns:

New BBjAdminMap

Throws:

BBjAdminException

createBBjAdminSet

public <E> BBjAdminSet<E> createBBjAdminSet()
                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Create a BBjAdminSet. Always use this method to create a new BBjAdminSet rather than directly using one of its implementation classes.

Specified by:

createBBjAdminSet in interface BBjAdminBase

Returns:

New BBjAdminSet.

Throws:

BBjAdminException

createBBjReplicationJob

public BBjAdminBBjReplicationJob createBBjReplicationJob(String p_name,
 boolean p_synchronous)
                                                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Creates a new BBj replication job.

Specified by:

createBBjReplicationJob in interface BBjAdminBase

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

public BBjAdminBBjReplicationJob createBBjReplicationJob(String p_name,
 String p_address,
 int p_port,
 boolean p_ssl,
 String p_user,
 String p_pwd,
 boolean p_synchronous)
                                                  throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

createBBjReplicationJob in interface BBjAdminBase

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

public BBjAdminBBjReplicationJob createBBjReplicationJob(String p_name,
 String p_address,
 int p_port,
 double p_kbps,
 boolean p_ssl,
 String p_user,
 String p_pwd,
 boolean p_synchronous)
                                                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Creates a new BBj replication job with the specified configuration info.

Specified by:

createBBjReplicationJob in interface BBjAdminBase

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

createBuiApplication

public BBjAdminBuiApplication createBuiApplication()
                                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Create a new BUI application configuration. Make changes to the application configuration object and then call the commit() method to save the changes.

Specified by:

createBuiApplication in interface BBjAdminBase

Throws:

BBjAdminException

createRemoteApplication

public BBjAdminAppDeploymentApplication createRemoteApplication()
                                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

createRemoteApplication in interface BBjAdminBase

Throws:

BBjAdminException

createDatabaseOnDisk

public BBjAdminDatabase createDatabaseOnDisk(String p_name,
 String p_dictionary,
 BBjAdminDatabase.DatabaseType p_type)
                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Create a new database and create the data dictionary files. Used for creating a new database entirely from scratch.

Specified by:

createDatabaseOnDisk in interface BBjAdminBase

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

public void createDirectory(String p_fullPath,
 boolean p_recursive)
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

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. /<myhost, port=2100>/mypath)

Specified by:

createDirectory in interface BBjAdminBase

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

public BBjAdminOnlineCopyJobConfig createOnlineCopyJobConfig()
                                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Create an empty OnlineCopyJob. To run the copy job, call the startOnlineCopyJob() method, passing in the BBjAdminOnlineCopyJobConfig instance returned by this method.

Specified by:

createOnlineCopyJobConfig in interface BBjAdminBase

Throws:

BBjAdminException

createOnlineCopyJobConfig

public BBjAdminOnlineCopyJobConfig createOnlineCopyJobConfig(String p_file)
                                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Create an OnlineCopyJob from a file. To run the copy job, call the startOnlineCopyJob() method, passing in the BBjAdminOnlineCopyJobConfig instance returned by this method.

Specified by:

createOnlineCopyJobConfig in interface BBjAdminBase

Parameters:

p_file - Name of the file.

Throws:

BBjAdminException

createServerConfiguration

public BBjAdminServer createServerConfiguration(BBjAdminServer.ServerType p_type)
                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Create an empty server configuration of the specified type.

Specified by:

createServerConfiguration in interface BBjAdminBase

Throws:

BBjAdminException

createSQLReplicationJob

public BBjAdminSQLReplicationJob createSQLReplicationJob()
                                                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Creates a new SQL replication job.

Specified by:

createSQLReplicationJob in interface BBjAdminBase

Throws:

BBjAdminException

createWebService

public BBjAdminWebService createWebService()
                                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a new instance of a Web service. Use commit() to save the changes to the web service.

Specified by:

createWebService in interface BBjAdminBase

Throws:

BBjAdminException

dropDatabase

public void dropDatabase(String p_name,
 boolean p_deleteAllFiles)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Drop a database by name, optionally deleting all files.

Specified by:

dropDatabase in interface BBjAdminBase

Throws:

BBjAdminException

dropSecurityGroup

public void dropSecurityGroup(String p_group)
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Drops the specified security group (committed). This does not affect any of the users who are members of the group.

Specified by:

dropSecurityGroup in interface BBjAdminBase

Throws:

BBjAdminException

dropUser

public void dropUser(String p_user)
              throws BBjAdminException

Description copied from interface: BBjAdminBase

Drop a user (committed).

Specified by:

dropUser in interface BBjAdminBase

Throws:

BBjAdminException

dumpProperties

public void dumpProperties()
                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Dump the properties currently in memory to a file in the log directory.

Specified by:

dumpProperties in interface BBjAdminBase

Throws:

BBjAdminException

dumpHeap

public void dumpHeap()
              throws BBjAdminException

Description copied from interface: BBjAdminBase

Dump the memory heap to the log.

Specified by:

dumpHeap in interface BBjAdminBase

Throws:

BBjAdminException

dumpThreads

public void dumpThreads()
                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Dump JVM threads to the log.

Specified by:

dumpThreads in interface BBjAdminBase

Throws:

BBjAdminException

generateWebStartCertificate

public void generateWebStartCertificate(String p_company,
 String p_host,
 int p_port)
                                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Tells BBj Services to have BASIS generate the Web Start certificates on the server. This will replace any certificates already in place.

Specified by:

generateWebStartCertificate in interface BBjAdminBase

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

getAbsolutePath

public String getAbsolutePath(String p_filename)
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getAbsolutePath in interface BBjAdminBase

Throws:

BBjAdminException

getAsynchTriggerJobs

public BBjAdminList<BBjAdminAsynchTriggerJob> getAsynchTriggerJobs()
                                                            throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getAsynchTriggerJobs in interface BBjAdminBase

Returns:

List of all the asynchronous trigger jobs.

Throws:

BBjAdminException

getAsynchTriggerTargets

public BBjAdminList<BBjAdminAsynchTriggerTarget> getAsynchTriggerTargets()
                                                                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the asynchronous trigger job targets on this machine. See getAsynchTriggerJobs() for information about asynchronous triggers.

Specified by:

getAsynchTriggerTargets in interface BBjAdminBase

Returns:

List of all the asynchronous trigger job targets on this machine.

Throws:

BBjAdminException

getAuditDatabase

public BBjAdminAuditDB getAuditDatabase(String p_dbRoot)
                                 throws BBjAdminException

Specified by:

getAuditDatabase in interface BBjAdminBase

Throws:

BBjAdminException

getAuditJobs

public BBjAdminList<BBjAdminAuditReplicationJob> getAuditJobs()
                                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the audit jobs currently configured on the server.

Specified by:

getAuditJobs in interface BBjAdminBase

Throws:

BBjAdminException

getAuditTargets

public BBjAdminList<BBjAdminAuditReplicationTarget> getAuditTargets()
                                                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the audit target currently on this server.

Specified by:

getAuditTargets in interface BBjAdminBase

Throws:

BBjAdminException

getAutorunConfiguration

public BBjAdminAutorun getAutorunConfiguration()
                                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the autorun configuration.

Specified by:

getAutorunConfiguration in interface BBjAdminBase

Throws:

BBjAdminException

getAvailableSystemPermissions

public BBjAdminList<BBjAdminSystemPermission> getAvailableSystemPermissions()
                                                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getAvailableSystemPermissions in interface BBjAdminBase

Throws:

BBjAdminException

getBBjFile

public BBjAdminBBjFile getBBjFile(String p_parent)
                           throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getBBjFile in interface BBjAdminBase

Throws:

BBjAdminException

getBBjProcess

public BBjAdminBBjProcess getBBjProcess(String p_id)
                                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the BBjAdminBBjProcess for the specified ID. Use this to get a current fresh copy of the process information.

Specified by:

getBBjProcess in interface BBjAdminBase

Throws:

BBjAdminException

getBBjProcesses

public List<BBjAdminBBjProcess> getBBjProcesses()
                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the set of BBj processes (read-only).

Specified by:

getBBjProcesses in interface BBjAdminBase

Throws:

BBjAdminException

getBBjProperties

public Properties getBBjProperties()
                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a Map containing all the properties and their values found in the BBj.properties file.

Specified by:

getBBjProperties in interface BBjAdminBase

Throws:

BBjAdminException

getBBjPropertiesFile

public String getBBjPropertiesFile()
                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a read-only copy of the contents of the BBj.properties file.

Specified by:

getBBjPropertiesFile in interface BBjAdminBase

Throws:

BBjAdminException

getBoolean

public boolean getBoolean(String p_property)
                   throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a boolean value for a property.

Specified by:

getBoolean in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Boolean value for a property, some properties do not have an boolean value.

Throws:

BBjAdminException

getBuiConfiguration

public BBjAdminBuiConfiguration getBuiConfiguration()
                                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the configuration object for managing the BUI applications and settings on the server.

Specified by:

getBuiConfiguration in interface BBjAdminBase

Throws:

BBjAdminException

getRemoteConfiguration

public BBjAdminAppDeploymentConfiguration getRemoteConfiguration()
                                                          throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getRemoteConfiguration in interface BBjAdminBase

Throws:

BBjAdminException

getChangedProperties

public Map<String,Object> getChangedProperties()
                                        throws BBjAdminException

Description copied from interface: BBjAdminCommitPropertyWriter

Get the changed properties.

Specified by:

getChangedProperties in interface BBjAdminCommitPropertyWriter

Throws:

BBjAdminException - TODO

getClasspath

public BBjAdminList<String> getClasspath(String p_cpName)
                                  throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getClasspath in interface BBjAdminBase

Throws:

BBjAdminException

getClasspathNames

public BBjAdminList<String> getClasspathNames()
                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of the session specific classpaths on the server.

Specified by:

getClasspathNames in interface BBjAdminBase

Throws:

BBjAdminException

getClearedProperties

public Set<String> getClearedProperties()
                                 throws BBjAdminException

Description copied from interface: BBjAdminCommitPropertyWriter

Get the set of cleared properties.

Specified by:

getClearedProperties in interface BBjAdminCommitPropertyWriter

Throws:

BBjAdminException - TODO

getClientBBjProcess

public BBjAdminClientBBjProcess getClientBBjProcess(String p_id)
                                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the BBjAdminBBjProcess for the specified ID. Use this to get a current fresh copy of the process information.

Specified by:

getClientBBjProcess in interface BBjAdminBase

Throws:

BBjAdminException

getClientBBjProcesses

public List<BBjAdminClientBBjProcess> getClientBBjProcesses()
                                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the set of BBj processes (read-only).

Specified by:

getClientBBjProcesses in interface BBjAdminBase

Throws:

BBjAdminException

getClientReplicationJobs

public List<BBjAdminClientReplicationJob> getClientReplicationJobs()
                                                            throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getClientReplicationJobs in interface BBjAdminBase

Throws:

BBjAdminException

getConfiguration

public BBjAdminConfiguration getConfiguration()
                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns an object which provides access to server configuration settings.

Specified by:

getConfiguration in interface BBjAdminBase

Throws:

BBjAdminException

getConnectionPool

public BBjAdminConnectionPool getConnectionPool(String p_poolName)
                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the specified connection pool for administration purposes.

Specified by:

getConnectionPool in interface BBjAdminBase

Throws:

BBjAdminException

getConnectionPools

public BBjAdminList<BBjAdminConnectionPool> getConnectionPools()
                                                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of available connection pools for administration purposes.

Specified by:

getConnectionPools in interface BBjAdminBase

Throws:

BBjAdminException

getDatabase

public BBjAdminDatabase getDatabase(String p_name)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Get a single existing database.

Specified by:

getDatabase in interface BBjAdminBase

Throws:

BBjAdminException

getDatabaseNames

public Set<String> getDatabaseNames()
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the names of all accessible databases.

Specified by:

getDatabaseNames in interface BBjAdminBase

Throws:

BBjAdminException

getDatabases

public BBjAdminSet<BBjAdminDatabase> getDatabases()
                                           throws BBjAdminException

Description copied from interface: BBjAdminBase

Get all accessible databases.

Specified by:

getDatabases in interface BBjAdminBase

Throws:

BBjAdminException

getDouble

public double getDouble(String p_property)
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a double value for a property.

Specified by:

getDouble in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Double value for a property, some properties do not have a double value.

Throws:

BBjAdminException

getFile

public BBjAdminFile getFile(String p_parent)
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getFile in interface BBjAdminBase

Throws:

BBjAdminException

getFreeSpace

public long getFreeSpace(String p_path)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the number of free bytes available

Specified by:

getFreeSpace in interface BBjAdminBase

Throws:

BBjAdminException

getInt

public int getInt(String p_property)
           throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get an integer value for a property.

Specified by:

getInt in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Integer value for a property, some properties do not have an integer value.

Throws:

BBjAdminException

getJavaInfo

public Properties getJavaInfo(String p_javaHome,
 boolean p_server)
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the information about the Java Virtual Machine located at the specified location.

Specified by:

getJavaInfo in interface BBjAdminBase

Throws:

BBjAdminException

getJnlpConfiguration

public BBjAdminJnlpConfiguration getJnlpConfiguration()
                                               throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the configuration object for managing the JNLP applications and settings on the server.

Specified by:

getJnlpConfiguration in interface BBjAdminBase

Throws:

BBjAdminException

getList

public BBjAdminList getList(String p_property)
                     throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a BBjAdminList value for a property.

Specified by:

getList in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

BBjAdminList value for a property.

Throws:

BBjAdminException

getLocaleString

public String getLocaleString()
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the Locale as a string.

Specified by:

getLocaleString in interface BBjAdminBase

Throws:

BBjAdminException

getLong

public long getLong(String p_property)
             throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a long value for a property.

Specified by:

getLong in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Long value for a property, some properties do not have an long value.

Throws:

BBjAdminException

getMemoryUsageData

public List<BBjAdminMemoryUsage> getMemoryUsageData(String p_alternateLocation)
                                             throws BBjAdminException

Specified by:

getMemoryUsageData in interface BBjAdminBase

Throws:

BBjAdminException

getMountedTriggerDirectories

public BBjAdminList<String> getMountedTriggerDirectories()
                                                  throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getMountedTriggerDirectories in interface BBjAdminBase

Throws:

BBjAdminException

getOnlineCopyJobs

public BBjAdminSet<BBjAdminOnlineCopyJobRun> getOnlineCopyJobs()
                                                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Get all currently running Online Copy Jobs.

Specified by:

getOnlineCopyJobs in interface BBjAdminBase

Throws:

BBjAdminException

getOpenFiles

public List<BBjAdminOpenFile> getOpenFiles()
                                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the set of open files (read-only).

Specified by:

getOpenFiles in interface BBjAdminBase

Throws:

BBjAdminException

getOpenFile

public BBjAdminOpenFile getOpenFile(String p_id)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the open file (read-only) with the specified ID.

Specified by:

getOpenFile in interface BBjAdminBase

Throws:

BBjAdminException

getClientOpenFiles

public List<BBjAdminClientOpenFile> getClientOpenFiles()
                                                throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getClientOpenFiles in interface BBjAdminBase

Throws:

BBjAdminException

getOriginalProperties

public Map<String,Object> getOriginalProperties()
                                         throws BBjAdminException

Description copied from interface: BBjAdminCommitPropertyWriter

Get the original properties list.

Specified by:

getOriginalProperties in interface BBjAdminCommitPropertyWriter

Throws:

BBjAdminException - TODO

getOSFiles

public List<BBjAdminClientOSFile> getOSFiles(BBjAdminClientOSFile p_parent,
 String[] p_filenameFilter,
 Date p_modifiedFilterStart,
 Date p_modifiedFilterEnd)
                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getOSFiles in interface BBjAdminBase

Throws:

BBjAdminException

getPassword

public String getPassword()
                   throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getPassword in interface BBjAdminBase

Throws:

BBjAdminException

getProperties

public Map<String,Object> getProperties()
                                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a copy of all properties.

Specified by:

getProperties in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

getReadOnly

public Set<String> getReadOnly()
                        throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the complete set of read-only properties.

Specified by:

getReadOnly in interface BBjAdminPropertyWriter

Throws:

BBjAdminException - TODO

getReplicationJob

public BBjAdminReplicationJob getReplicationJob(String p_uuid)
                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the replication job running on the system that has the specified UUID.

Specified by:

getReplicationJob in interface BBjAdminBase

Throws:

BBjAdminException

getReplicationJobs

public BBjAdminList<BBjAdminReplicationJob> getReplicationJobs()
                                                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of the replication jobs currently running on the system.

Specified by:

getReplicationJobs in interface BBjAdminBase

Throws:

BBjAdminException

getEnabledReplicationJobs

public BBjAdminList<BBjAdminReplicationJob> getEnabledReplicationJobs()
                                                               throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the currently enabled replication jobs. Any jobs currently paused (disabled) will not show in this list.

Specified by:

getEnabledReplicationJobs in interface BBjAdminBase

Returns:

List of all enabled replication jobs.

Throws:

BBjAdminException

getReplicationTargets

public BBjAdminList<BBjAdminReplicationTarget> getReplicationTargets()
                                                              throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getReplicationTargets in interface BBjAdminBase

Throws:

BBjAdminException

getRoots

public BBjAdminList<String> getRoots()
                              throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the roots or drives on the machine.

Specified by:

getRoots in interface BBjAdminBase

Throws:

BBjAdminException

getSecurityGroupNames

public BBjAdminList<String> getSecurityGroupNames()
                                           throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of available security group names.

Specified by:

getSecurityGroupNames in interface BBjAdminBase

Throws:

BBjAdminException

getSecurityGroups

public BBjAdminList<BBjAdminSecurityGroup> getSecurityGroups()
                                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of available security groups.

Specified by:

getSecurityGroups in interface BBjAdminBase

Throws:

BBjAdminException

getServerConfigurations

public BBjAdminMap<BBjAdminServer.ServerType,BBjAdminSet<BBjAdminServer>> getServerConfigurations()
                                                                                           throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the server configuration. Deprecated. @see BBjAdminBase.getServices()

Specified by:

getServerConfigurations in interface BBjAdminBase

Throws:

BBjAdminException

getServerConfigurations

public BBjAdminSet<BBjAdminServer> getServerConfigurations(BBjAdminServer.ServerType p_type)
                                                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the server configurations for a single type of server. Deprecated. @see BBjAdminBase.getServices()

Specified by:

getServerConfigurations in interface BBjAdminBase

Throws:

BBjAdminException

getSingleUserPermissions

public BBjAdminUserPermissions getSingleUserPermissions(String p_user)
                                                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the permissions for a single user.

Specified by:

getSingleUserPermissions in interface BBjAdminBase

Throws:

BBjAdminException

getSQLConnections

public BBjAdminSet<BBjAdminSQLConnection> getSQLConnections()
                                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the set of SQL connections (read-only).

Specified by:

getSQLConnections in interface BBjAdminBase

Throws:

BBjAdminException

getStartupExceptions

public BBjAdminList<BBjAdminStartupException> getStartupExceptions()
                                                            throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getStartupExceptions in interface BBjAdminBase

Throws:

BBjAdminException

getString

public String getString(String p_property)
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a String value for a property.

Specified by:

getString in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

String value for a property, all property values can be retrieved as Strings.

Throws:

BBjAdminException

getSystemProperty

public String getSystemProperty(String p_property,
 String p_default)
                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a system property from the server. Basically it is the equivalent to calling System.getProperty() on the server side.

Specified by:

getSystemProperty in interface BBjAdminBase

Throws:

BBjAdminException

getTableAnalysisJobs

public BBjAdminSet<BBjAdminTableAnalysisJob> getTableAnalysisJobs()
                                                           throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of the currently queued and/or running table analysis jobs on the server.

Specified by:

getTableAnalysisJobs in interface BBjAdminBase

Returns:

List of the queued and running table analysis jobs.

Throws:

BBjAdminException

getIndexBuilderJobs

public BBjAdminSet<BBjAdminIndexBuilderJob> getIndexBuilderJobs()
                                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of the currently running index builder jobs on the server.

Specified by:

getIndexBuilderJobs in interface BBjAdminBase

Returns:

List of running index builder jobs.

Throws:

BBjAdminException

getTaskQueue

public BBjAdminTaskQueue getTaskQueue()
                               throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the currently configured task groups on the server.

Specified by:

getTaskQueue in interface BBjAdminBase

Returns:

List of all the configured task groups.

Throws:

BBjAdminException

getTemplateForFile

public String getTemplateForFile(String p_filename)
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getTemplateForFile in interface BBjAdminBase

Throws:

BBjAdminException

getKeyTemplateForFile

public String getKeyTemplateForFile(String p_filename,
 int p_keyNum)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a string template (if one can be found) for the specified data file defining the layout of the key specified in p_keyNum. 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's key based on the index definitions present for the table. NOTE: This does not apply to ESQL files.

Specified by:

getKeyTemplateForFile in interface BBjAdminBase

Throws:

BBjAdminException

getTextFileContents

public String getTextFileContents(String p_fullPath)
                           throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the contents of the specified file from the remote machine as a string. This method is only designed to retrieve text based files.

Specified by:

getTextFileContents in interface BBjAdminBase

Throws:

BBjAdminException

getTotalSpace

public long getTotalSpace(String p_path)
                   throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the total space available on the specified root or drive.

Specified by:

getTotalSpace in interface BBjAdminBase

Throws:

BBjAdminException

getTriggers

public BBjAdminTriggers getTriggers(String p_filename)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the trigger configuration for a file.

Specified by:

getTriggers in interface BBjAdminBase

Throws:

BBjAdminException

getType

public BBjAdminType getType(String p_property)
                     throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get the value type of a property. The value type can be unknown.

Specified by:

getType in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

getTypes

public Map<String,BBjAdminType> getTypes()
                                  throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a copy of all of the type information.

Specified by:

getTypes in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

getUser

public String getUser()
               throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the name of the user who got this BBjAdmin instance.

Specified by:

getUser in interface BBjAdminBase

Throws:

BBjAdminException

getTokenValue

public String getTokenValue()
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the authorization token that was used to acquire this connection to the Admin API.

Specified by:

getTokenValue in interface BBjAdminBase

Returns:

Authorization token used by this connection.

Throws:

BBjAdminException

getUserNames

public List<String> getUserNames()
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the names of users.

Specified by:

getUserNames in interface BBjAdminBase

Throws:

BBjAdminException

getUserPermissions

public BBjAdminList<BBjAdminUserPermissions> getUserPermissions()
                                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the permissions for all users.

Specified by:

getUserPermissions in interface BBjAdminBase

Throws:

BBjAdminException

getValue

public Object getValue(String p_property)
                throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a object value for a property.

Specified by:

getValue in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Boolean value for a property, some properties do not have an boolean value.

Throws:

BBjAdminException

getWebAppServer

public BBjAdminWebAppServer getWebAppServer()
                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the Web App Server configuration.

Specified by:

getWebAppServer in interface BBjAdminBase

Throws:

BBjAdminException

getWebService

public BBjAdminWebService getWebService(String p_name)
                                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the BBjAdminWebService instance for the specified service, or null if no service by that name exists.

Specified by:

getWebService in interface BBjAdminBase

Throws:

BBjAdminException

getWebServices

public BBjAdminList<BBjAdminWebService> getWebServices()
                                                throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of available web services.

Specified by:

getWebServices in interface BBjAdminBase

Throws:

BBjAdminException

hasChanged

public boolean hasChanged()
                   throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Have properties been changed?

Specified by:

hasChanged in interface BBjAdminPropertyWriter

Throws:

BBjAdminException - TODO

isAddressSameAsServer

public boolean isAddressSameAsServer(String p_address)
                              throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns true if the specified host address resolves to the same address as the machine running the Admin Server.

Specified by:

isAddressSameAsServer in interface BBjAdminBase

Throws:

BBjAdminException

isAdminOnlyMode

public boolean isAdminOnlyMode()
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

isAdminOnlyMode in interface BBjAdminBase

Throws:

BBjAdminException

isOSWindows

public boolean isOSWindows()
                    throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

isOSWindows in interface BBjAdminBase

Throws:

BBjAdminException

isReadOnly

public boolean isReadOnly(String p_property)
                   throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Is a given property read-only. By default they are _not_ read only.

Specified by:

isReadOnly in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

Throws:

BBjAdminException - TODO

isReplicationAllowed

public String isReplicationAllowed()
                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Asks the server if it is allowed to peform replication jobs.

Specified by:

isReplicationAllowed in interface BBjAdminBase

Throws:

BBjAdminException

isRunningAdminOnlyMode

public boolean isRunningAdminOnlyMode()
                               throws BBjAdminException

Description copied from interface: BBjAdminBase

Asks the server if it is currently RUNNING in admin only mode.

Specified by:

isRunningAdminOnlyMode in interface BBjAdminBase

Throws:

BBjAdminException

isWS3Allowed

public boolean isWS3Allowed()
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Checks if Version 3 WebServices are available.

Specified by:

isWS3Allowed in interface BBjAdminBase

Returns:

a boolean value

Throws:

BBjAdminException

migrateToEnhancedDatabase

public void migrateToEnhancedDatabase(String p_sourceDictionary,
 String p_destinationDatabase,
 String p_destinationDirectory)
                               throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

migrateToEnhancedDatabase in interface BBjAdminBase

Throws:

BBjAdminException

mountTriggerDirectory

public void mountTriggerDirectory(String p_fullPath)
                           throws BBjAdminException

Description copied from interface: BBjAdminBase

Mounts a directory to be listed when asking for a list of mounted trigger directories. See getMountedTriggerDirectories() for more information.

Specified by:

mountTriggerDirectory in interface BBjAdminBase

Throws:

BBjAdminException

newConnectionPool

public BBjAdminConnectionPool newConnectionPool()
                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a new connection pool definition.

Specified by:

newConnectionPool in interface BBjAdminBase

Throws:

BBjAdminException

newDatabaseInstance

public BBjAdminDatabase newDatabaseInstance(Map<String,Object> p_properties)
                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a new, empty database instance. Call commit() on the BBjAdminDatabase instance to save the changes you make to it.

Specified by:

newDatabaseInstance in interface BBjAdminBase

Throws:

BBjAdminException

newLDAPSearch

public BBjAdminLDAPSearch newLDAPSearch()
                                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a new, blank LDAP search instance.

Specified by:

newLDAPSearch in interface BBjAdminBase

Throws:

BBjAdminException

newSecurityGroup

public BBjAdminSecurityGroup newSecurityGroup(String p_groupName)
                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a new SecurityGroup instance.

Specified by:

newSecurityGroup in interface BBjAdminBase

Throws:

BBjAdminException

newTask

public BBjAdminTask newTask(BBjAdminTask.TaskType p_type)
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a new task of the specified type.

Specified by:

newTask in interface BBjAdminBase

Throws:

BBjAdminException

newTaskGroup

public BBjAdminTaskGroup newTaskGroup()
                               throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a new task group from the server.

Specified by:

newTaskGroup in interface BBjAdminBase

Throws:

BBjAdminException

refresh

public void refresh()
             throws BBjAdminException

Description copied from interface: BBjAdminBase

Refresh properties that may have changed on the server, locally changed properties will not be overridden.

Specified by:

refresh in interface BBjAdminBase

Throws:

BBjAdminException

release

public void release()

Description copied from interface: BBjAdminBase

Release resources held.

Specified by:

release in interface BBjAdminBase

reloadDatabaseConfig

public void reloadDatabaseConfig()
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Reload the Database configuration file.

Specified by:

reloadDatabaseConfig in interface BBjAdminBase

Throws:

BBjAdminException

removeBuiApplication

public void removeBuiApplication(String p_name)
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the specified BUI application configuration.

Specified by:

removeBuiApplication in interface BBjAdminBase

Throws:

BBjAdminException

removeConnectionPool

public void removeConnectionPool(String p_poolName)
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the specified connection pool from the server.

Specified by:

removeConnectionPool in interface BBjAdminBase

Throws:

BBjAdminException

removeReplicationJob

public void removeReplicationJob(String p_uuid,
 boolean p_erase)
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the replication job identified by the specified UUID or name.

Specified by:

removeReplicationJob in interface BBjAdminBase

Throws:

BBjAdminException

removeAsynchTriggerJob

public void removeAsynchTriggerJob(String p_uuid)
                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the asynchronous trigger job identified by the specified UUID or name.

Specified by:

removeAsynchTriggerJob in interface BBjAdminBase

Parameters:

p_uuid - UUID or name for the trigger job.

Throws:

BBjAdminException

removeReplicationTarget

public void removeReplicationTarget(String p_uuid,
 boolean p_erase)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the replication target identified by the specified UUID.

Specified by:

removeReplicationTarget in interface BBjAdminBase

Parameters:

p_uuid - ID for the replication target.

p_erase - True if you want the target(destination) replicated files removed. False otherwise.

Throws:

BBjAdminException

removeTaskGroup

public void removeTaskGroup(BBjAdminTaskGroup p_group)
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the specified task group from the server.

Specified by:

removeTaskGroup in interface BBjAdminBase

Throws:

BBjAdminException

removeTriggers

public void removeTriggers(String p_filename)
                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the trigger from the specified file. Does not simply disable it, but actually removes the trigger definition file for that particular file.

Specified by:

removeTriggers in interface BBjAdminBase

Throws:

BBjAdminException

removeWebService

public void removeWebService(String p_name)
                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the specified web service from the server.

Specified by:

removeWebService in interface BBjAdminBase

Throws:

BBjAdminException

restartBBjServices

public void restartBBjServices(boolean p_waitForClients)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Tells the remote BBj Services to shutdown and restart.

Specified by:

restartBBjServices in interface BBjAdminBase

Throws:

BBjAdminException

rollback

public void rollback()
              throws BBjAdminException

Description copied from interface: BBjAdminCommitWriter

Roll back all property changes. This will discard any changes that have been made in the properties and not committed.

Specified by:

rollback in interface BBjAdminCommitWriter

Throws:

BBjAdminException

setAdminOnlyMode

public void setAdminOnlyMode(boolean p_adminOnly)
                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Tells the server to set itself into admin only mode the next time it is restarted. Subsequent restarts will come back in normal mode.

Specified by:

setAdminOnlyMode in interface BBjAdminBase

Throws:

BBjAdminException

setAutorunConfiguration

public void setAutorunConfiguration(BBjAdminAutorun p_autorun)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Set the autorun configuration (not committed).

Specified by:

setAutorunConfiguration in interface BBjAdminBase

Parameters:

p_autorun - New autorun configuration.

Throws:

BBjAdminException

setBoolean

public void setBoolean(String p_property,
 boolean p_value)
                throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the boolean value of a property. This can fail if the property needs a specific type of value or is read-only.

Specified by:

setBoolean in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setClasspath

public void setClasspath(String p_cpName,
 List<String> p_values)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

setClasspath in interface BBjAdminBase

Throws:

BBjAdminException

setDouble

public void setDouble(String p_property,
 double p_value)
               throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the double value of a property. This can fail if the property needs a specific type of value or is read-only.

Specified by:

setDouble in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setInt

public void setInt(String p_property,
 int p_value)
            throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the integer value of a property. This can fail if the property needs a specific type of value or is read-only.

Specified by:

setInt in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setList

public void setList(String p_property,
 BBjAdminList p_value)
             throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the BBjAdminList value of a property. This can fail if the property is read-only.

Specified by:

setList in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setLong

public void setLong(String p_property,
 long p_value)
             throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the long value of a property. This can fail if the property needs a specific type of value or is read-only.

Specified by:

setLong in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setProperties

public void setProperties(Map<String,Object> p_properties)
                   throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set properties as a group from a Map.

Specified by:

setProperties in interface BBjAdminPropertyWriter

Parameters:

p_properties - Properties to set.

Throws:

BBjAdminException

setReplicationJobEnabled

public void setReplicationJobEnabled(String p_replicationID,
 boolean p_enabled)
                              throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

setReplicationJobEnabled in interface BBjAdminBase

Throws:

BBjAdminException

setServerConfigurations

public void setServerConfigurations(BBjAdminMap<BBjAdminServer.ServerType,BBjAdminSet<BBjAdminServer>> p_config)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Set the server configuration (not committed). Deprecated. @see BBjAdminBase.setServices().

Specified by:

setServerConfigurations in interface BBjAdminBase

Throws:

BBjAdminException

setServerConfigurations

public void setServerConfigurations(BBjAdminServer.ServerType p_type,
 BBjAdminSet<BBjAdminServer> p_servers)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Set the server configurations for a single type of server (not committed). Deprecated. @see BBjAdminBase.setServices().

Specified by:

setServerConfigurations in interface BBjAdminBase

Throws:

BBjAdminException

setSingleUserPermissions

public void setSingleUserPermissions(BBjAdminUserPermissions p_permissions)
                              throws BBjAdminException

Description copied from interface: BBjAdminBase

Set an individual user's permissions (not committed).

Specified by:

setSingleUserPermissions in interface BBjAdminBase

Throws:

BBjAdminException

setString

public void setString(String p_property,
 String p_value)
               throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the String value of a property. This can fail if the property needs a specific type of value or is read-only.

Specified by:

setString in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setTableAnalysisEnabled

public void setTableAnalysisEnabled(String p_database,
 boolean p_enabled)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

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".

Specified by:

setTableAnalysisEnabled in interface BBjAdminBase

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

public void setTriggers(BBjAdminTriggers p_triggers)
                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Set the trigger configuration for a file (not committed).

Specified by:

setTriggers in interface BBjAdminBase

Throws:

BBjAdminException

setUserPermissions

public void setUserPermissions(BBjAdminSet<BBjAdminUserPermissions> p_permissions)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Set permissions for a whole set of users (not committed).

Specified by:

setUserPermissions in interface BBjAdminBase

Throws:

BBjAdminException

setValue

public void setValue(String p_property,
 Object p_value)
              throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the object value of a property. This can fail if the property needs a specific type of value or is read-only.

Specified by:

setValue in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

shutdownBBjServices

public void shutdownBBjServices(boolean p_waitForClients)
                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Tells BBj Services to shutdown.

Specified by:

shutdownBBjServices in interface BBjAdminBase

Parameters:

p_waitForClients - True if you want it to wait for clients to disconnect before shutting down.

Throws:

BBjAdminException

startOnlineCopyJob

public BBjAdminOnlineCopyJobRun startOnlineCopyJob(BBjAdminOnlineCopyJobConfig p_config)
                                            throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

startOnlineCopyJob in interface BBjAdminBase

Throws:

BBjAdminException

testRemoteFilesystemAccessibility

public void testRemoteFilesystemAccessibility(String p_host,
 int p_port,
 boolean p_ssl,
 String p_user,
 String p_password)
                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Called to test and see if the server can connect to the specified remote filesystem.

Specified by:

testRemoteFilesystemAccessibility in interface BBjAdminBase

Throws:

BBjAdminException

unmountTriggerDirectory

public void unmountTriggerDirectory(String p_fullPath)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Unmounts a trigger directory. See mountTriggerDirectory() and getMountedTriggerDirectories() for more information.

Specified by:

unmountTriggerDirectory in interface BBjAdminBase

Throws:

BBjAdminException

unpinAllPrograms

public void unpinAllPrograms()
                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Unpin all programs.

Specified by:

unpinAllPrograms in interface BBjAdminBase

Throws:

BBjAdminException

updateReplicationJob

public void updateReplicationJob(BBjAdminReplicationJob p_job)
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Updates the replication job on the server with the same ID, with the information in the specified replication job.

Specified by:

updateReplicationJob in interface BBjAdminBase

Throws:

BBjAdminException

useExistingWebStartCertificate

public void useExistingWebStartCertificate(String p_keystore,
 String p_keystorePassword,
 String p_privateKey,
 String p_privateKeyPassword)
                                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Configures BBj Services to use the specified certificate for Web start applications.

Specified by:

useExistingWebStartCertificate in interface BBjAdminBase

Throws:

BBjAdminException

getDocumentIndexes

public BBjAdminList<BBjAdminDocumentIndex> getDocumentIndexes()
                                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getDocumentIndexes in interface BBjAdminBase

Returns:

List of all the document indexes on the server.

Throws:

BBjAdminException

createDocumentIndex

public BBjAdminDocumentIndex createDocumentIndex(String p_name,
 String p_type)
                                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Creates a new BBjAdminDocumentIndex with the given name. If the name is already in use it will throw an exception.

Specified by:

createDocumentIndex in interface BBjAdminBase

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

public void dropDocumentIndex(String p_name)
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Drops the specified document index.

Specified by:

dropDocumentIndex in interface BBjAdminBase

Parameters:

p_name - Name of the document index to drop.

Throws:

BBjAdminException

getDocumentIndex

public BBjAdminDocumentIndex getDocumentIndex(String p_name)
                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getDocumentIndex in interface BBjAdminBase

Parameters:

p_name - The name of the document index to retrieve.

Returns:

The index or null if not found.

Throws:

BBjAdminException

uploadSupportFiles

public String uploadSupportFiles(BBjAdminSet<String> p_files,
 BBjAdminMap<String,String> p_properties)
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

uploadSupportFiles in interface BBjAdminBase

Returns:

Unique identifier for this upload job. This ID will be used to check progress.

Throws:

BBjAdminException

getSupportUploadJob

public BBjAdminSupportUploadJob getSupportUploadJob(String p_uploadId)
                                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns an instance of BBjAdminSupportUploadJob containing the information about the current status of the specified upload job ID.

Specified by:

getSupportUploadJob in interface BBjAdminBase

Throws:

BBjAdminException

getSupportUploadJobs

public BBjAdminList<BBjAdminSupportUploadJob> getSupportUploadJobs()
                                                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the currently running support upload jobs.

Specified by:

getSupportUploadJobs in interface BBjAdminBase

Throws:

BBjAdminException

abortSupportUploadJob

public void abortSupportUploadJob(String p_uploadId)
                           throws BBjAdminException

Description copied from interface: BBjAdminBase

Cancels the specified support upload job.

Specified by:

abortSupportUploadJob in interface BBjAdminBase

Throws:

BBjAdminException

acceptLdapCertificate

public void acceptLdapCertificate(String p_certificate)
                           throws BBjAdminException

Description copied from interface: BBjAdminBase

Called to accept the LDAP certificate and add it to the accepted certificate list.

Specified by:

acceptLdapCertificate in interface BBjAdminBase

Throws:

BBjAdminException

getFileOpenInfo

public BBjAdminMap<BBjAdminFileOpenInfoKey,BBjAdminFileOpenInfoValue> getFileOpenInfo()
                                                                               throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getFileOpenInfo in interface BBjAdminBase

Throws:

BBjAdminException

clearFileOpenInfo

public void clearFileOpenInfo()
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

clearFileOpenInfo in interface BBjAdminBase

Throws:

BBjAdminException

testJdbcConnection

public void testJdbcConnection(String p_driver,
 String p_url,
 String p_user,
 String p_password)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Tests connecting with the specified JDBC driver, URL, user and password from the server. This is generally used to test linked database connection information.

Specified by:

testJdbcConnection in interface BBjAdminBase

Throws:

BBjAdminException

createBBjReplicationJob

public BBjAdminBBjReplicationJob createBBjReplicationJob(String p_name,
 String p_address,
 int p_port,
 double p_kbps,
 boolean p_ssl,
 String p_user,
 String p_pwd,
 boolean p_synchronous,
 String p_eventHandlerProgram,
 String p_eventHandlerUser,
 String p_eventHandlerPassword,
 String p_eventHandlerConfig,
 String p_eventHandlerWorkingDir,
 String p_eventHandlerClasspath,
 String p_eventEmailService,
 String p_eventEmailRecipients)
                                                  throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

createBBjReplicationJob in interface BBjAdminBase

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

newEmailService

public BBjAdminEmailService newEmailService()
                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

newEmailService in interface BBjAdminBase

Returns:

New Email Service instance.

Throws:

BBjAdminException

removeEmailService

public void removeEmailService(String p_name)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the specified email service configuration from the server.

Specified by:

removeEmailService in interface BBjAdminBase

Throws:

BBjAdminException

getEmailServices

public BBjAdminList<BBjAdminEmailService> getEmailServices()
                                                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of the currently configured email services on the server.

Specified by:

getEmailServices in interface BBjAdminBase

Returns:

List of email services.

Throws:

BBjAdminException

getEmailService

public BBjAdminEmailService getEmailService(String p_name)
                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the email service with the specified name.

Specified by:

getEmailService in interface BBjAdminBase

Returns:

The BBjAdminEmailService instance by the specified name.

Throws:

BBjAdminException

getEventManager

public BBjAdminEventManager getEventManager()
                                     throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getEventManager in interface BBjAdminBase

Returns:

The event manager from the server.

Throws:

BBjAdminException

updateEventManager

public void updateEventManager(BBjAdminEventManager p_manager)
                        throws BBjAdminException

Specified by:

updateEventManager in interface BBjAdminBase

Throws:

BBjAdminException

exportReplicationJob

public void exportReplicationJob(BBjAdminReplicationJob p_job,
 String p_filename)
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

exportReplicationJob in interface BBjAdminBase

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

public BBjAdminReplicationJob importReplicationJob(String p_filename,
 String p_user,
 String p_password)
                                            throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

importReplicationJob in interface BBjAdminBase

Throws:

BBjAdminException

jsonExecute

public String jsonExecute(String p_json)
                   throws BBjAdminException

Description copied from interface: BBjAdminBase

Executes some server-side processing defined by the supplied JSON string. The result should be another JSON string.

Specified by:

jsonExecute in interface BBjAdminBase

Returns:

a JSON String

Throws:

BBjAdminException

getConfigCommits

public List<BBjAdminGitCommit> getConfigCommits(int p_startDate,
 int p_endDate)
                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of the config directory commits that have occurred during the optional range of dates.

Specified by:

getConfigCommits in interface BBjAdminBase

Parameters:

p_startDate - Number of seconds since the epoch start time range or zero for none.

p_endDate - Number of seconds since the epoch end time range or zero for none.

Throws:

BBjAdminException

hardResetConfigCommit

public void hardResetConfigCommit(String p_id,
 String p_name,
 String p_email)
                           throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

hardResetConfigCommit in interface BBjAdminBase

Parameters:

p_id - 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

public String getConfigCommitDiffText(String p_commitId1,
 String p_commitId2)
                               throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the Git diff patch text between two commits.

Specified by:

getConfigCommitDiffText in interface BBjAdminBase

Throws:

BBjAdminException

getStartTime

public String getStartTime()
                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the time that the currently running BBjServices was started as a formatted timestamp string including the timezone.

Specified by:

getStartTime in interface BBjAdminBase

Throws:

BBjAdminException

getLicenseFeatureInfo

public BBjAdminLicenseFeatureInfo getLicenseFeatureInfo(String p_feature)
                                                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the license information for the specified feature.

Specified by:

getLicenseFeatureInfo in interface BBjAdminBase

Throws:

BBjAdminException

getAllLicenseFeatureInfo

public List<BBjAdminLicenseFeatureInfo> getAllLicenseFeatureInfo()
                                                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of BBjAdminLicenseFeatureInfo object for each feature the license uses.

Specified by:

getAllLicenseFeatureInfo in interface BBjAdminBase

Throws:

BBjAdminException

getBBjFileRecord

public byte[] getBBjFileRecord(String p_path,
 int p_recNum)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getBBjFileRecord in interface BBjAdminBase

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.

getJarIndexJars

public List<String> getJarIndexJars(String p_jarFilePath)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getJarIndexJars in interface BBjAdminBase

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

isSqlServerSecure

public boolean isSqlServerSecure()
                          throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns true or false as to whether the SQL engine server is using SSL.

Specified by:

isSqlServerSecure in interface BBjAdminBase

Returns:

True if SSL is configured. False otherwise.

Throws:

BBjAdminException

getServices

public List<BBjAdminServerConfig> getServices()
                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Get the services configurations.

Specified by:

getServices in interface BBjAdminBase

Throws:

BBjAdminException

setServices

public void setServices(List<BBjAdminServerConfig> p_configs)
                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Sets the services configurations.

Specified by:

setServices in interface BBjAdminBase

Throws:

BBjAdminException

removeService

public void removeService(BBjAdminServerConfig p_service)
                   throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the specified service configuration. This only applies to "general" servers such as SQL, Filesystem, XCALL, Admin, PRO/5 DS, and MMP.

Specified by:

removeService in interface BBjAdminBase

Parameters:

p_service - Service to remove.

Throws:

BBjAdminException

stopService

public void stopService(BBjAdminServerConfig p_config)
                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Stops the specified service if running.

Specified by:

stopService in interface BBjAdminBase

Parameters:

p_config - BBjAdminServerConfig instance to stop.

Throws:

BBjAdminException

startService

public void startService(BBjAdminServerConfig p_config)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Starts the specified service if not running.

Specified by:

startService in interface BBjAdminBase

Parameters:

p_config - BBjAdminServerConfig instance to stop.

Throws:

BBjAdminException

isServiceRunning

public boolean isServiceRunning(BBjAdminServerConfig p_config)
                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns true if the specified service is running.

Specified by:

isServiceRunning in interface BBjAdminBase

Throws:

BBjAdminException

getClientOpenFiles

public List<BBjAdminClientOpenFile> getClientOpenFiles(int p_field,
 int p_operator,
 String p_value)
                                                throws BBjAdminException

Description copied from interface: BBjAdminBase

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.

Specified by:

getClientOpenFiles in interface BBjAdminBase

Throws:

BBjAdminException

duplicateDatabaseConfig

public void duplicateDatabaseConfig(String p_sourceDb,
 String p_newName)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Creates a copy of the specified database configuration. This does not copy the database files such as the table data files or data dictionary but rather, only the configuration.

Specified by:

duplicateDatabaseConfig in interface BBjAdminBase

Parameters:

p_sourceDb - Name of database to duplicate it's configuration.

p_newName - New name for the new database configuration.

Throws:

BBjAdminException

copyDictionaryToTarget

public void copyDictionaryToTarget(String p_sourceDb,
 String p_targetDirectory,
 String p_targetHost,
 int p_targetPort,
 boolean p_targetSsl,
 String p_targetAuthToken)
                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Copies all the data dictionary files from the source database to the target directory.

Specified by:

copyDictionaryToTarget in interface BBjAdminBase

Throws:

BBjAdminException

receiveDictionaryFiles

public void receiveDictionaryFiles(byte[] p_bytes,
 String p_targetDirectory)
                            throws BBjAdminException

Specified by:

receiveDictionaryFiles in interface BBjAdminBase

Throws:

BBjAdminException

startDatabaseReloadHelper

public void startDatabaseReloadHelper(String p_dbName)
                               throws BBjAdminException

Specified by:

startDatabaseReloadHelper in interface BBjAdminBase

Throws:

BBjAdminException

renewToken

public String renewToken(long p_duration)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Renews the current token for that Admin API connection setting the duration of validity to the value specified in p_duration. To use the default value configured for the server, specify 0.

Specified by:

renewToken in interface BBjAdminBase

Parameters:

p_duration - The duration of the validity of the new token. 0 uses the default duration configured for the server. Note: You cannot set a duration that exceeds the default configured for the server. No exception is thrown, but it will simply defer to the default value.

Returns:

Renews the current token for the Admin API connection and returns the new token.

Throws:

BBjAdminException - If there is a problem or if the provided token is no longer valid/expired.

renewToken

public String renewToken(long p_duration,
 boolean p_invalidateOld)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Renews the current token for that Admin API connection setting the duration of validity to the value specified in p_duration. To use the default value configured for the server, specify 0.

Specified by:

renewToken in interface BBjAdminBase

Parameters:

p_duration - The duration of the validity of the new token. 0 uses the default duration configured for the server. Note: You cannot set a duration that exceeds the default configured for the server. No exception is thrown, but it will simply defer to the default value.

p_invalidateOld - If true, this will invalidate the old token and remove it from the list.

Returns:

Renews the current token for the Admin API connection and returns the new token.

Throws:

BBjAdminException - If there is a problem or if the provided token is no longer valid/expired.

renewToken

public String renewToken(String p_token,
 long p_duration)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Renews the current token for that Admin API connection setting the duration of validity to the value specified in p_duration. To use the default value configured for the server, specify 0.

Specified by:

renewToken in interface BBjAdminBase

Parameters:

p_token - The token to renew. The token must be currently valid or an exception will be thrown.

p_duration - The duration of the validity of the new token. 0 uses the default duration configured for the server. Note: You cannot set a duration that exceeds the default configured for the server. No exception is thrown, but it will simply defer to the default value.

Returns:

Renews the current token for the Admin API connection and returns the new token.

Throws:

BBjAdminException - If there is a problem or if the provided token is no longer valid/expired.

getActiveTokens

public Set<BBjAdminTokenInfo> getActiveTokens()
                                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns all the information about active authorization tokens. It does not return the token itself.

Specified by:

getActiveTokens in interface BBjAdminBase

Returns:

List of all the active authorization tokens.

Throws:

BBjAdminException

getTokenInfo

public BBjAdminTokenInfo getTokenInfo(String p_tokenOrTokenId)
                               throws BBjAdminException

Description copied from interface: BBjAdminBase

Takes the specified token and returns the BBjAdminTokenInfo object containing the payload for the token. The token must be currently active.

Specified by:

getTokenInfo in interface BBjAdminBase

Parameters:

p_tokenOrTokenId - The token itself or the ID returned in a BBjAdminTokenInfo object.

Returns:

The BBjAdminTokenInfo for the specified token.

Throws:

BBjAdminException

invalidateToken

public void invalidateToken(String p_tokenOrTokenId)
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Invalidates the specified token. The value specified can be either the token itself or the ID returned in a BBjAdminTokenInfo object.

Specified by:

invalidateToken in interface BBjAdminBase

Parameters:

p_tokenOrTokenId - The token itself or the ID returned in a BBjAdminTokenInfo object.

Throws:

BBjAdminException

getLicenseInformation

public BBjAdminLicenseInformation getLicenseInformation()
                                                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns information about the license used by BBjServices.

Specified by:

getLicenseInformation in interface BBjAdminBase

Returns:

The license information.

Throws:

BBjAdminException - If there is a problem.

forceCloseOpenFiles

public int forceCloseOpenFiles(String p_filenameMatchRegex,
 Map<String,String> p_modeMatchRegex)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Forces any open files matching the p_filenameMatchRegex value (null means ignore this match) and/or open files with MODE information matching p_modeMatchRegex.

Specified by:

forceCloseOpenFiles in interface BBjAdminBase

Parameters:

p_filenameMatchRegex - Regular expression to determine filename matches. Null to ignore the filename.

p_modeMatchRegex - Map of MODE names to a regular expression to determine matches on open files. Null to ignore the MODEs.

Returns:

The number of matching files found and thus closed.

Throws:

BBjAdminException

reconfigureServices

public void reconfigureServices()
                         throws BBjAdminException

Description copied from interface: BBjAdminBase

This method can be called to reconfigure the services. This checks the current configurations and starts/stops/restarts any services as necessary to apply the configuration changes. This method can be used to stop or start a service after configuration changes have been made. Keep in mind that it applies to all configured services. So, if any configuration changes were made to any services, those changes will be applied.

Specified by:

reconfigureServices in interface BBjAdminBase

Throws:

BBjAdminException

setUser2FASettings

public void setUser2FASettings(String p_user,
 String p_secretKey,
 boolean p_enabled)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Enables/disables TOTP 2 factor authentication for the specified user. NOTE: Once enabled, the user will not be able to login without also providing the TOTP code valid at the time of the login attempt.

Specified by:

setUser2FASettings in interface BBjAdminBase

Parameters:

p_user - User to enable/disable TOTP

p_secretKey - Provide a valid key generated by calling generateTotpSecretKey(). Set to null to disable TOTP for the user.

p_enabled - Whether 2FA is enabled for this user. Only applies if 2FA is enabled at the global level. This allows the admin to disable it for some users.

Throws:

BBjAdminException - If there is a problem.

isUser2FA

public boolean isUser2FA(String p_user)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Checks to see if the specified user is using TOTP 2 factor authentication.

Specified by:

isUser2FA in interface BBjAdminBase

Parameters:

p_user - User to check.

Returns:

True if the user is using TOTP 2 factor authentication.

Throws:

BBjAdminException

generate2FASecretKey

public String generate2FASecretKey()
                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Generates a secret key to use for TOTP and the Google Authenticator app.

Specified by:

generate2FASecretKey in interface BBjAdminBase

Throws:

BBjAdminException

check2FACode

public boolean check2FACode(String p_secretKey,
 String p_code,
 long p_validitySeconds)
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Checks to see if the specified code is valid given the specified secret key and the validity in seconds used to generate the secret key. The validity in seconds must match the validity in seconds used when calling generateTotpSecretKey().

Specified by:

check2FACode in interface BBjAdminBase

Parameters:

p_secretKey - Secret key used to generate the code.

p_code - The code.

p_validitySeconds - The validity in seconds used to generate the secret key when calling getTotpCode().

Returns:

True if the code is valid. False otherwise.

Throws:

BBjAdminException

get2FACode

public String get2FACode(String p_secretKey,
 long p_validitySeconds)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Generates a new TOTP code based on the secret key and validity in seconds. Note that the validity in seconds must match when making calls to checkTotpCode().

Specified by:

get2FACode in interface BBjAdminBase

Parameters:

p_secretKey - Secret key used to generate the code.

p_validitySeconds - The validity in seconds used to generate the secret key when calling generateTotpSecretKey().

Throws:

BBjAdminException

send2FACode

public boolean send2FACode(String p_user)
                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Sends the specified user a 2-factor authentication code via email. If the user is not set up to receive 2FA codes via email, the user does not have their email address configured, or if the default 2FA settings for BBjServices are disabled or not set up to send codes via email, the method returns false.

Specified by:

send2FACode in interface BBjAdminBase

Parameters:

p_user - User to send the code to.

Returns:

True if a code was successfully sent. False if it was unable or not supposed to send a code to the user.

Throws:

BBjAdminException - If there is some kind of error that occurs during the process.

setUserInfo

public void setUserInfo(BBjAdminUser p_info)
                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Sets additional user info such as first/last/middle name, email, text number, etc.

Specified by:

setUserInfo in interface BBjAdminBase

Throws:

BBjAdminException

setUserInfo

public void setUserInfo(List<BBjAdminUser> p_infos)
                 throws BBjAdminException

Description copied from interface: BBjAdminBase

Sets additional user info such as first/last/middle name, email, text number, etc. for a list of users in bulk.

Specified by:

setUserInfo in interface BBjAdminBase

Parameters:

p_infos - List of BBjAdminUser objects to set the values for in bulk.

Throws:

BBjAdminException

getUserInfo

public BBjAdminUser getUserInfo(String p_user)
                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns additional user info for the specified user.

Specified by:

getUserInfo in interface BBjAdminBase

Throws:

BBjAdminException

send2FASetupEmail

public void send2FASetupEmail(String p_subject,
 Set<String> p_usernames)
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Once 2-factor authorization is enabled in the EM or Admin API, this call will send an email to each user in the specified list of usernames with any setup instructions (e.g. information to download the TOTP app used by your organization, a QR code, etc. See the template file multifactor-auth-template.html located in the BBj install cfg directory to customize the message and layout.

Specified by:

send2FASetupEmail in interface BBjAdminBase

Parameters:

p_subject - Subject to include for the email sent to users.

p_usernames - Set of usernames to send the email to.

Throws:

BBjAdminException

getUsers

public List<BBjAdminUser> getUsers()
                            throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all users including their additional info such as name, email, etc.

Specified by:

getUsers in interface BBjAdminBase

Returns:

List of all the users.

Throws:

BBjAdminException

validate2FACode

public boolean validate2FACode(String p_code)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Validates the specified 2FA code for the user who created this Admin API object.

Specified by:

validate2FACode in interface BBjAdminBase

Parameters:

p_code - 2FA code to validate.

Returns:

True if the code is valid as of the time of this call. False if not.

Throws:

BBjAdminException

generateKeyPair

public String generateKeyPair(String p_user,
 String p_description)
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Generates a public/private key pair. BBjServices will store the public key while this method returns the private key. Make sure to keep the private key because it cannot be retrieved again and the server does not keep a record of it. The string returned is a string representation of a JSON document containing the private key. This should be stored in a plain text file name private-key in a subdirectory named .bbj under the user's home directory.

Specified by:

generateKeyPair in interface BBjAdminBase

Parameters:

p_user - User to generate the key for. If the user does not have server config permissions, they will only have the ability to generate a key for themselves.

p_description - A description for the key pair to use for bookkeeping purposes.

Returns:

The private key.

Throws:

BBjAdminException

getPublicKeys

public List<BBjAdminPublicKey> getPublicKeys(String p_username)
                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the public key info available on the server for the specified user.

Specified by:

getPublicKeys in interface BBjAdminBase

Parameters:

p_username - Return the keys for the specified username.

Returns:

List of key information for the user.

Throws:

BBjAdminException

removePublicKey

public void removePublicKey(String p_username,
 String p_publicKeyId)
                     throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes the specified public key if present.

Specified by:

removePublicKey in interface BBjAdminBase

Parameters:

p_username - User the key belongs to.

p_publicKeyId - The ID for the public key.

Throws:

BBjAdminException

removeAllPublicKeys

public void removeAllPublicKeys(String p_username)
                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Removes all the public keys for the specified user. Note that only an admin with the ability to add/remove user accounts can remove the keys for another user. Anyone else may only remove their own keys.

Specified by:

removeAllPublicKeys in interface BBjAdminBase

Parameters:

p_username - Username for the public keys to remove.

Throws:

BBjAdminException

getPublicKeys

public List<BBjAdminPublicKey> getPublicKeys()
                                      throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns a list of all the public key info available on the server for all users. If the user does not have admin permissions, they will only see their own keys.

Specified by:

getPublicKeys in interface BBjAdminBase

Returns:

List of key information for all visible users.

Throws:

BBjAdminException

notifyProcess

public void notifyProcess(int p_id,
 String p_message,
 String p_title)
                   throws BBjAdminException

Description copied from interface: BBjAdminBase

Sends a notification to the specified process where it will pop up a message box to display to display the provided message and title to the user of that process.

Specified by:

notifyProcess in interface BBjAdminBase

Parameters:

p_id - BBj process ID (INFO 3,0)

p_message - Message to display.

p_title - Title for the message dialog.

Throws:

BBjAdminException - If there is a problem.

notifyAllProcesses

public void notifyAllProcesses(String p_message,
 String p_title)
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Sends a notification to all running processes where it will pop up a message box to display to display the provided message and title to the user of that process.

Specified by:

notifyAllProcesses in interface BBjAdminBase

Parameters:

p_message - Message to display.

p_title - Title for the message dialog.

Throws:

BBjAdminException - If there is a problem.

createDownloadPackage

public String createDownloadPackage(List<String> p_files)
                             throws BBjAdminException

Description copied from interface: BBjAdminBase

Used to combine the specified list of files into a zip file that can be downloaded from the returned URL. Once the file is downloaded, it will be deleted from the server.

Specified by:

createDownloadPackage in interface BBjAdminBase

Parameters:

p_files - List of files to include in the zip package. Must include full paths.

Returns:

URL for the path to download the file from Jetty.

Throws:

BBjAdminException

isSAM

public boolean isSAM()
              throws BBjAdminException

Description copied from interface: BBjAdminBase

Checks to verify that the server has a valid Software Asset Management license available. This is really only used by the Enterprise Manager.

Specified by:

isSAM in interface BBjAdminBase

Returns:

True if SAM is available.

Throws:

BBjAdminException

getLanguageServer

public BBjAdminLanguageServer getLanguageServer()
                                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns the configuration information for the BBj Language Server.

Specified by:

getLanguageServer in interface BBjAdminBase

Returns:

Throws:

BBjAdminException

setLanguageServerConfiguration

public void setLanguageServerConfiguration(BBjAdminLanguageServer p_service)
                                    throws BBjAdminException

Description copied from interface: BBjAdminBase

Updates the configuration for the BBj Language Server.

Specified by:

setLanguageServerConfiguration in interface BBjAdminBase

Throws:

BBjAdminException

startLanguageServer

public void startLanguageServer()
                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Start the BBj Language Server using the current configuration.

Specified by:

startLanguageServer in interface BBjAdminBase

Throws:

BBjAdminException

stopLanguageServer

public void stopLanguageServer()
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Stop the BBj Language Server.

Specified by:

stopLanguageServer in interface BBjAdminBase

Throws:

BBjAdminException

setAutoRenewToken

public void setAutoRenewToken(boolean p_autorenew)
                       throws BBjAdminException

Specified by:

setAutoRenewToken in interface BBjAdminBase

Throws:

BBjAdminException

convertFiles

public void convertFiles(String[] p_files,
 int p_targetType)
                  throws BBjAdminException

Description copied from interface: BBjAdminBase

Converts the list of full paths to files on the BBjServices server to the specified file type.

Specified by:

convertFiles in interface BBjAdminBase

Throws:

BBjAdminException

isWebUiAvailable

public boolean isWebUiAvailable()
                         throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns true if the WebUI functionality was installed with BBj.

Specified by:

isWebUiAvailable in interface BBjAdminBase

Returns:

true if the WebUI functionality was installed with BBj.

Throws:

BBjAdminException

isWebUiLicensed

public boolean isWebUiLicensed()
                        throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns true if the BBjServices installation has a valid WEBUI license.

Specified by:

isWebUiLicensed in interface BBjAdminBase

Returns:

true if the BBjServices installation has a valid WEBUI license.

Throws:

BBjAdminException

isFulltextIndexesAllowed

public String isFulltextIndexesAllowed()
                                throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns whether FULLTEXT indexes are allowed on this BBj Services installation.

Specified by:

isFulltextIndexesAllowed in interface BBjAdminBase

Returns:

null if FULLTEXT indexes are allowed. If not allowed, returns a message indicating why not.

Throws:

BBjAdminException

isWebUiEnabled

public boolean isWebUiEnabled()
                       throws BBjAdminException

Description copied from interface: BBjAdminBase

Returns true if the WebUI functionality is enabled on the server.

Specified by:

isWebUiEnabled in interface BBjAdminBase

Returns:

true if the WebUI functionality is enabled on the server.

Throws:

BBjAdminException