cisco.uc.cuae.mgmt
Class RemoteManagementServer

java.lang.Object
  etch.bindings.java.support.RemoteBase
      cisco.uc.cuae.mgmt.RemoteManagement
          cisco.uc.cuae.mgmt.RemoteManagementServer

All Implemented Interfaces:

Management, ManagementServer

public final class RemoteManagementServer
extends RemoteManagement
implements ManagementServer

Call to message translator for ManagementServer.

Nested Class Summary

class

RemoteManagementServer._Async Asynchronous implementation of service methods.

Nested classes/interfaces inherited from interface cisco.uc.cuae.mgmt.Management

Management.AlarmCategory, Management.AlarmManager, Management.AlarmTriggerLevel, Management.AlarmType, Management.Application, Management.ApplicationType, Management.ArchiveFile, Management.AuthorizationException, Management.CancelModuleErrorException, Management.CiscoSipDomain, Management.ClusterNode, Management.CommunicationsManager, Management.Component, Management.ComponentExtension, Management.ComponentTraceLevelConfigData, Management.ComponentType, Management.ConfigType, Management.Configuration, Management.Connection, Management.ConnectionRefusedErrorException, Management.CoreComponent, Management.CtiCallRouteGroup, Management.CtiDevice, Management.CtiDevicePool, Management.CtiMonitoredDevicePool, Management.CtiPortDevicePool, Management.CtiRoutePoint, Management.CupSipDomain, Management.DataAccessErrorException, Management.DataObjectNotFoundException, Management.DataRetrievalFailureException, Management.DataStorageFailureException, Management.Device, Management.DevicePool, Management.DisableModuleErrorException, Management.DuplicateObjectFoundException, Management.EnableModuleErrorException, Management.EventLog, Management.EventLogSeverity, Management.EventLogStatus, Management.ExtensionParameter, Management.FileCloseErrorException, Management.FileCreateErrorException, Management.FileIOErrorException, Management.FileOpenErrorException, Management.FileReadErrorException, Management.FileWriteErrorException, Management.Group, Management.GroupMember, Management.H323CallRouteGroup, Management.H323Gateway, Management.IetfSipDomain, Management.IncorrectResultSizeException, Management.InstallModuleErrorException, Management.InvalidArgumentException, Management.InvalidStateErrorException, Management.LicData, Management.LicenseId, Management.LicException, Management.LicInfo, Management.LogFile, Management.LogFileId, Management.LogServerAndLoggerConfigData, Management.ManagementException, Management.MediaEngine, Management.MediaEngineGroup, Management.MediaFirmwareConfig, Management.Module, Management.ModuleDisposition, Management.ModuleErrorException, Management.MonitoredCtiDevice, Management.NoResponseTimeoutException, Management.NotSupportedErrorException, Management.NuanceSpeechLicenseServer, Management.NuanceSpeechServer, Management.ObjectAlreadyExistsException, Management.ObjectInUseException, Management.Partition, Management.Plugin, Management.PluginExtension, Management.RedundancyConfig, Management.RedundancyMaster, Management.RedundancyRole, Management.RedundancyServer, Management.RedundancyStandby, Management.RedundancyStatus, Management.RefreshModuleErrorException, Management.SccpCallRouteGroup, Management.SccpDevice, Management.SccpDevicePool, Management.Script, Management.SearchOptions, Management.Service, Management.ServiceState, Management.SipCallRouteGroup, Management.SipDevice, Management.SipDevicePool, Management.SipDomain, Management.SipDomainProxy, Management.SipTrunk, Management.SmtpManager, Management.SnmpManager, Management.StatErrorException, Management.StatInterval, Management.StatItem, Management.StatPlotCreationErrorException, Management.TraceException, Management.Trigger, Management.TriggerParam, Management.UninstallModuleErrorException, Management.UpdateModuleErrorException, Management.User

Field Summary

RemoteManagementServer._Async	_async RemoteManagementServer._Async class instance used to hide asynchronous message implementation.
RemoteManagementServer._Async	_inner Deprecated.

Fields inherited from interface cisco.uc.cuae.mgmt.Management

ADMIN_RIGHTS, E_CODE_ADD_ERROR, E_CODE_APP_EXCEPTION, E_CODE_AUTHORIZATION_FAILURE, E_CODE_CANCEL_MODULE_ERROR, E_CODE_CLEAR_CACHE_ERROR, E_CODE_CONNECTION_DUPLICATE_HOST, E_CODE_CONNECTION_EMPTY_HOST, E_CODE_CONNECTION_NOT_EXIST, E_CODE_CONNECTION_REFUSED_ERROR, E_CODE_COUNT_ERROR, E_CODE_CTI_POOL_VALIDATION_ERROR, E_CODE_CTI_ROUTE_POINT_OPERATION_ON_EMPTY_ERROR, E_CODE_DATA_ACCESS_ERROR, E_CODE_DATA_OBJECT_NOT_FOUND, E_CODE_DATA_RETRIEVAL_FAILURE, E_CODE_DATA_STORAGE_FAILURE, E_CODE_DEVICE_POOL_APP_EXCEPTION_REFRESH, E_CODE_DISABLE_MODULE_ERROR, E_CODE_DUPLICATE_ERROR, E_CODE_DUPLICATE_OBJECT_FOUND, E_CODE_DUPLICATE_USER_NAME, E_CODE_ENABLE_MODULE_ERROR, E_CODE_EXEC_FAILED, E_CODE_EXTENSION_INVOCATION_ERROR, E_CODE_FAILED_TO_CONSTRUCT_OBJECT, E_CODE_FAILED_TO_REMOVE_USER, E_CODE_FILE_CLOSE_ERROR, E_CODE_FILE_CREATE_ERROR, E_CODE_FILE_OPEN_ERROR, E_CODE_FILE_READ_ERROR, E_CODE_FILE_WRITE_ERROR, E_CODE_GROUP_MEMBER_EXISTS, E_CODE_INCORRECT_RESULT_SIZE, E_CODE_INCORRECT_STATE_ERROR, E_CODE_INSTALL_MODULE_ERROR, E_CODE_INSTANTIATION_ERROR, E_CODE_INTERNAL_ERROR, E_CODE_INVALID_ARGUMENT, E_CODE_INVALID_CALL_MANAGER_ERROR, E_CODE_INVALID_COUNT_ERROR, E_CODE_INVALID_CTI_MANAGER_ERROR, E_CODE_INVALID_ID_ERROR, E_CODE_INVALID_NAME_ERROR, E_CODE_INVALID_REGISTRAR, E_CODE_INVALID_REGISTRAR_ERROR, E_CODE_INVALID_SIP_DOMAIN_ERROR, E_CODE_IPC_COMMUNICATION_ERROR, E_CODE_NO_RESPONSE_TIMEOUT, E_CODE_NOT_SUPPORTED_ERROR, E_CODE_NULL_ADD_ERROR, E_CODE_NULL_UPDATE_ERROR, E_CODE_OBJECT_ALREADY_EXISTS, E_CODE_OBJECT_IN_USE, E_CODE_REFRESH_MODULE_ERROR, E_CODE_RETRIEVAL_ERROR, E_CODE_ROUTE_POINT_APP_EXCEPTION_REFRESH, E_CODE_SCCP_POOL_VALIDATION_ERROR, E_CODE_SIP_DOMAIN_NO_TRUNK_ERROR, E_CODE_SIP_POOL_OPERATION_ON_EMPTY_ERROR, E_CODE_SQL_EXCEPTION, E_CODE_STAT_ERROR, E_CODE_STAT_PLOT_CREATION_ERROR, E_CODE_UNINSTALL_MODULE_ERROR, E_CODE_UNKNOWN_EXCEPTION, E_CODE_UNKNOWN_USER_ID, E_CODE_UNKNOWN_USER_NAME, E_CODE_UPDATE_MODULE_ERROR, E_CODE_USER_LOCKED, E_CODE_XML_COMMAND_FAILED, E_NAME_ADD_ERROR, E_NAME_APP_EXCEPTION, E_NAME_AUTHORIZATION_FAILURE, E_NAME_CANCEL_MODULE_ERROR, E_NAME_CLEAR_CACHE_ERROR, E_NAME_CONNECTION_DUPLICATE_HOST, E_NAME_CONNECTION_EMPTY_HOST, E_NAME_CONNECTION_NOT_EXIST, E_NAME_CONNECTION_REFUSED_ERROR, E_NAME_COUNT_ERROR, E_NAME_CTI_POOL_VALIDATION_ERROR, E_NAME_CTI_ROUTE_POINT_OPERATION_ON_EMPTY_ERROR, E_NAME_DATA_ACCESS_ERROR, E_NAME_DATA_OBJECT_NOT_FOUND, E_NAME_DATA_RETRIEVAL_FAILURE, E_NAME_DATA_STORAGE_FAILURE, E_NAME_DEVICE_POOL_APP_EXCEPTION_REFRESH, E_NAME_DISABLE_MODULE_ERROR, E_NAME_DUPLICATE_ERROR, E_NAME_DUPLICATE_OBJECT_FOUND, E_NAME_DUPLICATE_USER_NAME, E_NAME_ENABLE_MODULE_ERROR, E_NAME_EXEC_FAILED, E_NAME_EXTENSION_INVOCATION_ERROR, E_NAME_FAILED_TO_CONSTRUCT_OBJECT, E_NAME_FAILED_TO_REMOVE_USER, E_NAME_FILE_CLOSE_ERROR, E_NAME_FILE_CREATE_ERROR, E_NAME_FILE_OPEN_ERROR, E_NAME_FILE_READ_ERROR, E_NAME_FILE_WRITE_ERROR, E_NAME_GROUP_MEMBER_EXISTS, E_NAME_INCORRECT_RESULT_SIZE, E_NAME_INCORRECT_STATE_ERROR, E_NAME_INSTALL_MODULE_ERROR, E_NAME_INSTANTIATION_ERROR, E_NAME_INTERNAL_ERROR, E_NAME_INVALID_ARGUMENT, E_NAME_INVALID_CALL_MANAGER_ERROR, E_NAME_INVALID_COUNT_ERROR, E_NAME_INVALID_CTI_MANAGER_ERROR, E_NAME_INVALID_ID_ERROR, E_NAME_INVALID_NAME_ERROR, E_NAME_INVALID_REGISTRAR, E_NAME_INVALID_REGISTRAR_ERROR, E_NAME_INVALID_SIP_DOMAIN_ERROR, E_NAME_IPC_COMMUNICATION_ERROR, E_NAME_NO_RESPONSE_TIMEOUT, E_NAME_NOT_SUPPORTED_ERROR, E_NAME_NULL_ADD_ERROR, E_NAME_NULL_UPDATE_ERROR, E_NAME_OBJECT_ALREADY_EXISTS, E_NAME_OBJECT_IN_USE, E_NAME_REFRESH_MODULE_ERROR, E_NAME_RETRIEVAL_ERROR, E_NAME_ROUTE_POINT_APP_EXCEPTION_REFRESH, E_NAME_SCCP_POOL_VALIDATION_ERROR, E_NAME_SIP_DOMAIN_NO_TRUNK_ERROR, E_NAME_SIP_POOL_OPERATION_ON_EMPTY_ERROR, E_NAME_SQL_EXCEPTION, E_NAME_STAT_ERROR, E_NAME_STAT_PLOT_CREATION_ERROR, E_NAME_UNINSTALL_MODULE_ERROR, E_NAME_UNKNOWN_EXCEPTION, E_NAME_UNKNOWN_USER_ID, E_NAME_UNKNOWN_USER_NAME, E_NAME_UPDATE_MODULE_ERROR, E_NAME_USER_LOCKED, E_NAME_XML_COMMAND_FAILED, REGULAR_RIGHTS, VERSION

Constructor Summary

RemoteManagementServer(etch.bindings.java.support.DeliveryService svc, etch.bindings.java.msg.ValueFactory vf)
Constructs the RemoteManagementServer.

Method Summary

Management.AlarmManager	addAlarmManager(Management.AlarmManager alarmManager) Allows user to create AlarmComponentManager (eg SMTP, SNMP)
Management.Connection	addConnection(Management.Connection connection)
Management.Device	addDevice(Management.Device device) Add the given device into the system.
Management.DevicePool	addDevicePool(Management.DevicePool pool) Add a sip device pool into database.
Management.Group	addGroup(Management.Group group) Adds a group to the db as well as any members it may contain.
Management.Device	addIetfDevice(Management.Device device)
Management.Partition	addPartition(Management.Partition partition, java.lang.String[] fields) Adds a new partition to an application.
Management.User	addUser(Management.User user) Adds a user.
Management.ArchiveFile	archiveLogFiles(java.lang.String constraint, java.util.Map<?,?> substitutions) Archives log files matching pattern.
Management.User	authenticateUser(java.lang.String username, java.lang.String password) Tests the supplied credentials for correctness.
void	beginKillServiceById(java.lang.String id) Kills the described service.
java.lang.String	beginReadArchiveFile(java.lang.String id) Prepares an archive file for reading and returns a file transaction id handle for reading the contents.
java.lang.String	beginReadLogFile(Management.LogFileId id) Prepares a log file for reading and returns a file transaction id handle for reading the contents.
java.lang.String	beginReadMibFile() Prepares a MIB file for reading and returns a file transaction id handle for reading the contents.
java.lang.String	beginReadStatPlot(java.lang.String oid, java.lang.String interval) Generates a statistical plot.
void	beginRestartServiceById(java.lang.String id) Restarts the described service.
void	beginStartServiceById(java.lang.String id) Starts the described service.
void	beginStopServiceById(java.lang.String id) Stops the described service.
void	bulkAddDevices(java.lang.String devicePoolId, java.lang.String prefix, java.lang.Integer count) Adds a large number of devices using a prefix and then adding a formatted counter on the end.
java.lang.Boolean	canAdmin() Checks to see if a user is logged in and has admin privileges.
java.lang.Boolean	canUser() Checks to see if a user is logged in
void	closeApplicationFile(java.lang.String transactionId, Management.ModuleDisposition disposition, java.lang.String appId) Writes some data to the end of the application file.
void	closeLicenseFile(java.lang.String transactionId) Closes the license file and either marks it complete or discards it.
void	closePluginFile(java.lang.String transactionId, Management.ModuleDisposition disposition, java.lang.String pluginId) Closes the plugin file and either marks it complete or discards it.
java.lang.Integer	countActiveStat(java.lang.String oid) Get count of active items.
int[]	countActiveStats(java.lang.String[] oids) Get count of active items for each item in the array.
java.lang.Integer	countAlarmList(java.lang.String constraint, java.util.Map<?,?> substitutions) Retrieves the count of Alarms from the DB
java.lang.Integer	countAlarmTypes(java.lang.String constraint, java.util.Map<?,?> substitutions) Returns the number of OID in the database.
java.lang.Integer	countApplications(java.lang.String constraint, java.util.Map<?,?> substitutions) Returns the count of applications matching the criteria..
java.lang.Integer	countArchiveFiles(java.lang.String constraint, java.util.Map<?,?> substitutions) Counts the archives from the system matching the search criteria.
java.lang.Integer	countConnections(java.lang.String constraint, java.util.Map<?,?> substitutions)
java.lang.Integer	countCoreComponents(java.lang.String constraint, java.util.Map<?,?> substitutions) Returns the count of core components.
java.lang.Integer	countDevicePools(java.lang.String constraint, java.util.Map<?,?> substitutions) Count the device pools that match the constraint.
java.lang.Integer	countDevices(java.lang.String constraint, java.util.Map<?,?> substitutions) Count the number of Devices matching the search criteria.
java.lang.Integer	countGroupMembers(java.lang.String constraint, java.util.Map<?,?> substitutions) Counts the total number of group members for the given constraint.
java.lang.Integer	countGroups(java.lang.String constraint, java.util.Map<?,?> substitutions) Counts the total number of groups given the constraint.
java.lang.Integer	countLogFiles(java.lang.String constraint, java.util.Map<?,?> substitutions) Gets the amount of log files matching the pattern
java.lang.Integer	countPlugins(java.lang.String constraint, java.util.Map<?,?> substitutions) Returns the count of plugins matching the criteria.
java.lang.Integer	countServices()
java.lang.Integer	countUsers(java.lang.String constraint, java.util.Map<?,?> substitutions) Gets the number of users matching the constraint.
java.lang.String	createApplicationFile(java.lang.String name) Begins the process of creating an application install image.
java.lang.String	createLicenseFile(java.lang.String name) Begins the process of creating an license install image.
java.lang.String	createPluginFile(java.lang.String name) Begins the process of creating a plugin install image.
void	disableApplicationById(java.lang.String id) Disables the application so it will not run.
void	disablePluginById(java.lang.String id) Disables the plugin so it will not run.
void	disableRedundancy(Management.RedundancyRole roleType) Removes the master redundancy setup of this server by taking care of removing the server addresses and restarting the needed services if required
void	disableServiceById(java.lang.String id) Disables the described service.
void	enableApplicationById(java.lang.String id) Enables the application with given id to run.
void	enablePluginById(java.lang.String id) Enables the plugin.
void	enableRedundancy(Management.RedundancyRole roleType) Enables the master redundancy setup of this server by taking care of adding the server addresses, and restarting the needed services if required
void	enableServiceById(java.lang.String id) Enables the described service.
Management.EventLog[]	findAlarmList(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Retrieves the Active Alarms from the DB
Management.AlarmManager[]	findAlarmManagers(java.lang.String constraint) Allows user to get AlarmComponentManager
Management.AlarmType[]	findAlarmTypes(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Allows user to get OID List
Management.Application[]	findApplications(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Returns the list of applications matching the criteria.
Management.ArchiveFile[]	findArchiveFiles(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Lists the available archives matching the criteria given in constraint.
Management.Connection[]	findConnections(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Retrieves all the telephony servers from database.
Management.CoreComponent[]	findCoreComponents(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Finds the core components satisfying the given constraint.
Management.DevicePool[]	findDevicePools(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Find the device pools that match the constraint from database.
Management.Device[]	findDevices(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Return the Devices matching the search criteria.
Management.GroupMember[]	findGroupMembers(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Finds all the group members for given constraint.
Management.Group[]	findGroups(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Finds all the groups for given constraint.
Management.LogFile[]	findLogFiles(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Lists the log files matching the specified LogName pattern.
Management.Plugin[]	findPlugins(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options) Returns the list of plugins matching the criteria.
Management.Service[]	findServices(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, Management.SearchOptions options)
Management.User[]	findUsers(java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer length, Management.SearchOptions options) Finds the users matching the constraint.
java.lang.Integer	getActiveLicense(java.lang.String oid) Get Active License Count
Management.Application	getApplicationById(java.lang.String id) Get application for the given application Id.
Management.Application	getApplicationByName(java.lang.String name) Get application object for the given application name.
Management.ComponentTraceLevelConfigData[]	getComponentTraceLevelConfigData() Retrieves LogLevel config data from database for all CUAE components.
Management.Connection	getConnectionById(java.lang.String id)
java.lang.String	getCUAELicenseMode() Get CUAE Licensed Mode
java.lang.String	getCUMELicenseMode() Get CUME Lice Mode
Management.Device	getDeviceById(java.lang.String id) Gets any type of device except IETF devices.
Management.DevicePool	getDevicePoolById(java.lang.String id) Gets a Sip Device Pool by Id, and validates it is the correct type
java.lang.Boolean	getEnableLoggerQueueDiag() Retrieves the value of the Logger's EnableLoggerQueueDiag config entry
Management.Group	getGroupById(java.lang.String id) Returns a group with the given id.
java.lang.String	getHostName() Returns the server host name.
Management.Device	getIetfDeviceById(java.lang.String id)
java.lang.Integer	getLicensed(java.lang.String lictype) Get Licensed Count
Management.LicenseId[]	getLicenseIds()
java.lang.Integer	getLicenseMax(java.lang.String lictype) Get License Max Count
Management.LicInfo	getLicInfo(java.lang.String licensefilename) Get License File Info
java.lang.String[]	getLoadedLicenses() Get Loaded Licenses
java.lang.Integer	getLoggerPort() Retrieves the value of the Logger's LoggerPort config entry
Management.LogServerAndLoggerConfigData	getLogServerAndLoggerConfigData() Reads LogServer and Logger config data from database.
java.lang.String	getLogServerSinkLoggerLevel() Retrieves the value of the Logger's LogServerSinkLoggerLevel config entry
java.lang.String	getMACAddress() Get CUAE Server MAC Address
java.lang.Integer	getMaxFileLogLines() Retrieves the value of the LogServer's MaxFileLogLines config entry
java.lang.Integer	getMaxFiles() Retrieves the value of the LogServer's MaxFiles config entry
Management.MediaFirmwareConfig	getMediaFirmwareConfig() Get the Media engine's default IP and MAC address.
Management.Plugin	getPluginById(java.lang.String id) Get Plugin object for the given plugin Id.
Management.Plugin	getPluginByName(java.lang.String name) Get Plugin object for the given plugin name.
Management.RedundancyConfig	getRedundancyConfig() returns a RedundancyMaster object reflecting the state of redundancy setup
Management.Service	getService(java.lang.String id) Requests a Service structure for the service with the given ID.
Management.StatItem	getStatItemById(java.lang.String id) Requests a StatItem structure for the stat item with the given ID.
Management.StatItem	getStatItemByOid(java.lang.String oid) Requests a StatItem structure for the stat item with the given ID.
java.lang.String	getTraceLevelConfigEntryId(java.lang.String componentName) Retrieves dbId of the LogLevel config entry of a given component name.
Management.Trigger	getTriggerById(java.lang.String id) Gets the info for the specified trigger.
Management.User	getUserById(java.lang.String id) Gets the user data given user id.
Management.User	getUserByName(java.lang.String name) Gets the user data given user name.
void	initializeServiceSetup(java.lang.String adminPassword, java.lang.String mediaPassword) Initialize the management service with the administrator and media engine passwords.
void	invokeComponentExtension(java.lang.String componentExtensionId, Management.ExtensionParameter[] extensionParams) Invoke ComponentExtension for the given plugin or a core component.
java.lang.Boolean	isSdkMode() Checks to see if the installation of the Unified Application Environment is in SDK mode or not
java.lang.Boolean	isServiceSetupInitialized() Checks to see if the initial management service setup is complete.
java.lang.String[]	listClusterVersions()
java.lang.String[]	listLogCategories() Lists the log file categories.
Management.StatItem[]	listStatItems() Retrieves an array of stat items.
void	login(java.lang.String name, java.lang.String password) Marks the user as logged in if they are authentic and have the right to utilize the service.
void	logout() Marks the user as logged in
byte[]	readArchiveFile(java.lang.String transactionId, java.lang.Integer length) Reads a chunk of bytes from the archive file.
byte[]	readLogFile(java.lang.String transactionId, java.lang.Integer length) Reads a chunk of bytes from the log file.
byte[]	readMibFile(java.lang.String transactionId, java.lang.Integer length) Allows user to dowload MIB file from Server.
java.lang.String	readMIBFileSize() Allows user to get MIB file Size from Server
byte[]	readStatPlot(java.lang.String transactionId, java.lang.Integer length) Reads a statistical plot.
void	removeAlarmManagerById(java.lang.String id) Allows user to delete AlarmManager given its id.
void	removeApplicationById(java.lang.String id) Deletes the application from the system.
void	removeArchiveFileById(java.lang.String id) Removes an archive file given its id.
void	removeArchiveFiles(java.lang.String constraint, java.util.Map<?,?> substitutions) Removes the specified archive from the system.
void	removeConnectionById(java.lang.String id)
void	removeDeviceById(java.lang.String id) Remove the device with the given id from the system.
void	removeDevicePoolById(java.lang.String id) Delete a sip device pool from database.
void	removeGroupById(java.lang.String id) Delete's a group and all of it's members from the db.
void	removeIetfDeviceById(java.lang.String id)
void	removeLogFiles(java.lang.String constraint, java.util.Map<?,?> substitutions) Removes log files matching pattern.
void	removePartitionById(java.lang.String id) Deletes an existing partition.
void	removePluginById(java.lang.String id) Removes the Plugin for the given plugin Id.
void	removeUserById(java.lang.String id) Removes the user.
void	resetConfigurationById(java.lang.String id) Resets the configuration (if it isn't in the default partition).
void	unInstallLicenseFile(java.lang.String licensefilename) UnInstall the License file.
void	updateAlarmStatus(java.lang.String[] alarmIds, Management.EventLogStatus status) Allows user to change attributes of single or multiple alarams
Management.Connection	updateConnection(Management.Connection connection, java.lang.String[] fields)
void	updateCoreComponentConfig(java.lang.String coreComponentId, Management.Configuration config, java.lang.String[] fields) (Currently incomplete) Update the fields of the specified core component's configuration with the values from the provided configuration item.
void	updateCoreComponentConfigs(java.lang.String coreComponentId, Management.Configuration[] configs, java.lang.String[] fields) (Currently incomplete) Update the fields of the specified core component's configurations with the values from the provided configuration items.
Management.Device	updateDevice(Management.Device device, java.lang.String[] fields) Update the given device.
void	updateDevicePool(Management.DevicePool pool, java.lang.String[] fields)
void	updateEnableLoggerQueueDiag(java.lang.Boolean enableLoggerQueueDiag) Updates the value of the Logger's EnableLoggerQueueDiag config entry
void	updateGroup(Management.Group group, java.lang.String[] fields) Updates the group information as well as the members it has.
void	updateHostName(java.lang.String newHostName) Update the server host name.
Management.Device	updateIetfDevice(Management.Device device, java.lang.String[] fields)
java.lang.Integer	updateIgnoredAlarmTypes(java.lang.String[] alarmTypeIds, java.lang.Boolean ignore) Allows user to ignore or not ignore alarm
void	updateLoggerPort(java.lang.Integer loggerPort) Updates the value of the Logger's LoggerPort config entry
void	updateLogServerAndLoggerConfigData(Management.LogServerAndLoggerConfigData newData) Saves LogServer and Logger config data to database.
void	updateLogServerSinkLoggerLevel(java.lang.String logServerSinkLoggerLevel) Updates the value of the Logger's LogServerSinkLoggerLevel config entry
void	updateMaxFileLogLines(java.lang.Integer maxFileLogLines) Updates the value of the LogServer's MaxFileLogLines config entry
void	updateMaxFiles(java.lang.Integer maxFiles) Updates the value of the LogServer's MaxFiles config entry
void	updateMediaEnginePassword(java.lang.String newPassword) Update the media engine's password setting.
void	updateMediaFirmwareConfig(Management.MediaFirmwareConfig config, java.lang.String[] fields) Update the Media Engine's firmware configuration fields with the given values.
void	updatePartition(Management.Partition partition, java.lang.String[] fields) Updates an existing partition of an application.
Management.Configuration	updatePartitionConfiguration(Management.Configuration config, java.lang.String[] fields) Updates an existing configuration.
Management.Configuration	updatePluginConfiguration(java.lang.String pluginId, Management.Configuration config, java.lang.String[] fields) Update a single PluginConfiguration for the given plugin Id.
Management.Configuration[]	updatePluginConfigurations(java.lang.String pluginId, Management.Configuration[] configs, java.lang.String[] field) Updates the configurations in the specified plugin.
void	updateRedundancySettings(Management.RedundancyConfig config, java.lang.String[] fields) adds or updates redunancy settings and enables if needed.
void	updateTraceLevelConfigValue(java.lang.String traceLevelConfigEntryId, java.lang.String traceLevel) Update single LogLevel config entry value
void	updateTraceLevelConfigValues(java.lang.String[] traceLevelConfigEntryIds, java.lang.String traceLevel) Batch updates selected LogLevel config entry values.
void	updateTrigger(Management.Trigger trigger) Sets the trigger parameters.
Management.User	updateUser(Management.User user, java.lang.String[] fields) Updates the user for the fields defined in fields parameter.
java.lang.Boolean	verifyLicenseFile(java.lang.String licensefilename) Verify the License file.
void	writeApplicationFile(java.lang.String transactionId, byte[] data) Writes some data to the end of the application file.
void	writeLicenseFile(java.lang.String transactionId, byte[] data) Writes some data to the end of the license file.
void	writePluginFile(java.lang.String transactionId, byte[] data) Writes some data to the end of the plugin file.

Methods inherited from class etch.bindings.java.support.RemoteBase

_begincall, _endcall, _newMessage, _send, _start, _startAndWaitUp, _stop, _stopAndWaitDown, _transportControl, _transportNotify, _transportQuery, _waitDown, _waitUp, toString

Methods inherited from class java.lang.Object

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

Field Detail

_async

public final RemoteManagementServer._Async _async

RemoteManagementServer._Async class instance used to hide asynchronous message implementation. Use this to invoke the asynchronous message implementations.

_inner

@Deprecated
public final RemoteManagementServer._Async _inner

Deprecated.

RemoteManagementServer._Async class instance used to hide asynchronous message implementation. This is here for backwards compatibility only, use _async instead.

Constructor Detail

RemoteManagementServer

public RemoteManagementServer(etch.bindings.java.support.DeliveryService svc,
                              etch.bindings.java.msg.ValueFactory vf)

Constructs the RemoteManagementServer.

Parameters:

svc -

vf -

Method Detail

addGroup

public final Management.Group addGroup(Management.Group group)
                                throws Management.ManagementException

Description copied from interface: ManagementServer

Adds a group to the db as well as any members it may contain.

Specified by:

addGroup in interface ManagementServer

Parameters:

group - the group to Add

Returns:

the group which will include the new unique id of the group.

Throws:

Management.ManagementException

getGroupById

public final Management.Group getGroupById(java.lang.String id)
                                    throws Management.ManagementException

Description copied from interface: ManagementServer

Returns a group with the given id.

Specified by:

getGroupById in interface ManagementServer

Parameters:

id - the group to retrieve

Returns:

the group with the given id or null if not present.

Throws:

Management.ManagementException

updateGroup

public final void updateGroup(Management.Group group,
                              java.lang.String[] fields)
                       throws Management.ManagementException

Description copied from interface: ManagementServer

Updates the group information as well as the members it has.

Specified by:

updateGroup in interface ManagementServer

Parameters:

group - the new group contents

Throws:

Management.ManagementException

removeGroupById

public final void removeGroupById(java.lang.String id)
                           throws Management.ManagementException

Description copied from interface: ManagementServer

Delete's a group and all of it's members from the db.

Specified by:

removeGroupById in interface ManagementServer

Parameters:

id - the id of the group to delete.

Throws:

Management.ManagementException

countGroups

public final java.lang.Integer countGroups(java.lang.String constraint,
                                           java.util.Map<?,?> substitutions)
                                    throws Management.ManagementException

Description copied from interface: ManagementServer

Counts the total number of groups given the constraint.

Specified by:

countGroups in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Returns:

number of groups matching the constraint.

Throws:

Management.ManagementException

findGroups

public final Management.Group[] findGroups(java.lang.String constraint,
                                           java.util.Map<?,?> substitutions,
                                           java.lang.Integer offset,
                                           java.lang.Integer limit,
                                           Management.SearchOptions options)
                                    throws Management.ManagementException

Description copied from interface: ManagementServer

Finds all the groups for given constraint.

Specified by:

findGroups in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

offset - the index of the first Group to return

limit - the number of Group toReturn

options - specifies the data fields to return and the sorting order of the results.

Returns:

the groups that that satisfy the given constraint.

Throws:

Management.ManagementException

countGroupMembers

public final java.lang.Integer countGroupMembers(java.lang.String constraint,
                                                 java.util.Map<?,?> substitutions)
                                          throws Management.ManagementException

Description copied from interface: ManagementServer

Counts the total number of group members for the given constraint.

Specified by:

countGroupMembers in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Returns:

number of group members matching the constraint.

Throws:

Management.ManagementException

findGroupMembers

public final Management.GroupMember[] findGroupMembers(java.lang.String constraint,
                                                       java.util.Map<?,?> substitutions,
                                                       java.lang.Integer offset,
                                                       java.lang.Integer limit,
                                                       Management.SearchOptions options)
                                                throws Management.ManagementException

Description copied from interface: ManagementServer

Finds all the group members for given constraint.

Specified by:

findGroupMembers in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substituted for constraint expression.

offset - the index of the first GroupMember to return

limit - the number of GroupMember toReturn

options - specifies the data fields to return and the sorting order of the results.

Returns:

the group members that that satisfy the given constraint.

Throws:

Management.ManagementException

listClusterVersions

public final java.lang.String[] listClusterVersions()
                                             throws Management.ManagementException

Specified by:

listClusterVersions in interface ManagementServer

Throws:

Management.ManagementException

addConnection

public final Management.Connection addConnection(Management.Connection connection)
                                          throws Management.ManagementException,
                                                 Management.InvalidArgumentException

Specified by:

addConnection in interface ManagementServer

Throws:

Management.ManagementException

Management.InvalidArgumentException

getConnectionById

public final Management.Connection getConnectionById(java.lang.String id)
                                              throws Management.ManagementException

Specified by:

getConnectionById in interface ManagementServer

Throws:

Management.ManagementException

updateConnection

public final Management.Connection updateConnection(Management.Connection connection,
                                                    java.lang.String[] fields)
                                             throws Management.ManagementException,
                                                    Management.InvalidArgumentException

Specified by:

updateConnection in interface ManagementServer

Throws:

Management.ManagementException

Management.InvalidArgumentException

removeConnectionById

public final void removeConnectionById(java.lang.String id)
                                throws Management.ManagementException

Specified by:

removeConnectionById in interface ManagementServer

Throws:

Management.ManagementException

countConnections

public final java.lang.Integer countConnections(java.lang.String constraint,
                                                java.util.Map<?,?> substitutions)
                                         throws Management.ManagementException

Specified by:

countConnections in interface ManagementServer

Throws:

Management.ManagementException

findConnections

public final Management.Connection[] findConnections(java.lang.String constraint,
                                                     java.util.Map<?,?> substitutions,
                                                     java.lang.Integer offset,
                                                     java.lang.Integer limit,
                                                     Management.SearchOptions options)
                                              throws Management.InvalidArgumentException,
                                                     Management.ManagementException

Description copied from interface: ManagementServer

Retrieves all the telephony servers from database. There are four differet kinds defined: H323 Gateway, Commucation Manager Cluster, Cisco Sip Domain, and IETF based Sip Domain.

Specified by:

findConnections in interface ManagementServer

Returns:

all the telephony servers defined in database.

Throws:

Management.InvalidArgumentException

Management.ManagementException

findDevicePools

public final Management.DevicePool[] findDevicePools(java.lang.String constraint,
                                                     java.util.Map<?,?> substitutions,
                                                     java.lang.Integer offset,
                                                     java.lang.Integer limit,
                                                     Management.SearchOptions options)
                                              throws Management.InvalidArgumentException,
                                                     Management.ManagementException

Description copied from interface: ManagementServer

Find the device pools that match the constraint from database.

Specified by:

findDevicePools in interface ManagementServer

Returns:

device pools match the constraint in database.

Throws:

Management.InvalidArgumentException

Management.ManagementException

addDevicePool

public final Management.DevicePool addDevicePool(Management.DevicePool pool)
                                          throws Management.ManagementException

Description copied from interface: ManagementServer

Add a sip device pool into database.

Specified by:

addDevicePool in interface ManagementServer

Parameters:

pool - the sip device pool to be added.

Returns:

the sip device pool with id populated.

Throws:

Management.ManagementException

getDevicePoolById

public final Management.DevicePool getDevicePoolById(java.lang.String id)
                                              throws Management.ManagementException

Description copied from interface: ManagementServer

Gets a Sip Device Pool by Id, and validates it is the correct type

Specified by:

getDevicePoolById in interface ManagementServer

Parameters:

id - The id of this pool

Returns:

the SipDevicePool

Throws:

Management.ManagementException

updateDevicePool

public final void updateDevicePool(Management.DevicePool pool,
                                   java.lang.String[] fields)
                            throws Management.ManagementException

Specified by:

updateDevicePool in interface ManagementServer

Throws:

Management.ManagementException

removeDevicePoolById

public final void removeDevicePoolById(java.lang.String id)
                                throws Management.ManagementException

Description copied from interface: ManagementServer

Delete a sip device pool from database.

Specified by:

removeDevicePoolById in interface ManagementServer

Parameters:

id - the id of the device pool to be removed.

Throws:

Management.ManagementException

countDevicePools

public final java.lang.Integer countDevicePools(java.lang.String constraint,
                                                java.util.Map<?,?> substitutions)
                                         throws Management.InvalidArgumentException,
                                                Management.ManagementException

Description copied from interface: ManagementServer

Count the device pools that match the constraint.

Specified by:

countDevicePools in interface ManagementServer

Returns:

the count of device pools matching the constraint.

Throws:

Management.InvalidArgumentException

Management.ManagementException

addDevice

public final Management.Device addDevice(Management.Device device)
                                  throws Management.ManagementException

Description copied from interface: ManagementServer

Add the given device into the system.

Specified by:

addDevice in interface ManagementServer

Parameters:

device - the device to be added.

Returns:

the newly added device with its id and all other data fields populated.

Throws:

Management.ManagementException

getDeviceById

public final Management.Device getDeviceById(java.lang.String id)
                                      throws Management.ManagementException

Description copied from interface: ManagementServer

Gets any type of device except IETF devices. Do not use this method to retrieve an IETF device

Specified by:

getDeviceById in interface ManagementServer

Parameters:

id - The id of the device pool device to get

Returns:

a populated DevicePoolDevice object

Throws:

Management.ManagementException

updateDevice

public final Management.Device updateDevice(Management.Device device,
                                            java.lang.String[] fields)
                                     throws Management.ManagementException

Description copied from interface: ManagementServer

Update the given device.

Specified by:

updateDevice in interface ManagementServer

Parameters:

device - the device to be updated.

fields - the data fields of the device to be updated. The function will not change any data field that's not listed in fields array.

Returns:

the updated device data.

Throws:

Management.ManagementException

removeDeviceById

public final void removeDeviceById(java.lang.String id)
                            throws Management.ManagementException

Description copied from interface: ManagementServer

Remove the device with the given id from the system.

Specified by:

removeDeviceById in interface ManagementServer

Parameters:

id - the device id

Throws:

Management.ManagementException

countDevices

public final java.lang.Integer countDevices(java.lang.String constraint,
                                            java.util.Map<?,?> substitutions)
                                     throws Management.InvalidArgumentException,
                                            Management.ManagementException

Description copied from interface: ManagementServer

Count the number of Devices matching the search criteria.

Specified by:

countDevices in interface ManagementServer

Parameters:

constraint - a query defining search criteria that can specify device type, name pattern, directory number pattern, and other device related information.

substitutions - data to be substitued for constraint expression.

Returns:

the number of Devices

Throws:

Management.InvalidArgumentException

Management.ManagementException

findDevices

public final Management.Device[] findDevices(java.lang.String constraint,
                                             java.util.Map<?,?> substitutions,
                                             java.lang.Integer offset,
                                             java.lang.Integer limit,
                                             Management.SearchOptions options)
                                      throws Management.InvalidArgumentException,
                                             Management.ManagementException

Description copied from interface: ManagementServer

Return the Devices matching the search criteria.

Specified by:

findDevices in interface ManagementServer

Parameters:

constraint - a query defining search criteria that can specify device type, name pattern, directory number pattern, and other device related information.

substitutions - data to be substitued for constraint expression.

offset - the offset within the result set of the first item. returned. The first item is at offset 0.

limit - the number of items from the result set to return.

options - specifies the data fields to return and the sorting order of the results.

Returns:

the Devices matching the search criteria.

Throws:

Management.InvalidArgumentException

Management.ManagementException

bulkAddDevices

public final void bulkAddDevices(java.lang.String devicePoolId,
                                 java.lang.String prefix,
                                 java.lang.Integer count)
                          throws Management.ManagementException

Description copied from interface: ManagementServer

Adds a large number of devices using a prefix and then adding a formatted counter on the end.

Specified by:

bulkAddDevices in interface ManagementServer

Parameters:

devicePoolId - the device pool to add the devcies too

prefix - the prefix to use for the devices

count - the number of devices to create

Throws:

Management.ManagementException

addIetfDevice

public final Management.Device addIetfDevice(Management.Device device)
                                      throws Management.ManagementException

Specified by:

addIetfDevice in interface ManagementServer

Throws:

Management.ManagementException

getIetfDeviceById

public final Management.Device getIetfDeviceById(java.lang.String id)
                                          throws Management.ManagementException

Specified by:

getIetfDeviceById in interface ManagementServer

Throws:

Management.ManagementException

updateIetfDevice

public final Management.Device updateIetfDevice(Management.Device device,
                                                java.lang.String[] fields)
                                         throws Management.ManagementException

Specified by:

updateIetfDevice in interface ManagementServer

Throws:

Management.ManagementException

removeIetfDeviceById

public final void removeIetfDeviceById(java.lang.String id)
                                throws Management.ManagementException

Specified by:

removeIetfDeviceById in interface ManagementServer

Throws:

Management.ManagementException

countCoreComponents

public final java.lang.Integer countCoreComponents(java.lang.String constraint,
                                                   java.util.Map<?,?> substitutions)
                                            throws Management.InvalidArgumentException,
                                                   Management.ManagementException

Description copied from interface: ManagementServer

Returns the count of core components.

Specified by:

countCoreComponents in interface ManagementServer

Parameters:

constraint - the search criteria

substitutions - the map containing values for variables in constraint

Returns:

the count of core components.

Throws:

Management.InvalidArgumentException

Management.ManagementException

findCoreComponents

public final Management.CoreComponent[] findCoreComponents(java.lang.String constraint,
                                                           java.util.Map<?,?> substitutions,
                                                           java.lang.Integer offset,
                                                           java.lang.Integer limit,
                                                           Management.SearchOptions options)
                                                    throws Management.InvalidArgumentException,
                                                           Management.ManagementException

Description copied from interface: ManagementServer

Finds the core components satisfying the given constraint.

Specified by:

findCoreComponents in interface ManagementServer

Parameters:

constraint - the search criteria

substitutions - the map containing values for variables in constraint

offset - the offset of the first item to return.

limit - the count of items to return.

options - the search options(fields to return and sort order)

Returns:

the core components satisfying the constraint

Throws:

Management.InvalidArgumentException

Management.ManagementException

updateCoreComponentConfig

public final void updateCoreComponentConfig(java.lang.String coreComponentId,
                                            Management.Configuration config,
                                            java.lang.String[] fields)
                                     throws Management.InvalidArgumentException,
                                            Management.DataStorageFailureException,
                                            Management.ManagementException

Description copied from interface: ManagementServer

(Currently incomplete) Update the fields of the specified core component's configuration with the values from the provided configuration item. The core component's configuration is specified by matching the configuration's id and parentId fields.

Specified by:

updateCoreComponentConfig in interface ManagementServer

Parameters:

coreComponentId - The id of the core component to update.

config - The configuration item used to update values of the core component's configuration.

fields - The fields of of the core component's configuration to update.

Throws:

Management.InvalidArgumentException

Management.DataStorageFailureException

Management.ManagementException

updateCoreComponentConfigs

public final void updateCoreComponentConfigs(java.lang.String coreComponentId,
                                             Management.Configuration[] configs,
                                             java.lang.String[] fields)
                                      throws Management.InvalidArgumentException,
                                             Management.DataStorageFailureException,
                                             Management.ManagementException

Description copied from interface: ManagementServer

(Currently incomplete) Update the fields of the specified core component's configurations with the values from the provided configuration items. The core component's configurations are specified by matching the configuration's id and parentId fields.

Specified by:

updateCoreComponentConfigs in interface ManagementServer

Parameters:

coreComponentId - The id of the core component to update.

configs - The configuration items used to update values of the core component's configuration items.

fields - The fields of of the core component's configurations to update.

Throws:

Management.InvalidArgumentException

Management.DataStorageFailureException

Management.ManagementException

updateMediaEnginePassword

public final void updateMediaEnginePassword(java.lang.String newPassword)
                                     throws Management.DataStorageFailureException,
                                            Management.InvalidArgumentException

Description copied from interface: ManagementServer

Update the media engine's password setting.

Specified by:

updateMediaEnginePassword in interface ManagementServer

Parameters:

newPassword - The new password for the media engine

Throws:

Management.DataStorageFailureException

Management.InvalidArgumentException

getHostName

public final java.lang.String getHostName()
                                   throws Management.DataObjectNotFoundException

Description copied from interface: ManagementServer

Returns the server host name.

Specified by:

getHostName in interface ManagementServer

Returns:

The server host name.

Throws:

Management.DataObjectNotFoundException

updateHostName

public final void updateHostName(java.lang.String newHostName)
                          throws Management.DataStorageFailureException,
                                 Management.InvalidArgumentException

Description copied from interface: ManagementServer

Update the server host name.

Specified by:

updateHostName in interface ManagementServer

Parameters:

newHostName - The new host name or IP address

Throws:

Management.DataStorageFailureException

Management.InvalidArgumentException

getMediaFirmwareConfig

public final Management.MediaFirmwareConfig getMediaFirmwareConfig()
                                                            throws Management.DataObjectNotFoundException

Description copied from interface: ManagementServer

Get the Media engine's default IP and MAC address.

Specified by:

getMediaFirmwareConfig in interface ManagementServer

Returns:

an object containing both the default IP and MAC address settings

Throws:

Management.DataObjectNotFoundException

updateMediaFirmwareConfig

public final void updateMediaFirmwareConfig(Management.MediaFirmwareConfig config,
                                            java.lang.String[] fields)
                                     throws Management.DataStorageFailureException,
                                            Management.InvalidArgumentException

Description copied from interface: ManagementServer

Update the Media Engine's firmware configuration fields with the given values.

Specified by:

updateMediaFirmwareConfig in interface ManagementServer

Parameters:

config - The firmware configuration.

fields - The fields in the firmware configuration to update.

Throws:

Management.DataStorageFailureException

Management.InvalidArgumentException

isSdkMode

public final java.lang.Boolean isSdkMode()

Description copied from interface: ManagementServer

Checks to see if the installation of the Unified Application Environment is in SDK mode or not

Specified by:

isSdkMode in interface ManagementServer

Returns:

true if it is an SDK installation

isServiceSetupInitialized

public final java.lang.Boolean isServiceSetupInitialized()
                                                  throws Management.DataObjectNotFoundException

Description copied from interface: ManagementServer

Checks to see if the initial management service setup is complete.

Specified by:

isServiceSetupInitialized in interface ManagementServer

Returns:

true if setup service is initialized

Throws:

Management.DataObjectNotFoundException

initializeServiceSetup

public final void initializeServiceSetup(java.lang.String adminPassword,
                                         java.lang.String mediaPassword)
                                  throws Management.AuthorizationException,
                                         Management.DataAccessErrorException,
                                         Management.InvalidArgumentException,
                                         Management.ManagementException

Description copied from interface: ManagementServer

Initialize the management service with the administrator and media engine passwords.

Specified by:

initializeServiceSetup in interface ManagementServer

Parameters:

adminPassword - the desired initial administrator password.

mediaPassword - the desired initial media engine password.

Throws:

Management.AuthorizationException

Management.DataAccessErrorException

Management.InvalidArgumentException

Management.ManagementException

disableRedundancy

public final void disableRedundancy(Management.RedundancyRole roleType)
                             throws Management.ManagementException

Description copied from interface: ManagementServer

Removes the master redundancy setup of this server by taking care of removing the server addresses and restarting the needed services if required

Specified by:

disableRedundancy in interface ManagementServer

Throws:

Management.ManagementException

enableRedundancy

public final void enableRedundancy(Management.RedundancyRole roleType)
                            throws Management.ManagementException

Description copied from interface: ManagementServer

Enables the master redundancy setup of this server by taking care of adding the server addresses, and restarting the needed services if required

Specified by:

enableRedundancy in interface ManagementServer

Throws:

Management.ManagementException

updateRedundancySettings

public final void updateRedundancySettings(Management.RedundancyConfig config,
                                           java.lang.String[] fields)
                                    throws Management.ManagementException

Description copied from interface: ManagementServer

adds or updates redunancy settings and enables if needed. If you pass null for master or slave all of the previous settings will be removed. Inside either the master or standby the following is allowed: blank usernames and passwords, since not all databases require then null passwords are accepted, and will leave the current password alone

Specified by:

updateRedundancySettings in interface ManagementServer

Parameters:

config - settings to be updated

fields - data fields of the the configuration to be updated.

Throws:

Management.ManagementException

getRedundancyConfig

public final Management.RedundancyConfig getRedundancyConfig()
                                                      throws Management.ManagementException

Description copied from interface: ManagementServer

returns a RedundancyMaster object reflecting the state of redundancy setup

Specified by:

getRedundancyConfig in interface ManagementServer

Returns:

current settings

Throws:

Management.ManagementException

login

public final void login(java.lang.String name,
                        java.lang.String password)
                 throws Management.InvalidArgumentException,
                        Management.AuthorizationException,
                        Management.ManagementException

Description copied from interface: ManagementServer

Marks the user as logged in if they are authentic and have the right to utilize the service.

Specified by:

login in interface ManagementServer

Parameters:

name - the name of the user.

password - the password of the user.

Throws:

Management.InvalidArgumentException

Management.AuthorizationException

Management.ManagementException

logout

public final void logout()

Description copied from interface: ManagementServer

Marks the user as logged in

Specified by:

logout in interface ManagementServer

canAdmin

public final java.lang.Boolean canAdmin()

Description copied from interface: ManagementServer

Checks to see if a user is logged in and has admin privileges.

Specified by:

canAdmin in interface ManagementServer

Returns:

true if user is logged in and has admin privileges.

canUser

public final java.lang.Boolean canUser()

Description copied from interface: ManagementServer

Checks to see if a user is logged in

Specified by:

canUser in interface ManagementServer

Returns:

true if user is logged in

addUser

public final Management.User addUser(Management.User user)
                              throws Management.InvalidArgumentException,
                                     Management.ManagementException

Description copied from interface: ManagementServer

Adds a user.

Specified by:

addUser in interface ManagementServer

Parameters:

user - the user object that holds user name, password, user rights. Name must match pattern (^[\\w\\-]+$) which includes letters, digits, underscore, and dash. Name is case sensitive and must be unique.

Returns:

the User of the added user. Mainly used to communicate the user's id.

Throws:

Management.InvalidArgumentException

Management.ManagementException

getUserByName

public final Management.User getUserByName(java.lang.String name)
                                    throws Management.InvalidArgumentException,
                                           Management.ManagementException

Description copied from interface: ManagementServer

Gets the user data given user name.

Specified by:

getUserByName in interface ManagementServer

Parameters:

name - the name (^[\\w\\-]+$) of the user.

Returns:

the user data

Throws:

Management.InvalidArgumentException

Management.ManagementException

getUserById

public final Management.User getUserById(java.lang.String id)
                                  throws Management.InvalidArgumentException,
                                         Management.ManagementException

Description copied from interface: ManagementServer

Gets the user data given user id.

Specified by:

getUserById in interface ManagementServer

Parameters:

id - the id ([\\d]+) of the user.

Returns:

the user data

Throws:

Management.InvalidArgumentException

Management.ManagementException

updateUser

public final Management.User updateUser(Management.User user,
                                        java.lang.String[] fields)
                                 throws Management.InvalidArgumentException,
                                        Management.ManagementException

Description copied from interface: ManagementServer

Updates the user for the fields defined in fields parameter.

Specified by:

updateUser in interface ManagementServer

Parameters:

user - the uesr data for update.

fields - the list of fields in user data to be updated.

Returns:

the updated user object.

Throws:

Management.InvalidArgumentException

Management.ManagementException

removeUserById

public final void removeUserById(java.lang.String id)
                          throws Management.InvalidArgumentException,
                                 Management.ManagementException

Description copied from interface: ManagementServer

Removes the user.

Specified by:

removeUserById in interface ManagementServer

Parameters:

id - the id ([\\d]+) of the user.

Throws:

Management.InvalidArgumentException

Management.ManagementException

countUsers

public final java.lang.Integer countUsers(java.lang.String constraint,
                                          java.util.Map<?,?> substitutions)
                                   throws Management.InvalidArgumentException,
                                          Management.ManagementException

Description copied from interface: ManagementServer

Gets the number of users matching the constraint.

Specified by:

countUsers in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Returns:

number of users matching the constraint.

Throws:

Management.InvalidArgumentException

Management.ManagementException

findUsers

public final Management.User[] findUsers(java.lang.String constraint,
                                         java.util.Map<?,?> substitutions,
                                         java.lang.Integer offset,
                                         java.lang.Integer length,
                                         Management.SearchOptions options)
                                  throws Management.InvalidArgumentException,
                                         Management.ManagementException

Description copied from interface: ManagementServer

Finds the users matching the constraint.

Specified by:

findUsers in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

offset - the offset within the result set of the first item. returned. The first item is at offset 0.

length - the number of items from the result set to return.

options - specifies the data fields to return and the sorting order of the results.

Returns:

array of user data from the result set. If the number of items returned equals the length parameter, there may be more available. To retrieve them, call listUsers repeatedly incrementing offset by length each time until the number of items returned is less than the length parameter.

Throws:

Management.InvalidArgumentException

Management.ManagementException

authenticateUser

public final Management.User authenticateUser(java.lang.String username,
                                              java.lang.String password)
                                       throws Management.InvalidArgumentException,
                                              Management.AuthorizationException,
                                              Management.ManagementException

Description copied from interface: ManagementServer

Tests the supplied credentials for correctness.

Specified by:

authenticateUser in interface ManagementServer

Parameters:

username - the name of the user.

password - the password of the user.

Throws:

Management.InvalidArgumentException

Management.AuthorizationException

Management.ManagementException

removeLogFiles

public final void removeLogFiles(java.lang.String constraint,
                                 java.util.Map<?,?> substitutions)
                          throws Management.ManagementException

Description copied from interface: ManagementServer

Removes log files matching pattern. Both LogName fields category and name must match in one of the patterns to be removed.

Specified by:

removeLogFiles in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Throws:

Management.ManagementException

countLogFiles

public final java.lang.Integer countLogFiles(java.lang.String constraint,
                                             java.util.Map<?,?> substitutions)
                                      throws Management.ManagementException

Description copied from interface: ManagementServer

Gets the amount of log files matching the pattern

Specified by:

countLogFiles in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Returns:

the log file count

Throws:

Management.ManagementException

findLogFiles

public final Management.LogFile[] findLogFiles(java.lang.String constraint,
                                               java.util.Map<?,?> substitutions,
                                               java.lang.Integer offset,
                                               java.lang.Integer limit,
                                               Management.SearchOptions options)
                                        throws Management.ManagementException

Description copied from interface: ManagementServer

Lists the log files matching the specified LogName pattern. To be listed, the category of a log file much match pattern.category and the name of the log file must match pattern.name.

Specified by:

findLogFiles in interface ManagementServer

Parameters:

constraint - a query defining search criteria that can specify log file id, name pattern, and file size.

substitutions - data to be substitued for constraint expression.

offset - the offset within the result set of the first item returned. The first item is at offset 0.

limit - the number of items from the result set to return.

options - specifies the data fields to be returned for LogFile and sorting order of the results.

Returns:

an array of log file info, or an empty array if there are none that match. If the length of the result equals the length parameter, then there may be more results available. If the length of the result is less than length, then there are no more results.

Throws:

Management.ManagementException

beginReadLogFile

public final java.lang.String beginReadLogFile(Management.LogFileId id)
                                        throws Management.FileOpenErrorException

Description copied from interface: ManagementServer

Prepares a log file for reading and returns a file transaction id handle for reading the contents.

Specified by:

beginReadLogFile in interface ManagementServer

Parameters:

id - an id for the log file.

Returns:

a transaction id for the log file.

Throws:

Management.FileOpenErrorException

readLogFile

public final byte[] readLogFile(java.lang.String transactionId,
                                java.lang.Integer length)
                         throws Management.FileReadErrorException

Description copied from interface: ManagementServer

Reads a chunk of bytes from the log file.

Specified by:

readLogFile in interface ManagementServer

Parameters:

transactionId - a transaction id for reading the log file.

Returns:

data from the log file, or an empty array if there are no more. If the length of the result equals the length parameter, then there may be more data available. If the length of the result is less than the length parameter, then there is no more data.

Throws:

Management.FileReadErrorException

listLogCategories

public final java.lang.String[] listLogCategories()
                                           throws Management.ManagementException

Description copied from interface: ManagementServer

Lists the log file categories.

Specified by:

listLogCategories in interface ManagementServer

Returns:

an array of category names, or an empty array if there are none.

Throws:

Management.ManagementException

archiveLogFiles

public final Management.ArchiveFile archiveLogFiles(java.lang.String constraint,
                                                    java.util.Map<?,?> substitutions)
                                             throws Management.ManagementException

Description copied from interface: ManagementServer

Archives log files matching pattern. Both LogName fields category and name must match in one of the patterns to be archived.

Specified by:

archiveLogFiles in interface ManagementServer

Parameters:

constraint - a query defining search criteria that can specify log file id, name pattern, and file size.

substitutions - data to be substitued for constraint expression.

Throws:

Management.ManagementException

removeArchiveFileById

public final void removeArchiveFileById(java.lang.String id)
                                 throws Management.ManagementException

Description copied from interface: ManagementServer

Removes an archive file given its id.

Specified by:

removeArchiveFileById in interface ManagementServer

Parameters:

id - the archive file id to be removed.

Throws:

Management.ManagementException

removeArchiveFiles

public final void removeArchiveFiles(java.lang.String constraint,
                                     java.util.Map<?,?> substitutions)
                              throws Management.ManagementException

Description copied from interface: ManagementServer

Removes the specified archive from the system.

Specified by:

removeArchiveFiles in interface ManagementServer

Parameters:

constraint - a query defining search criteria that can specify log file id, name pattern, and file size.

substitutions - data to be substitued for constraint expression.

Throws:

Management.ManagementException

countArchiveFiles

public final java.lang.Integer countArchiveFiles(java.lang.String constraint,
                                                 java.util.Map<?,?> substitutions)
                                          throws Management.ManagementException

Description copied from interface: ManagementServer

Counts the archives from the system matching the search criteria.

Specified by:

countArchiveFiles in interface ManagementServer

Parameters:

constraint - a query defining search criteria that can specify log file id, name pattern, and file size.

substitutions - data to be substitued for constraint expression.

Throws:

Management.ManagementException

findArchiveFiles

public final Management.ArchiveFile[] findArchiveFiles(java.lang.String constraint,
                                                       java.util.Map<?,?> substitutions,
                                                       java.lang.Integer offset,
                                                       java.lang.Integer limit,
                                                       Management.SearchOptions options)
                                                throws Management.ManagementException

Description copied from interface: ManagementServer

Lists the available archives matching the criteria given in constraint.

Specified by:

findArchiveFiles in interface ManagementServer

Parameters:

constraint - a query defining search criteria that can specify log file id, name pattern, and file size.

substitutions - data to be substitued for constraint expression.

offset - the offset within the result set of the first item returned. The first item is at offset 0.

limit - the number of items from the result set to return.

options - specifies the data fields to be returned for ArchiveFile and sorting order of the results.

Returns:

an array of archive file info, or an empty array if there are none.

Throws:

Management.ManagementException

beginReadArchiveFile

public final java.lang.String beginReadArchiveFile(java.lang.String id)
                                            throws Management.FileOpenErrorException

Description copied from interface: ManagementServer

Prepares an archive file for reading and returns a file transaction id handle for reading the contents.

Specified by:

beginReadArchiveFile in interface ManagementServer

Parameters:

id - an id for the archive file.

Returns:

a transaction id for the archive file.

Throws:

Management.FileOpenErrorException

readArchiveFile

public final byte[] readArchiveFile(java.lang.String transactionId,
                                    java.lang.Integer length)
                             throws Management.FileReadErrorException

Description copied from interface: ManagementServer

Reads a chunk of bytes from the archive file.

Specified by:

readArchiveFile in interface ManagementServer

Parameters:

transactionId - a transaction id for reading the archive file.

Returns:

data from the archive file, or an empty array if there are no more. If the length of the result equals the length parameter, then there may be more data available. If the length of the result is less than the length parameter, then there is no more data.

Throws:

Management.FileReadErrorException

getApplicationById

public final Management.Application getApplicationById(java.lang.String id)
                                                throws Management.DataObjectNotFoundException,
                                                       Management.DuplicateObjectFoundException,
                                                       Management.DataRetrievalFailureException,
                                                       Management.InvalidArgumentException,
                                                       Management.ManagementException

Description copied from interface: ManagementServer

Get application for the given application Id.

Specified by:

getApplicationById in interface ManagementServer

Parameters:

id - the id of the app.

Returns:

the application data object for the given id.

Throws:

Management.DataObjectNotFoundException

Management.DuplicateObjectFoundException

Management.DataRetrievalFailureException

Management.InvalidArgumentException

Management.ManagementException

getApplicationByName

public final Management.Application getApplicationByName(java.lang.String name)
                                                  throws Management.DataObjectNotFoundException,
                                                         Management.DuplicateObjectFoundException,
                                                         Management.DataRetrievalFailureException,
                                                         Management.InvalidArgumentException,
                                                         Management.ManagementException

Description copied from interface: ManagementServer

Get application object for the given application name.

Specified by:

getApplicationByName in interface ManagementServer

Parameters:

name - the name of the app.

Returns:

the application data object for the given id.

Throws:

Management.DataObjectNotFoundException

Management.DuplicateObjectFoundException

Management.DataRetrievalFailureException

Management.InvalidArgumentException

Management.ManagementException

removeApplicationById

public final void removeApplicationById(java.lang.String id)
                                 throws Management.ManagementException,
                                        Management.InvalidArgumentException

Description copied from interface: ManagementServer

Deletes the application from the system. It must be in the disabled state.

Specified by:

removeApplicationById in interface ManagementServer

Parameters:

id - the id of the app.

Throws:

Management.ManagementException

Management.InvalidArgumentException

countApplications

public final java.lang.Integer countApplications(java.lang.String constraint,
                                                 java.util.Map<?,?> substitutions)
                                          throws Management.DataRetrievalFailureException,
                                                 Management.ManagementException,
                                                 Management.InvalidArgumentException

Description copied from interface: ManagementServer

Returns the count of applications matching the criteria..

Specified by:

countApplications in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Returns:

the count of applications.

Throws:

Management.DataRetrievalFailureException

Management.ManagementException

Management.InvalidArgumentException

findApplications

public final Management.Application[] findApplications(java.lang.String constraint,
                                                       java.util.Map<?,?> substitutions,
                                                       java.lang.Integer offset,
                                                       java.lang.Integer limit,
                                                       Management.SearchOptions options)
                                                throws Management.DataRetrievalFailureException,
                                                       Management.ManagementException,
                                                       Management.InvalidArgumentException

Description copied from interface: ManagementServer

Returns the list of applications matching the criteria.

Specified by:

findApplications in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

offset - the offset of the first item to return.

limit - the count of items to return.

Returns:

the info for each application. If the number of items is < count, then the list is complete. If the number of items == count, then there might be more items starting at offset + count.

Throws:

Management.DataRetrievalFailureException

Management.ManagementException

Management.InvalidArgumentException

createApplicationFile

public final java.lang.String createApplicationFile(java.lang.String name)
                                             throws Management.ManagementException,
                                                    Management.FileCreateErrorException

Description copied from interface: ManagementServer

Begins the process of creating an application install image. The application install image is not complete until all the data is written and the file is closed.

Specified by:

createApplicationFile in interface ManagementServer

Parameters:

name - The final name of the application image file.

Returns:

a transaction id of the application file to use with write and close.

Throws:

Management.ManagementException

Management.FileCreateErrorException

writeApplicationFile

public final void writeApplicationFile(java.lang.String transactionId,
                                       byte[] data)
                                throws Management.FileWriteErrorException

Description copied from interface: ManagementServer

Writes some data to the end of the application file.

Specified by:

writeApplicationFile in interface ManagementServer

Parameters:

transactionId - the transaction id of the application file to be written.

data - the data to be written.

Throws:

Management.FileWriteErrorException

closeApplicationFile

public final void closeApplicationFile(java.lang.String transactionId,
                                       Management.ModuleDisposition disposition,
                                       java.lang.String appId)
                                throws Management.ManagementException,
                                       Management.FileCloseErrorException,
                                       Management.InstallModuleErrorException,
                                       Management.UpdateModuleErrorException,
                                       Management.CancelModuleErrorException

Description copied from interface: ManagementServer

Writes some data to the end of the application file.

Specified by:

closeApplicationFile in interface ManagementServer

Parameters:

transactionId - the transaction id of the application file to be written.

disposition - the disposition of a closed module file. to install, update, or cancel.

appId - if disposition is update, specifies the id of the app that we are updating, else null.

Throws:

Management.ManagementException

Management.FileCloseErrorException

Management.InstallModuleErrorException

Management.UpdateModuleErrorException

Management.CancelModuleErrorException

enableApplicationById

public final void enableApplicationById(java.lang.String id)
                                 throws Management.NoResponseTimeoutException,
                                        Management.ManagementException,
                                        Management.InvalidArgumentException

Description copied from interface: ManagementServer

Enables the application with given id to run.

Specified by:

enableApplicationById in interface ManagementServer

Parameters:

id - the id of the app.

Throws:

Management.NoResponseTimeoutException

Management.ManagementException

Management.InvalidArgumentException

disableApplicationById

public final void disableApplicationById(java.lang.String id)
                                  throws Management.NoResponseTimeoutException,
                                         Management.ManagementException,
                                         Management.InvalidArgumentException

Description copied from interface: ManagementServer

Disables the application so it will not run.

Specified by:

disableApplicationById in interface ManagementServer

Parameters:

id - the id of the app.

Throws:

Management.NoResponseTimeoutException

Management.ManagementException

Management.InvalidArgumentException

addPartition

public final Management.Partition addPartition(Management.Partition partition,
                                               java.lang.String[] fields)
                                        throws Management.ManagementException,
                                               Management.InvalidArgumentException

Description copied from interface: ManagementServer

Adds a new partition to an application.

Specified by:

addPartition in interface ManagementServer

Parameters:

partition - the info for the new partition.

fields - the fields of partition data to be updated.

Returns:

the updated info for the new partition.

Throws:

Management.ManagementException

Management.InvalidArgumentException

updatePartition

public final void updatePartition(Management.Partition partition,
                                  java.lang.String[] fields)
                           throws Management.ManagementException,
                                  Management.InvalidArgumentException

Description copied from interface: ManagementServer

Updates an existing partition of an application.

Specified by:

updatePartition in interface ManagementServer

Parameters:

partition - the info to update for the partition.

fields - the fields of the partition data that need to be updated.

Throws:

Management.ManagementException

Management.InvalidArgumentException

removePartitionById

public final void removePartitionById(java.lang.String id)
                               throws Management.ManagementException,
                                      Management.InvalidArgumentException

Description copied from interface: ManagementServer

Deletes an existing partition.

Specified by:

removePartitionById in interface ManagementServer

Parameters:

id - the id of the partition to delete.

Throws:

Management.ManagementException

Management.InvalidArgumentException

updatePartitionConfiguration

public final Management.Configuration updatePartitionConfiguration(Management.Configuration config,
                                                                   java.lang.String[] fields)
                                                            throws Management.ManagementException,
                                                                   Management.InvalidArgumentException

Description copied from interface: ManagementServer

Updates an existing configuration.

Specified by:

updatePartitionConfiguration in interface ManagementServer

Parameters:

config - the configuration data to be updated.

fields - the fields of the given configuration data that need to be updated.

Returns:

the updated configuration data.

Throws:

Management.ManagementException

Management.InvalidArgumentException

resetConfigurationById

public final void resetConfigurationById(java.lang.String id)
                                  throws Management.ManagementException,
                                         Management.InvalidArgumentException

Description copied from interface: ManagementServer

Resets the configuration (if it isn't in the default partition).

Specified by:

resetConfigurationById in interface ManagementServer

Parameters:

id - the id of the configuration to reset.

Throws:

Management.ManagementException

Management.InvalidArgumentException

getTriggerById

public final Management.Trigger getTriggerById(java.lang.String id)
                                        throws Management.ManagementException,
                                               Management.InvalidArgumentException

Description copied from interface: ManagementServer

Gets the info for the specified trigger.

Specified by:

getTriggerById in interface ManagementServer

Parameters:

id - the unique id of the trigger.

Returns:

the info of the trigger or null.

Throws:

Management.ManagementException

Management.InvalidArgumentException

updateTrigger

public final void updateTrigger(Management.Trigger trigger)
                         throws Management.ManagementException,
                                Management.InvalidArgumentException

Description copied from interface: ManagementServer

Sets the trigger parameters. The current list is dumped and this list replaces it (performed as an atomic transaction).

Specified by:

updateTrigger in interface ManagementServer

Parameters:

trigger - the trigger data to be updated.

Throws:

Management.ManagementException

Management.InvalidArgumentException

getPluginById

public final Management.Plugin getPluginById(java.lang.String id)
                                      throws Management.DataObjectNotFoundException,
                                             Management.DuplicateObjectFoundException,
                                             Management.ManagementException,
                                             Management.InvalidArgumentException

Description copied from interface: ManagementServer

Get Plugin object for the given plugin Id.

Specified by:

getPluginById in interface ManagementServer

Parameters:

id - id of the plugin.

Returns:

information about the plugin if a plugin exists for the given id. If not, an exception is thrown.

Throws:

Management.DataObjectNotFoundException

Management.DuplicateObjectFoundException

Management.ManagementException

Management.InvalidArgumentException

getPluginByName

public final Management.Plugin getPluginByName(java.lang.String name)
                                        throws Management.DataObjectNotFoundException,
                                               Management.DuplicateObjectFoundException,
                                               Management.ManagementException,
                                               Management.InvalidArgumentException

Description copied from interface: ManagementServer

Get Plugin object for the given plugin name.

Specified by:

getPluginByName in interface ManagementServer

Parameters:

name - name of the plugin.

Returns:

information about the plugin if a plugin exists for the given id. If not, an exception is thrown.

Throws:

Management.DataObjectNotFoundException

Management.DuplicateObjectFoundException

Management.ManagementException

Management.InvalidArgumentException

removePluginById

public final void removePluginById(java.lang.String id)
                            throws Management.DataObjectNotFoundException,
                                   Management.DuplicateObjectFoundException,
                                   Management.InvalidStateErrorException,
                                   Management.UninstallModuleErrorException,
                                   Management.ManagementException,
                                   Management.InvalidArgumentException

Description copied from interface: ManagementServer

Removes the Plugin for the given plugin Id.

Specified by:

removePluginById in interface ManagementServer

Parameters:

id - id of the plugin.

Throws:

Management.DataObjectNotFoundException

Management.DuplicateObjectFoundException

Management.InvalidStateErrorException

Management.UninstallModuleErrorException

Management.ManagementException

Management.InvalidArgumentException

countPlugins

public final java.lang.Integer countPlugins(java.lang.String constraint,
                                            java.util.Map<?,?> substitutions)
                                     throws Management.ManagementException,
                                            Management.InvalidArgumentException

Description copied from interface: ManagementServer

Returns the count of plugins matching the criteria.

Specified by:

countPlugins in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Returns:

the count of plugins.

Throws:

Management.ManagementException

Management.InvalidArgumentException

findPlugins

public final Management.Plugin[] findPlugins(java.lang.String constraint,
                                             java.util.Map<?,?> substitutions,
                                             java.lang.Integer offset,
                                             java.lang.Integer limit,
                                             Management.SearchOptions options)
                                      throws Management.ManagementException,
                                             Management.InvalidArgumentException

Description copied from interface: ManagementServer

Returns the list of plugins matching the criteria.

Specified by:

findPlugins in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

offset - the offset of the first item to return.

limit - the count of items to return.

options - define the fields to be returned and sorting order of the result.

Returns:

the info for each plugins.

Throws:

Management.ManagementException

Management.InvalidArgumentException

createPluginFile

public final java.lang.String createPluginFile(java.lang.String name)
                                        throws Management.ManagementException,
                                               Management.InvalidArgumentException,
                                               Management.FileCreateErrorException

Description copied from interface: ManagementServer

Begins the process of creating a plugin install image. The plugin install image is not complete until all the data is written and the file is closed.

Specified by:

createPluginFile in interface ManagementServer

Parameters:

name - the final name of the plugin image file.

Returns:

a transaction id of the plugin file to use with write and close.

Throws:

Management.ManagementException

Management.InvalidArgumentException

Management.FileCreateErrorException

writePluginFile

public final void writePluginFile(java.lang.String transactionId,
                                  byte[] data)
                           throws Management.FileWriteErrorException,
                                  Management.InvalidArgumentException

Description copied from interface: ManagementServer

Writes some data to the end of the plugin file.

Specified by:

writePluginFile in interface ManagementServer

Parameters:

transactionId - the transaction id of the plugin file to be written.

data - the data to be written.

Throws:

Management.FileWriteErrorException

Management.InvalidArgumentException

closePluginFile

public final void closePluginFile(java.lang.String transactionId,
                                  Management.ModuleDisposition disposition,
                                  java.lang.String pluginId)
                           throws Management.FileCloseErrorException,
                                  Management.InstallModuleErrorException,
                                  Management.UpdateModuleErrorException,
                                  Management.CancelModuleErrorException

Description copied from interface: ManagementServer

Closes the plugin file and either marks it complete or discards it. UPDATE is currently not supported for Plugin.

Specified by:

closePluginFile in interface ManagementServer

Parameters:

transactionId - the transaction id of the plugin file to be written.

disposition - the disposition of a closed module file. to install, update, or cancel.

pluginId - if disposition is update, specifies the id of the plugin that we are updating, else null.

Throws:

Management.FileCloseErrorException

Management.InstallModuleErrorException

Management.UpdateModuleErrorException

Management.CancelModuleErrorException

disablePluginById

public final void disablePluginById(java.lang.String id)
                             throws Management.ManagementException,
                                    Management.InvalidArgumentException

Description copied from interface: ManagementServer

Disables the plugin so it will not run.

Specified by:

disablePluginById in interface ManagementServer

Parameters:

id - the id of the plugin.

Throws:

Management.ManagementException

Management.InvalidArgumentException

enablePluginById

public final void enablePluginById(java.lang.String id)
                            throws Management.ManagementException,
                                   Management.InvalidArgumentException

Description copied from interface: ManagementServer

Enables the plugin.

Specified by:

enablePluginById in interface ManagementServer

Parameters:

id - the id of the plugin.

Throws:

Management.ManagementException

Management.InvalidArgumentException

updatePluginConfigurations

public final Management.Configuration[] updatePluginConfigurations(java.lang.String pluginId,
                                                                   Management.Configuration[] configs,
                                                                   java.lang.String[] field)
                                                            throws Management.InvalidArgumentException,
                                                                   Management.ManagementException

Description copied from interface: ManagementServer

Updates the configurations in the specified plugin.

Specified by:

updatePluginConfigurations in interface ManagementServer

Parameters:

pluginId - the id of the plugin to be updated.

configs - the configurations to update. Only the value is updated. Each config must be a valid configuration as returned by findPlugins Configurations.

Returns:

the updated configurations.

Throws:

Management.InvalidArgumentException

Management.ManagementException

updatePluginConfiguration

public final Management.Configuration updatePluginConfiguration(java.lang.String pluginId,
                                                                Management.Configuration config,
                                                                java.lang.String[] fields)
                                                         throws Management.ManagementException,
                                                                Management.InvalidArgumentException

Description copied from interface: ManagementServer

Update a single PluginConfiguration for the given plugin Id.

Specified by:

updatePluginConfiguration in interface ManagementServer

Parameters:

pluginId - id of the plugin.

config - configuration.

fields - fields that must be updated.

Returns:

the updated configuration for the plugin

Throws:

Management.ManagementException

Management.InvalidArgumentException

invokeComponentExtension

public final void invokeComponentExtension(java.lang.String componentExtensionId,
                                           Management.ExtensionParameter[] extensionParams)
                                    throws Management.ManagementException,
                                           Management.InvalidArgumentException,
                                           Management.DataObjectNotFoundException,
                                           Management.InvalidStateErrorException

Description copied from interface: ManagementServer

Invoke ComponentExtension for the given plugin or a core component.

Specified by:

invokeComponentExtension in interface ManagementServer

Parameters:

componentExtensionId - id of the componentExtension.

extensionParams - array of Extension parameters.

Throws:

Management.ManagementException

Management.InvalidArgumentException

Management.DataObjectNotFoundException

Management.InvalidStateErrorException

verifyLicenseFile

public final java.lang.Boolean verifyLicenseFile(java.lang.String licensefilename)
                                          throws Management.LicException

Description copied from interface: ManagementServer

Verify the License file.

Specified by:

verifyLicenseFile in interface ManagementServer

Parameters:

licensefilename - the filename of file to be verified.

Throws:

Management.LicException

createLicenseFile

public final java.lang.String createLicenseFile(java.lang.String name)
                                         throws Management.FileCreateErrorException

Description copied from interface: ManagementServer

Begins the process of creating an license install image.

Specified by:

createLicenseFile in interface ManagementServer

Parameters:

name - The name of the file to create for the license.

Returns:

A transaction id for writing to the created license file. and close.

Throws:

Management.FileCreateErrorException

writeLicenseFile

public final void writeLicenseFile(java.lang.String transactionId,
                                   byte[] data)
                            throws Management.FileWriteErrorException

Description copied from interface: ManagementServer

Writes some data to the end of the license file.

Specified by:

writeLicenseFile in interface ManagementServer

Parameters:

transactionId - The transaction id of the file to be written.

data - The data to be written.

Throws:

Management.FileWriteErrorException

closeLicenseFile

public final void closeLicenseFile(java.lang.String transactionId)
                            throws Management.FileCloseErrorException,
                                   Management.LicException

Description copied from interface: ManagementServer

Closes the license file and either marks it complete or discards it.

Specified by:

closeLicenseFile in interface ManagementServer

Parameters:

transactionId - The transaction id of the file to be closed.

Throws:

Management.FileCloseErrorException

Management.LicException

unInstallLicenseFile

public final void unInstallLicenseFile(java.lang.String licensefilename)
                                throws Management.LicException

Description copied from interface: ManagementServer

UnInstall the License file.

Specified by:

unInstallLicenseFile in interface ManagementServer

Parameters:

licensefilename - the filename of file to be uninstalled.

Throws:

Management.LicException

getLicInfo

public final Management.LicInfo getLicInfo(java.lang.String licensefilename)
                                    throws Management.LicException

Description copied from interface: ManagementServer

Get License File Info

Specified by:

getLicInfo in interface ManagementServer

Parameters:

licensefilename - the filename of file get info from.

Throws:

Management.LicException

getLicenseIds

public final Management.LicenseId[] getLicenseIds()

Specified by:

getLicenseIds in interface ManagementServer

Returns:

the list of valid licensed items

getLoadedLicenses

public final java.lang.String[] getLoadedLicenses()
                                           throws Management.LicException

Description copied from interface: ManagementServer

Get Loaded Licenses

Specified by:

getLoadedLicenses in interface ManagementServer

Throws:

Management.LicException

getActiveLicense

public final java.lang.Integer getActiveLicense(java.lang.String oid)
                                         throws Management.LicException,
                                                Management.DataRetrievalFailureException

Description copied from interface: ManagementServer

Get Active License Count

Specified by:

getActiveLicense in interface ManagementServer

Parameters:

oid - the license type.

Throws:

Management.LicException

Management.DataRetrievalFailureException

getLicenseMax

public final java.lang.Integer getLicenseMax(java.lang.String lictype)
                                      throws Management.LicException

Description copied from interface: ManagementServer

Get License Max Count

Specified by:

getLicenseMax in interface ManagementServer

Parameters:

lictype - the license type.

Throws:

Management.LicException

getLicensed

public final java.lang.Integer getLicensed(java.lang.String lictype)
                                    throws Management.LicException

Description copied from interface: ManagementServer

Get Licensed Count

Specified by:

getLicensed in interface ManagementServer

Parameters:

lictype - the license type.

Throws:

Management.LicException

getCUAELicenseMode

public final java.lang.String getCUAELicenseMode()
                                          throws Management.LicException

Description copied from interface: ManagementServer

Get CUAE Licensed Mode

Specified by:

getCUAELicenseMode in interface ManagementServer

Throws:

Management.LicException

getCUMELicenseMode

public final java.lang.String getCUMELicenseMode()
                                          throws Management.LicException

Description copied from interface: ManagementServer

Get CUME Lice Mode

Specified by:

getCUMELicenseMode in interface ManagementServer

Throws:

Management.LicException

getMACAddress

public final java.lang.String getMACAddress()
                                     throws Management.LicException

Description copied from interface: ManagementServer

Get CUAE Server MAC Address

Specified by:

getMACAddress in interface ManagementServer

Throws:

Management.LicException

getLogServerAndLoggerConfigData

public final Management.LogServerAndLoggerConfigData getLogServerAndLoggerConfigData()
                                                                              throws Management.TraceException

Description copied from interface: ManagementServer

Reads LogServer and Logger config data from database.

Specified by:

getLogServerAndLoggerConfigData in interface ManagementServer

Returns:

The config data currently saved in database

Throws:

Management.TraceException

updateLogServerAndLoggerConfigData

public final void updateLogServerAndLoggerConfigData(Management.LogServerAndLoggerConfigData newData)
                                              throws Management.TraceException

Description copied from interface: ManagementServer

Saves LogServer and Logger config data to database.

Specified by:

updateLogServerAndLoggerConfigData in interface ManagementServer

Parameters:

newData - The config data to be saved in database

Throws:

Management.TraceException

getComponentTraceLevelConfigData

public final Management.ComponentTraceLevelConfigData[] getComponentTraceLevelConfigData()
                                                                                  throws Management.TraceException

Description copied from interface: ManagementServer

Retrieves LogLevel config data from database for all CUAE components.

Specified by:

getComponentTraceLevelConfigData in interface ManagementServer

Returns:

The LogLevel config data currently saved in database

Throws:

Management.TraceException

updateTraceLevelConfigValues

public final void updateTraceLevelConfigValues(java.lang.String[] traceLevelConfigEntryIds,
                                               java.lang.String traceLevel)
                                        throws Management.TraceException

Description copied from interface: ManagementServer

Batch updates selected LogLevel config entry values.

Specified by:

updateTraceLevelConfigValues in interface ManagementServer

Parameters:

traceLevelConfigEntryIds - The selected TraceLevel config entry dbIds

traceLevel - The TraceLevel config value for update

Throws:

Management.TraceException

updateTraceLevelConfigValue

public final void updateTraceLevelConfigValue(java.lang.String traceLevelConfigEntryId,
                                              java.lang.String traceLevel)
                                       throws Management.TraceException

Description copied from interface: ManagementServer

Update single LogLevel config entry value

Specified by:

updateTraceLevelConfigValue in interface ManagementServer

Parameters:

traceLevelConfigEntryId - The config entry dbId to be updated

traceLevel - The TraceLevel config value for update

Throws:

Management.TraceException

getTraceLevelConfigEntryId

public final java.lang.String getTraceLevelConfigEntryId(java.lang.String componentName)
                                                  throws Management.TraceException

Description copied from interface: ManagementServer

Retrieves dbId of the LogLevel config entry of a given component name.

Specified by:

getTraceLevelConfigEntryId in interface ManagementServer

Parameters:

componentName - The component name

Returns:

The LogLevel config entry dbId of the given component

Throws:

Management.TraceException

getMaxFileLogLines

public final java.lang.Integer getMaxFileLogLines()
                                           throws Management.TraceException

Description copied from interface: ManagementServer

Retrieves the value of the LogServer's MaxFileLogLines config entry

Specified by:

getMaxFileLogLines in interface ManagementServer

Returns:

The value of the LogServer's MaxFileLogLines config entry

Throws:

Management.TraceException

updateMaxFileLogLines

public final void updateMaxFileLogLines(java.lang.Integer maxFileLogLines)
                                 throws Management.TraceException

Description copied from interface: ManagementServer

Updates the value of the LogServer's MaxFileLogLines config entry

Specified by:

updateMaxFileLogLines in interface ManagementServer

Parameters:

maxFileLogLines - The value of the LogServer's MaxFileLogLines config entry

Throws:

Management.TraceException

getMaxFiles

public final java.lang.Integer getMaxFiles()
                                    throws Management.TraceException

Description copied from interface: ManagementServer

Retrieves the value of the LogServer's MaxFiles config entry

Specified by:

getMaxFiles in interface ManagementServer

Returns:

The value of the LogServer's MaxFiles config entry

Throws:

Management.TraceException

updateMaxFiles

public final void updateMaxFiles(java.lang.Integer maxFiles)
                          throws Management.TraceException

Description copied from interface: ManagementServer

Updates the value of the LogServer's MaxFiles config entry

Specified by:

updateMaxFiles in interface ManagementServer

Parameters:

maxFiles - The value of the LogServer's MaxFiles config entry

Throws:

Management.TraceException

getLoggerPort

public final java.lang.Integer getLoggerPort()
                                      throws Management.TraceException

Description copied from interface: ManagementServer

Retrieves the value of the Logger's LoggerPort config entry

Specified by:

getLoggerPort in interface ManagementServer

Returns:

The value of the Logger's LoggerPort config entry

Throws:

Management.TraceException

updateLoggerPort

public final void updateLoggerPort(java.lang.Integer loggerPort)
                            throws Management.TraceException

Description copied from interface: ManagementServer

Updates the value of the Logger's LoggerPort config entry

Specified by:

updateLoggerPort in interface ManagementServer

Parameters:

loggerPort - The value of the Logger's LoggerPort config entry

Throws:

Management.TraceException

getLogServerSinkLoggerLevel

public final java.lang.String getLogServerSinkLoggerLevel()
                                                   throws Management.TraceException

Description copied from interface: ManagementServer

Retrieves the value of the Logger's LogServerSinkLoggerLevel config entry

Specified by:

getLogServerSinkLoggerLevel in interface ManagementServer

Returns:

The value of the Logger's LogServerSinkLoggerLevel config entry

Throws:

Management.TraceException

updateLogServerSinkLoggerLevel

public final void updateLogServerSinkLoggerLevel(java.lang.String logServerSinkLoggerLevel)
                                          throws Management.TraceException

Description copied from interface: ManagementServer

Updates the value of the Logger's LogServerSinkLoggerLevel config entry

Specified by:

updateLogServerSinkLoggerLevel in interface ManagementServer

Parameters:

logServerSinkLoggerLevel - The value of the Logger's LogServerSinkLoggerLevel config entry

Throws:

Management.TraceException

getEnableLoggerQueueDiag

public final java.lang.Boolean getEnableLoggerQueueDiag()
                                                 throws Management.TraceException

Description copied from interface: ManagementServer

Retrieves the value of the Logger's EnableLoggerQueueDiag config entry

Specified by:

getEnableLoggerQueueDiag in interface ManagementServer

Returns:

The value of the Logger's EnableLoggerQueueDiag config entry

Throws:

Management.TraceException

updateEnableLoggerQueueDiag

public final void updateEnableLoggerQueueDiag(java.lang.Boolean enableLoggerQueueDiag)
                                       throws Management.TraceException

Description copied from interface: ManagementServer

Updates the value of the Logger's EnableLoggerQueueDiag config entry

Specified by:

updateEnableLoggerQueueDiag in interface ManagementServer

Parameters:

enableLoggerQueueDiag - The value of the Logger's EnableLoggerQueueDiag config entry

Throws:

Management.TraceException

beginReadMibFile

public final java.lang.String beginReadMibFile()
                                        throws Management.FileOpenErrorException

Description copied from interface: ManagementServer

Prepares a MIB file for reading and returns a file transaction id handle for reading the contents.

Specified by:

beginReadMibFile in interface ManagementServer

Returns:

a transaction id for the MIB file.

Throws:

Management.FileOpenErrorException

readMibFile

public final byte[] readMibFile(java.lang.String transactionId,
                                java.lang.Integer length)
                         throws Management.FileReadErrorException

Description copied from interface: ManagementServer

Allows user to dowload MIB file from Server.

Specified by:

readMibFile in interface ManagementServer

Parameters:

transactionId - the identifier for access to the MIB file.

length - the number of bytes from the file to return.

Returns:

data from the MIB file, or an empty array if there is no more data. If the length of the result equals the count parameter, then there may be more data available. If the length of the result is less than the count parameter, then there is no more data.

Throws:

Management.FileReadErrorException

readMIBFileSize

public final java.lang.String readMIBFileSize()
                                       throws Management.ManagementException

Description copied from interface: ManagementServer

Allows user to get MIB file Size from Server

Specified by:

readMIBFileSize in interface ManagementServer

Returns:

String which contains file size

Throws:

Management.ManagementException

getService

public final Management.Service getService(java.lang.String id)
                                    throws Management.DataRetrievalFailureException

Description copied from interface: ManagementServer

Requests a Service structure for the service with the given ID.

Specified by:

getService in interface ManagementServer

Parameters:

id - The identifier for the requested service.

Returns:

The requested Service structure.

Throws:

Management.DataRetrievalFailureException

countServices

public final java.lang.Integer countServices()
                                      throws Management.DataRetrievalFailureException

Specified by:

countServices in interface ManagementServer

Returns:

The total number of service available.

Throws:

Management.DataRetrievalFailureException

findServices

public final Management.Service[] findServices(java.lang.String constraint,
                                               java.util.Map<?,?> substitutions,
                                               java.lang.Integer offset,
                                               java.lang.Integer limit,
                                               Management.SearchOptions options)
                                        throws Management.ManagementException

Specified by:

findServices in interface ManagementServer

Throws:

Management.ManagementException

beginStartServiceById

public final void beginStartServiceById(java.lang.String id)
                                 throws Management.DataRetrievalFailureException,
                                        Management.DataStorageFailureException

Description copied from interface: ManagementServer

Starts the described service.

Specified by:

beginStartServiceById in interface ManagementServer

Parameters:

id - The identifier for the requested service.

Throws:

Management.DataRetrievalFailureException

Management.DataStorageFailureException

beginStopServiceById

public final void beginStopServiceById(java.lang.String id)
                                throws Management.DataRetrievalFailureException,
                                       Management.DataStorageFailureException

Description copied from interface: ManagementServer

Stops the described service.

Specified by:

beginStopServiceById in interface ManagementServer

Parameters:

id - The identifier for the requested service.

Throws:

Management.DataRetrievalFailureException

Management.DataStorageFailureException

beginRestartServiceById

public final void beginRestartServiceById(java.lang.String id)
                                   throws Management.DataRetrievalFailureException,
                                          Management.DataStorageFailureException

Description copied from interface: ManagementServer

Restarts the described service.

Specified by:

beginRestartServiceById in interface ManagementServer

Parameters:

id - The identifier for the requested service.

Throws:

Management.DataRetrievalFailureException

Management.DataStorageFailureException

beginKillServiceById

public final void beginKillServiceById(java.lang.String id)
                                throws Management.DataRetrievalFailureException,
                                       Management.DataStorageFailureException

Description copied from interface: ManagementServer

Kills the described service.

Specified by:

beginKillServiceById in interface ManagementServer

Parameters:

id - The identifier for the requested service.

Throws:

Management.DataRetrievalFailureException

Management.DataStorageFailureException

enableServiceById

public final void enableServiceById(java.lang.String id)
                             throws Management.DataRetrievalFailureException,
                                    Management.DataStorageFailureException

Description copied from interface: ManagementServer

Enables the described service.

Specified by:

enableServiceById in interface ManagementServer

Parameters:

id - The identifier for the requested service.

Throws:

Management.DataRetrievalFailureException

Management.DataStorageFailureException

disableServiceById

public final void disableServiceById(java.lang.String id)
                              throws Management.DataRetrievalFailureException,
                                     Management.DataStorageFailureException

Description copied from interface: ManagementServer

Disables the described service.

Specified by:

disableServiceById in interface ManagementServer

Parameters:

id - The identifier for the requested service.

Throws:

Management.DataRetrievalFailureException

Management.DataStorageFailureException

listStatItems

public final Management.StatItem[] listStatItems()
                                          throws Management.ManagementException

Description copied from interface: ManagementServer

Retrieves an array of stat items.

Specified by:

listStatItems in interface ManagementServer

Returns:

An array of StatItem structures.

Throws:

Management.ManagementException

getStatItemById

public final Management.StatItem getStatItemById(java.lang.String id)
                                          throws Management.ManagementException

Description copied from interface: ManagementServer

Requests a StatItem structure for the stat item with the given ID.

Specified by:

getStatItemById in interface ManagementServer

Parameters:

id - The identifier for the requested stat item.

Returns:

The requested StatItem structure.

Throws:

Management.ManagementException

getStatItemByOid

public final Management.StatItem getStatItemByOid(java.lang.String oid)
                                           throws Management.ManagementException

Description copied from interface: ManagementServer

Requests a StatItem structure for the stat item with the given ID.

Specified by:

getStatItemByOid in interface ManagementServer

Parameters:

oid - The oid identifier for the requested stat item.

Returns:

The requested StatItem structure.

Throws:

Management.ManagementException

countActiveStat

public final java.lang.Integer countActiveStat(java.lang.String oid)
                                        throws Management.DataRetrievalFailureException

Description copied from interface: ManagementServer

Get count of active items.

Specified by:

countActiveStat in interface ManagementServer

Parameters:

oid - the stat type.

Throws:

Management.DataRetrievalFailureException

countActiveStats

public final int[] countActiveStats(java.lang.String[] oids)
                             throws Management.DataRetrievalFailureException

Description copied from interface: ManagementServer

Get count of active items for each item in the array.

Specified by:

countActiveStats in interface ManagementServer

Parameters:

oids - an array of stat types.

Throws:

Management.DataRetrievalFailureException

beginReadStatPlot

public final java.lang.String beginReadStatPlot(java.lang.String oid,
                                                java.lang.String interval)
                                         throws Management.StatPlotCreationErrorException,
                                                Management.FileOpenErrorException

Description copied from interface: ManagementServer

Generates a statistical plot.

Specified by:

beginReadStatPlot in interface ManagementServer

Parameters:

oid - an id for the stat server.

interval - the interval for which to plot.

Returns:

a transactionId for the plot file.

Throws:

Management.StatPlotCreationErrorException

Management.FileOpenErrorException

readStatPlot

public final byte[] readStatPlot(java.lang.String transactionId,
                                 java.lang.Integer length)
                          throws Management.FileReadErrorException

Description copied from interface: ManagementServer

Reads a statistical plot.

Specified by:

readStatPlot in interface ManagementServer

Parameters:

transactionId - the plot's file identifier.

length - the number of bytes from the image file to return.

Returns:

data from the plot's image file, or an empty array if there are no more. If the length of the result equals the count parameter, then there may be more data available. If the length of the result is less than the count parameter, then there is no more data.

Throws:

Management.FileReadErrorException

countAlarmList

public final java.lang.Integer countAlarmList(java.lang.String constraint,
                                              java.util.Map<?,?> substitutions)
                                       throws Management.InvalidArgumentException,
                                              Management.ManagementException

Description copied from interface: ManagementServer

Retrieves the count of Alarms from the DB

Specified by:

countAlarmList in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Returns:

Number of Alarms

Throws:

Management.InvalidArgumentException

Management.ManagementException

findAlarmList

public final Management.EventLog[] findAlarmList(java.lang.String constraint,
                                                 java.util.Map<?,?> substitutions,
                                                 java.lang.Integer offset,
                                                 java.lang.Integer limit,
                                                 Management.SearchOptions options)
                                          throws Management.InvalidArgumentException,
                                                 Management.ManagementException

Description copied from interface: ManagementServer

Retrieves the Active Alarms from the DB

Specified by:

findAlarmList in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

offset - the offset of the first item to return.

limit - Number of items to return

options - specifies the data fields to return and the sorting order of the results.

Returns:

An array of the Alarm Data

Throws:

Management.InvalidArgumentException

Management.ManagementException

addAlarmManager

public final Management.AlarmManager addAlarmManager(Management.AlarmManager alarmManager)
                                              throws Management.ManagementException

Description copied from interface: ManagementServer

Allows user to create AlarmComponentManager (eg SMTP, SNMP)

Specified by:

addAlarmManager in interface ManagementServer

Parameters:

alarmManager - Data for creating the AlarmComponentManager

Returns:

Created AlarmCompManager

Throws:

Management.ManagementException

updateIgnoredAlarmTypes

public final java.lang.Integer updateIgnoredAlarmTypes(java.lang.String[] alarmTypeIds,
                                                       java.lang.Boolean ignore)
                                                throws Management.InvalidArgumentException,
                                                       Management.ManagementException

Description copied from interface: ManagementServer

Allows user to ignore or not ignore alarm

Specified by:

updateIgnoredAlarmTypes in interface ManagementServer

Parameters:

alarmTypeIds - An array of OID

ignore - The boolean value indicating whether alarm should be ignored or not

Returns:

the number of records updated.

Throws:

Management.InvalidArgumentException

Management.ManagementException

updateAlarmStatus

public final void updateAlarmStatus(java.lang.String[] alarmIds,
                                    Management.EventLogStatus status)
                             throws Management.InvalidArgumentException,
                                    Management.ManagementException

Description copied from interface: ManagementServer

Allows user to change attributes of single or multiple alarams

Specified by:

updateAlarmStatus in interface ManagementServer

Parameters:

alarmIds - An array of AlarmType

status - An enum value indicating the status of the alarm

Throws:

Management.InvalidArgumentException

Management.ManagementException

countAlarmTypes

public final java.lang.Integer countAlarmTypes(java.lang.String constraint,
                                               java.util.Map<?,?> substitutions)
                                        throws Management.InvalidArgumentException,
                                               Management.ManagementException

Description copied from interface: ManagementServer

Returns the number of OID in the database.

Specified by:

countAlarmTypes in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

Returns:

the number of OIDs.

Throws:

Management.InvalidArgumentException

Management.ManagementException

findAlarmTypes

public final Management.AlarmType[] findAlarmTypes(java.lang.String constraint,
                                                   java.util.Map<?,?> substitutions,
                                                   java.lang.Integer offset,
                                                   java.lang.Integer limit,
                                                   Management.SearchOptions options)
                                            throws Management.InvalidArgumentException,
                                                   Management.ManagementException

Description copied from interface: ManagementServer

Allows user to get OID List

Specified by:

findAlarmTypes in interface ManagementServer

Parameters:

constraint - a query defining search criteria.

substitutions - data to be substitued for constraint expression.

offset - the offset of the first item to return.

limit - Number of items to return

Returns:

An array containg the OID Data.

Throws:

Management.InvalidArgumentException

Management.ManagementException

findAlarmManagers

public final Management.AlarmManager[] findAlarmManagers(java.lang.String constraint)
                                                  throws Management.ManagementException

Description copied from interface: ManagementServer

Allows user to get AlarmComponentManager

Specified by:

findAlarmManagers in interface ManagementServer

Parameters:

constraint - constraint indicating the kind of AlarmComponentManager to retrieve, such as 'cisco.uc.cuae.SmtpManager' or 'cisco.uc.cuae.SnmpManager'

Returns:

An array containg the AlarmCompManager Data. For now the array will contain one value per type.

Throws:

Management.ManagementException

removeAlarmManagerById

public final void removeAlarmManagerById(java.lang.String id)
                                  throws Management.ManagementException

Description copied from interface: ManagementServer

Allows user to delete AlarmManager given its id.

Specified by:

removeAlarmManagerById in interface ManagementServer

Parameters:

id - Id of the Alarm Manager to delete

Throws:

Management.ManagementException