Java CAPS 管理和监视 API

服务 — JavaCAPSManagementAPI

目前提供了 10 个 Java CAPS 管理客户机 API 服务:

此外,还提供了一个目标选项。其 Java CAPS 管理客户机行为也是服务的一部分。根据所指定的值,此选项将导致以不同方式执行安装和部署命令。有关详细信息,请参见管理客户机的目标选项行为


注 –

Java CAPS 6 软件包以压缩文件形式附带提供了服务样例文件(如 AdministrationServiceSample.groovy)和目标选项行为。


管理服务

管理服务支持

表 2 管理服务方法名称和描述

API 方法名称 

描述 

getComponentInstallationDescriptor 

检索组件的 jbi.xml 部署描述符 

getSharedLibraryInstallationDescriptor 

检索共享库的 jbi.xml 部署描述符。 

getServiceAssemblyDeploymentDescriptor 

检索服务组合件的 jbi.xml 部署描述符。 

getServiceUnitDeploymentDescriptor 

检索服务单元的 jbi.xml 部署描述符。 

isJBIRuntimeEnabled 

检查是否启用了 JBI 运行时环境。 

isServiceEngine 

检查服务引擎。 

isBindingComponent 

检查绑定组件。 

getConsumingEndpoints 

检索组件的使用端点列表。 

getProvisioningEndpoints 

检索组件的置备端点列表。 

getWSDLDefinition 

检索与指定端点关联的主 WSDL。 

getWSDLImportedResource 

检索与指定端点和目标名称空间关联的 WSDL 或 XSD。 

isClassicEnterpirseManagerUp 

检查是否正在运行非 JBI 组件的 Enterprise Manager 服务器。 

运行时管理服务

运行时管理服务:

表 3 运行时管理服务方法名称和描述

API 方法名称 

描述 

isTargetUp 

检查目标(服务器、群集)是启动还是关闭。 

listServiceEngines 

列出服务引擎。 

listBindingComponents 

列出绑定组件。 

listSharedLibraries 

列出共享库。 

listServiceAssemblies 

列出服务组合件。 

showServiceEngine 

显示符合不同选项的服务引擎。 

showBindingComponent 

显示符合不同选项的绑定组件。 

showSharedLibrary 

显示符合不同选项的共享库。 

showServiceAssembly 

显示符合不同选项的服务组合件。 

listComponents 

检索组件列表。 

getState 

检索运行时组件的状态(如 UP、DOWN、UNKNOWN 等)。 

getProperties 

检索组件的属性列表。 

startComponent 

启动组件。 

stopComponent 

停止组件。 

restartComponent 

重新启动组件。 

shutdownComponent 

关闭组件。 

startServiceAssembly 

启动服务组合件。 

stopServiceAssembly 

停止服务组合件。 

shutdownServiceAssembly 

关闭服务组合件。 

listCompositeApplications 

检索复合应用程序列表。 

getRuntimeComponentProperties 

获取运行时单元的属性列表。 

getRuntimeComponentStatus 

获取运行时组件的状态,即,UP、DOWN、UNKNOWN 等。 

startRuntimeComponent 

启动运行时组件。 

restartRuntimeComponent 

重新启动运行时组件。 

stopRuntimecomponent 

停止运行时组件。 

listTargets 

返回可以在该域中部署的所有目标。所有组和所有服务器(不属于任何组的服务器)。 

listLifecycleModules 

列出生命周期模块。 

listExtensionModules 

列出扩展模块。 

listSystemConnectors 

列出系统连接器模块。 

listAppclientModules 

返回在指定目标上部署的所有指定类型的模块。 

listConnectorModules 

返回部署的连接器数组。 

listEjbModules 

返回在指定目标上部署的所有指定类型的模块。 

listWebModules 

返回在指定目标上部署的所有指定类型的模块。 

listJavaEEApplications 

返回部署的 JavaEE 应用程序列表。某些应用程序部署到域中并在其中进行注册。 

enableJavaEEApplication 

启用指定目标上的应用程序或模块。如果是群集,则还会启用该群集中的服务器实例的应用程序引用。 

enableAppclientModule 

启用指定目标上的应用程序或模块。如果是群集,则还会启用该群集中的服务器实例的应用程序引用。 

enableConnectorModule 

启用指定目标上的应用程序或模块。如果是群集,则还会启用该群集中的服务器实例的应用程序引用。 

enableEjbModule 

启用指定目标上的应用程序或模块。如果是群集,则还会启用该群集中的服务器实例的应用程序引用。 

enableWebModule 

启用指定目标上的应用程序或模块。如果是群集,则还会启用该群集中的服务器实例的应用程序引用。 

disableJavaEEApplication 

禁用指定目标上的应用程序或模块。如果是群集,则还会禁用该群集中的服务器实例的应用程序引用。 

disableAppclientModule 

禁用指定目标上的应用程序或模块。如果是群集,则还会禁用该群集中的服务器实例的应用程序引用。 

disableConnectorModule 

禁用指定目标上的应用程序或模块。如果是群集,则还会禁用该群集中的服务器实例的应用程序引用。 

disableEjbModule 

禁用指定目标上的应用程序或模块。如果是群集,则还会禁用该群集中的服务器实例的应用程序引用。 

disableWebModule 

禁用指定目标上的应用程序或模块。如果是群集,则还会禁用该群集中的服务器实例的应用程序引用。 

isJavaEEComponentEnabled 

返回配置中的应用程序状态。如果指定目标为 null/空/"domain",则仅使用实际应用程序的“已启用”标志。否则,使用应用程序引用的“已启用”标志来确定启用状态。 

配置服务

配置服务可用于:

表 4 配置服务方法名称和描述

API 方法名称 

描述 

getRuntimeLoggerLevels 

检索所有运行时记录程序及其级别。 

getRuntimeLoggerLevel 

查找某个运行时记录程序的级别。 

setRuntimeLoggerLevel 

设置给定运行时记录程序的日志级别。 

getComponentLoggerLevels 

检索组件自定义记录程序及其级别。 

setComponentLoggerLevel 

设置给定自定义记录程序的组件日志级别 

getComponentExtensionMBeanObjectNames 

检索扩展 MBean 对象名称。 

getComponentConfiguration 

检索组件配置。 

setComponentConfiguration 

设置组件配置。 

getRuntimeConfigurationMetaData 

返回与指定属性关联的运行时配置元数据。元数据包含名称-值对,例如,default、descriptionID、descriptorType、displayName、displayNameId、isStatic、name、resourceBundleName、tooltip、tooltipId,等等。 

setRuntimeConfiguration 

设置运行时配置。 

getRuntimeConfiguration 

检索运行时配置。 

getDefaultRuntimeConfiguration 

检索默认运行时配置。 

isServerRestartRequired 

检查是否需要重新启动服务器以应用对某些配置参数所做的更改。 

部署服务

通过使用部署服务,您可以部署和取消部署:

表 5 部署服务方法名称和描述

API 方法名称 

描述 

deployServiceAssembly 

部署服务组合件。 

deployServiceAssemblyFromDomain 

从域目标中部署服务组合件。 

undeployServiceAssembly 

取消部署服务组合件。 

deployJavaEEComponent 

将组件部署到给定的一组目标中,这些目标可以是域、群集或单独实例。由于群集和单独实例在共享部署方面存在一些限制,因此,仅将组件数据部署到列表中的第一个目标,然后为指定目标组中的其余目标创建应用程序引用。 

undeployJavaEEComponent 

从给定的一组目标中取消部署组件,这些目标可以是域、群集或单独实例。由于群集和单独实例在共享部署方面存在一些限制,因此,除了目标组中的第一个目标以外,将删除所有其他目标的应用程序引用。然后,从目标组的第一个目标中取消部署组件数据。 

安装服务

安装服务可用于:

表 6 安装服务方法名称和描述

API 方法名称 

描述 

installComponent 

安装组件(服务引擎、绑定组件)。 

uninstallComponent 

卸载组件(服务引擎、绑定组件)。 

installSharedLibrary 

安装共享库。 

uninstallSharedLibrary 

卸载共享库。 

installComponentFromDomain 

从域目标中安装组件(服务引擎、绑定组件)。 

installSharedLibraryFromDomain 

从域目标中安装共享库。 

upgradeComponent 

升级组件(服务引擎、绑定组件)。按实际使用组件的方式升级组件。在升级处理期间,将调用组件的新升级 SPI 实现,以使组件能够执行完成升级所需的任何特殊处理。如果组件未提供升级 SPI 实现,仍可使用 updateComponent API 对组件进行更新。另外,在升级实现中允许更改组件的安装描述符,但组件名称除外(原因是显而易见的)。这样,便可建立新的共享库依赖关系、更改组件 SPI 实现的类名以及更改组件的类加载首选项(类路径和类加载顺序)。无论组件是否提供了新升级 SPI 实现,都允许进行这些更改。 

性能测量服务

性能测量服务尝试为开发者和管理员描述性能特性。

表 7 性能测量服务方法名称和描述

API 方法名称 

描述 

clearPeformaceInstrumentationMeasurement 

重置端点上的性能测量。 

getPerformanceInstrumentationEnabled 

检索性能测量启用标志。 

getPerformanceInstrumentationMeasurement 

检索指定端点的性能测量数据。 

getPerformanceMeasurementCategories 

检索性能统计信息类别。数组中的每个项是复合性能数据的关键所在,它还指明了测量类型(如标准化)。 

setPerformanceInstrumentationEnabled 

设置性能测量启用标志。 

getFrameworkStatisticsAsTabularData 

此方法用于提供给定目标中的 JBI 框架统计信息。这些数据是以表格形式显示的。 

getFrameworkStatistics 

此方法用于提供给定目标中的 JBI 框架统计信息。 

getComponentStatistics 

此方法用于提供给定目标中的给定组件的统计信息。 

getComponentStatisticsAsTabularData 

此方法用于提供给定目标中的给定组件的统计信息。这些数据是以表格形式显示的。 

getEndpointStatisticsAsTabularData 

此方法用于提供有关给定目标中的给定端点的统计信息。这些数据是以表格形式显示的。 

getEndpointStatistics 

此方法用于提供有关给定目标中的给定端点的统计信息。 

getNMRStatisticsAsTabularData 

此方法用于提供有关给定目标中的消息服务的统计信息。这些数据是以表格形式显示的。 

getNMRStatistics 

此方法用于提供有关给定目标中的消息服务的统计信息。 

getServiceAssemblyStatisticsAsTabularData 

此方法用于提供有关给定目标中的服务组合件的统计信息。这些数据是以表格形式显示的。 

getServiceAssemblyStatistics 

此方法用于提供有关给定目标中的服务组合件的统计信息。 

enableMessageExchangeMonitoring 

此方法用于启用有关消息交换的计时信息监视。 

disableMessageExchangeMonitoring 

此方法用于禁用有关消息交换的计时信息监视。 

警报管理服务

表 8 警报管理服务方法名称和描述

API 方法名称 

描述 

getAlertAdministrationService 

创建并返回警报监控服务。 

getAlertConfigurationService 

创建并返回警报配置服务。 

getAlertNotificationService 

创建并返回警报通知服务。 

警报监控服务

表 9 警报监控服务方法名称和描述

API 方法名称 

描述 

getAlerts 

检索所有警报。 

getAlertFieldNames 

检索警报实例数据库字段名称列表。 

update 

根据条件更新字段值。 

delete 

从持久性存储中删除警报对象。 

observe 

将警报实例的 observationState 列表设置为已观察。 

resolved 

根据条件将警报实例的 observationState 设置为已解析。 

reset 

将警报实例的 observationState 列表设置为其初始状态(未观察)。 

UpdateComment 

更新警报的注释字段。 

resetAll 

将所有表条目的 observationState 设置为其初始状态。 

resolveAll 

将所有表条目的警报 observationState 设置为已解析状态。 

observeAll 

将所有表条目的警报 observationState 设置为已观察状态。 

警报通知服务

表 10 警报通知服务方法名称和描述

API 方法名称 

描述 

subscribe 

请求事件管理系统获取符合提供的过滤器的事件。该方法将验证回调方法名称和参数的回调对象(有关详细信息,请参见下文)。通过使用该方法,调用方可使用不同的过滤器、目标和回调参数多次进行注册。 

unsubscribe 

请求事件管理系统停止将事件转发到此客户机(根据调用方使用 subscribe 方法进行的订阅)。在所有调用方取消订阅所有 ID 后,将放弃等待传送到此客户机的任何事件。 

getSubscriptionInformation 

这是一种实用程序方法,它返回客户机用于为给定订阅 ID 订阅警报的参数。 

警报配置服务

表 11 警报配置服务方法名称和描述

API 方法名称 

描述 

enableAlertsPersistence 

在警报数据库中启用警报持久性。如果启用,在传送通道失败或重新启动应用服务器时,可提供可靠的警报传送。 

disableAlertsPersistence 

在警报数据库中禁用警报持久性。 

isAlertsPersistenceEnabled 

返回警报持久性启用操作的最终设置。如果启用,则为 true,否则为 false。 

isAlertsJournalEnabled 

返回警报日志功能启用操作的最终设置。如果启用,则为 true,否则为 false。 

setPersistenceDataSourceJndiName 

设置用于持久性的数据源数据库的 JNDI 名称。如果未至少提供一次,即使将 enableAlertsPersistence 设置为 true,也会禁用持久性。 

getPersistenceDataSourceJndiName 

返回最终设置的警报持久性数据源 JNDI 名称。 

setPersistenceDataBaseType 

设置用于持久性的数据库类型。Derby 是假定的默认数据库。如果使用其他数据库,应在启用持久性之前调用该方法。 

getPersistenceDataBaseType 

返回值表示最终设置的数据库类型。 

setPersistedAlertsMaxAge 

设置在删除持久保存的警报(作为删除策略的一部分)之前在警报数据库中存储警报的最长时间。 

getPersistedAlertsMaxAge 

返回允许持久保存的警报存留期的最终设置。如果当前时间的值为 0,则可能会导致删除所有持久保存的警报。如果使用负值,则会忽略该策略元素。 

setPersistedAlertsMaxCount 

设置在删除某个警报(作为有效删除策略的一部分)前允许持久保存的最大警报数。如果启用了持久性并将计数设置为 0,则会关闭所打开的日志功能。 

getPersistedAlertsMaxCount 

返回允许持久保存的最大警报数的最终设置。如果值为 0,则表示不持久保存任何警报。 

setPersistedAlertsLevel 

基于优先级的警报级别(作为删除策略的一部分)。优先级从低到高依次为:INFO、WARNING、MINOR、MAJOR、CRITICAL 和 FATAL。您可以选择删除提供的级别以及以下级别的所有警报。 

getPersistedAlertsLevel 

返回的值表示警报级别的最终设置,将允许从每个目标中删除持久保存的这些警报。 

setPersistedAlertsRemovelPolicy 

为删除持久保存的警报设置有效的策略。 

getPersistedAlertsRemovalPolicy 

返回的值表示在删除持久保存的警报时策略将使用的最终设置数组。如果数组为空,则表示未执行任何策略。 

enablePersistedAlertsPolicyExecution 

允许或禁止使用删除策略的功能。 

isPersistedAlertsPolicyExecutionEnabled 

返回的值表示,启用/禁用持久保存的警报删除策略的最终设置。 

setPersistedAlertsRemovelPolicyExecInterval  

设置持久保存的警报删除策略的执行间隔。 

getPersistedAlertsRemovelPolicyExecInterval 

返回的值表示,持久保存的警报删除策略的执行间隔的最终设置。 

setInMemoryAlertsCacheMaxSize 

设置在传送到注册的侦听器之前可在内存中缓存的最大警报数。 

getInMemoryAlertsCacheMaxSize 

返回的值表示,警报高速缓存中的最大内存大小的最终设置。 

setAlertTableName 

设置持久保存的警报表名。 

getPersistedAlertsCount 

返回当前持久保存的警报总数。该值是可变的,可能会发生更改。 

enableAlertsPersistence 

通过使用该 API,调用方可以在此接口中设置其他 API 中定义的所有参数。将在启用持久性之前应用所有这些设置。 

JMS 管理服务

表 12 JMS 管理服务方法名称和描述

API 方法名称 

描述 

getServerProperties 

返回服务器属性。 

isServerReady 

检查消息服务器是否准备就绪。 

getXids 

返回消息服务器上的事务列表。 

rollbackXid 

回滚消息服务器上的指定事务。 

getTopicProperties 

检索指定的主题属性。 

getTopics 

检索消息服务器上的主题列表。 

getTopicsWithHeaders 

返回消息服务器上包含标头属性的主题列表。 

getTemporaryTopics 

检索临时主题列表。 

createTopic 

在消息服务器上新建具有指定名称的指定主题。 

deleteTopic 

删除消息服务器上的指定主题。 

getTopicMessage 

返回指定主题的指定消息的消息体。 

getTopicMsgProperties 

返回指定主题的消息属性。 

getTopicMsgPropertiesList 

返回给定起始消息索引的消息及其属性列表。 

getSubscribers 

返回指定主题的订阅者列表。 

changeTopicTextMessage 

更改指定主题的指定文本消息内容。 

changeTopicBytesMessage 

更改指定主题的指定字节消息内容。 

deleteTopicMessage 

从指定主题中删除指定消息。 

getTopicMessageType 

返回指定主题中的指定消息的消息类型。 

suspendTopic 

暂停指定主题。 

resumeTopic 

恢复暂停的主题。 

submitNewMessage 

将新消息提交到消息服务器上的指定主题或队列。 

createTopicDurableSubscriber 

为消息服务器上的指定主题新建指定主题持久订阅者。 

unsubscribeDurableSubscriber 

取消订阅消息服务器上的指定持久订阅。 

republishTopicMessage 

将已记入日志的指定消息重新发送到消息服务器上的指定队列。 

getTopicStatistics 

返回消息服务器上的指定主题的统计信息。 

getQeueueProperties 

检索队列属性。 

getQueues 

检索消息服务器上的队列列表。 

getQueuesWithHeaders 

返回消息服务器上包含标头属性的队列列表。 

getTemporaryQueues 

检索临时队列列表。 

createQueue 

在消息服务器上新建具有指定名称的队列。 

deleteQueue 

删除消息服务器上的指定队列。 

getQueueMsgProperties 

返回指定主题的消息属性。 

getQueueMsgPropertiesList 

返回给定起始消息索引的消息及其属性列表。 

getQueueMessage 

返回队列的指定消息的消息体。 

getReceivers 

返回指定队列的接收者列表。 

changeQueueTextMessage 

更改队列的指定文本消息内容。 

changeQueueBytesMessage 

更改指定队列的指定字节消息内容。 

deleteQueueMessage 

从指定队列中删除指定消息。 

getQueueMessageType 

返回队列的指定消息的消息类型。 

suspendQueue 

暂停指定队列。 

resumeQueue 

恢复暂停的队列。 

resendQueueMessage 

将已记入日志的指定消息重新发布到消息服务器上的指定主题。 

getQueueStatistics 

返回消息服务器上的指定队列的统计信息。 

日志管理服务

表 13 日志管理服务方法名称和描述

API 方法名称 

描述 

getLogString 

读取页面、过滤器和搜索日志。仅以单个字符串的形式返回相应的行,而不返回任何其他元数据。 

getLog 

从日志中读取、过滤和搜索页面中的行;这些行将以图的形式返回。 

getLogAsString 

从日志中记录、过滤和搜索页面中的行;这些行将作为一个字符串返回。 

listLoggerNames 

列出在目标中注册的记录程序的名称。 

listLoggerObjectNames 

列出在目标中注册的记录程序的名称。 

isLoggerRegistered 

询问是否在目标服务器实例中注册记录程序实例。 

registerLogger 

在目标服务器实例中注册记录程序实例。 

unregisterLogger 

在目标服务器实例中取消注册记录程序实例。 

setLogFile 

设置记录程序的文件名。 

getLogFile 

获取记录程序的文件名。 

BPEL 管理服务

BPEL 管理服务支持两种类型的 API 方法名称:


注 –

这些 API 对配置服务中为 BPEL 公开的 API 提供补充。


表 14 BPEL 管理服务 API 方法名称和描述(非 JBI 组件)

API 方法名称 

描述 

getBPELInstances 

获取 BPEL 实例(如果给定可选 BPEL 流程 QName 和/或可选 BPStatus 或可选实例 ID)。如果实例 ID 存在,则忽略 BPEL 流程 QName 和 BPStatus。返回的最大实例数为 1000,用户可以为 maxRecords 指定较小的数值以限制返回的实例数。如果 BPInstanceQueryResult.overflow 为 true,则表明符合条件的实例数大于 1000,不会在结果列表中返回任何实例,用户应指定 maxRecords (<= 1000)、sortColumn 和顺序。 

getBPELInstanceActivityStatus 

获取 BPEL 实例的活动状态列表。 

getBPELProcessIds 

获取 BPEL 流程 QName(作为服务单元中的字符串)列表。 

getBPELInstanceFault 

获取错误 BPEL 实例的错误详细信息。 

getInvokerInstance 

获取调用特定 BPEL 实例的调用方(父)BPEL 实例的列表。 

getInvokeeInstance 

获取特定 BPEL 实例调用的被调用方(子)BPEL 实例的列表。 

isMonitoringEnabled 

询问是否启用监视。 

isPersistenceEnabled 

询问是否启用持久性。 

resumeInstance 

恢复给定业务流程实例的某个业务流程实例。 

terminateInstance 

终止给定业务流程实例的某个业务流程实例。 

suspendInstance 

暂停给定业务流程实例的某个业务流程实例。 

getBPELInstanceFault 

获取错误 BPEL 实例的错误详细信息。 

suspendAllInstance 

暂停 BPEL 流程的所有实例。 

resumeAllInstance 

恢复 BPEL 流程的所有实例。 

terminateAllInstance 

终止 BPEL 流程的所有实例。 

changeVariableValue 

更改 BPEL 变量值。请注意,只能更改叶节点。 

getVariableValue 

获取 BPEL 变量值。将返回 BPEL 变量的内容。 

listBPELVaraibles 

获取 BPEL 实例的 BPEL 变量信息。 

表 15 BPEL 管理服务 API 方法名称和描述(JBI 组件)

API 方法名称 

描述 

setBusinessProcessInstanceVariableValue 

在某个部件上使用 XPath 以设置属性值(如果给定业务流程实例、容器、部件、XPath 表达式和值)。 

主数据管理 (Master Data Management, MDM) 服务

该 API 服务提供了在复杂的分布式企业业务环境中集成和管理数据和应用程序的功能,其中包括以下数据管理产品:

表 16 主数据管理 (Master Data Management, MDM) 服务 API 方法名称和描述

API 方法名称 

描述 

listApplicationNames 

返回当前部署的 MDM 应用程序列表。 

getApplicationStatus 

返回 MDM 应用程序状态。 

getDatabaseStatus 

返回数据库连接状态。 

getWebModuleStatus 

返回 MDM Web 应用程序模块状态。 

Sun 适配器管理服务

表 17 Sun 适配器管理服务 API 方法名称和描述

API 方法名称 

描述 

start 

启动组件;此操作的语义由实现进行定义。 

restart 

重新启动组件;此操作的语义由实现进行定义。 

stop 

停止组件;此操作的语义由实现进行定义。 

getStatus 

返回状态。 

getProperties 

返回属性。 

isStartable 

确定是否向用户显示“启动”按钮。 

isRestartable 

确定是否向用户显示“重新启动”按钮。 

isStoppable 

确定是否向用户显示“停止”按钮。 

getType 

返回适配器所监视的组件的类型。 

getConfiguration 

返回适配器所监视的组件的配置。  

getState 

返回适配器所监视的组件的状态。 

getTargetState 

返回适配器所监视的组件的目标状态。这是适配器组件的当前状态或将要变为的状态。此状态可能不同于 getState() 返回的状态。 

getRAConfiguration 

返回适配器的元数据详细信息。 

管理客户机的目标选项行为

--target 选项导致以不同方式执行安装和部署命令。根据指定的选项值,这些差异可能是非常大的。


注 –

其中的两个目标选项名称为常量:"server" 和 "domain"。它们表示一个运算符实例,可以将其替换为特定于当前模板的名称。


表 18 目标选项值和行为

选项值  

行为 

server

针对嵌入的域管理服务器 (Domain Administration Server, DAS) 实例执行命令。 

domain

如果目标选项为文字字符串 domain,则针对该域本身执行组件,而不是针对该域上运行的任何实例或群集。此选项值仅适用于安装或部署命令。

群集名称 

如果指定了群集名称,则针对指定群集中的所有实例执行命令。 

实例名称 

如果指定了实例名称,则针对指定的特定实例执行命令。