| Oracle® Application Server Advanced Web Services Developer's Guide 10g Release 3 (10.1.3) B25603-01 |
|
 Previous |
 Next |
| Oracle® Application Server Advanced Web Services Developer's Guide 10g Release 3 (10.1.3) B25603-01 |
|
Previous |
Next |
An MBean, or "managed bean", is a Java object that represents a manageable resource in a distributed environment, such as an application, a service, a component, or a device.
An MBean has an exposed interface that allows a management client to control the resource. The interface is comprised of:
Attributes, values of any type that the management client can get or set. Attributes are analogous to properties set on a JavaBean.
Operations, methods with any signature and any return type that the client can invoke.
Notifications that can be generated when specific events occur.
The individual MBean descriptions provide more detailed information on the attributes, operations, and notifications that are available for them.
The following sections describe the MBeans that pertain to Oracle Application Server Web Services and how they are initialized within its environment.
This section provides a description of the components that define the functionality of an MBean and a summary of the MBeans that are available for OracleAS Web Services.
The name of an MBean consists of a number of components, such as J2EEApplication, WebServicePort, handler, and so on. The value of the components are set when the MBean is registered with the MBean server. The full name of an MBean will be displayed in Applications Server Control when you access it. Table C-1 describes the values of the MBean components.
Table C-1 Definitions of JMX MBean Name Components
| Component Value | Description |
|---|---|
|
{application} |
The name given to the application (that is, the EAR file) when it was deployed. This value can be found in the |
|
{web-module} |
The name given to the Web module within the application's deployment descriptor. This value can be found as the value of the |
|
{service} |
The name of the Web service as described by the service's deployment descriptor. This value can be found in the |
|
{port} |
The name of the Web service port as described by the service's deployment descriptor. This value can be found in the |
|
{operation} |
The name of the Web service operation as described by the service's deployment descriptor. This value can be found in the |
|
{interceptor} |
This value identifies the interceptor. The possible values currently are |
*:j2eeType=WebServicePort, J2EEApplication={application}, WebModule={web-module}, WebService={service}, name={port},*
This MBean provides for the management of a Web service endpoint in the run-time. Specifically, this MBean provides information about the Web service port's structure, state, and performance. It also allows for the endpoint to be temporarily stopped and restarted.
Attributes: address, implementationType, path, state, stats, style, wsdl
Operations: start, stop
Statistics: ActiveRange, TotalFault, ServiceTime
Notifications: j2ee.state.running, j2ee.state.stopped
*:j2eeType=WebServiceOperation, J2EEApplication={application}, WebModule={web-module}, WebService={service}, WebServicePort={port}, name={operation}
This MBean provides for the observation and management of each operation of a Web service endpoint. Many of the attributes also provide information about the implementation of the operation.
Attributes: inputEncoding, outputEncoding, overloaded, sampleRequest, sampleResponse, stats, testPagePath, testPageURL
Statistics: RequestSize, ResponseSize, ActiveRange, FaultCount, ServiceTime
*:j2eeType=WSMServiceConfig, J2EEApplication={application}, WebModule={web-module}, WebService={service}, WebServicePort={port}, *
This MBean is used only to create a hierarchy of MBeans within the system. It represents the port level configuration for all interceptors associated with each Web service port. There are however no useful attributes or operations provided by this MBean.
*:j2eeType=WSMOperationConfig, J2EEApplication={application}, WebModule={web-module}, WebService={service}, WebServicePort={port}, operation={operation}, *
This MBean is used only to create a hierarchy of MBeans within the system. It represents the operation level configuration for all interceptors associated with each Web service operation. There are, however, no useful attributes or operations provided by this MBean.
*:j2eeType=WSMHandlerGlobalConfig, handler={interceptor}, *
This MBean provides the ability to get, set, and validate the global configuration settings for each individual interceptor. Currently only the security and reliability interceptors utilize global configuration.
Attributes: stagedConfig, deployedConfig
Operations: validateConfig
*:j2eeType=WSMHandlerServiceConfig, J2EEApplication={application}, WebModule={web-module}, WebService={service}, WebServicePort={port}, handler={interceptor}, *
This MBean provides access to the port level configuration of each interceptor. Each interceptor may also be enabled or disabled for the Web service port for the MBean by using the stagedEnabled attribute. The other attributes and operation allow the configuration to be retrieved, set and validated.
Attributes: stagedEnabled, stagedConfig, deployedConfig
Operations: validateConfig
*:j2eeType=WSMHandlerOperationConfig, J2EEApplication={application}, WebModule={web-module}, WebService={service}, WebServicePort={port}, handler={interceptor}, operation={operation}, *
This MBean provides access to the operation level configuration of each interceptor. This MBean can be used to retrieve, set and validate the configuration.
Attributes: stagedConfig, deployedConfig
Operations: validateConfig
The OracleAS Web Services runtime for the current release is implemented as a servlet; it relies upon the servlet container for the management of its life cycle. JMX MBeans are created and registered as part of the Servlet init method of the Web service runtime. Depending on the configuration of the web.xml deployment descriptor in the J2EE Web Archive (that is, the WAR file), the servlet container may not initialize the Web service servlet until the first request to the servlet is encountered.
To instruct the servlet container to initialize the servlet when the Web service is deployed or the container starts, set the load-on-startup element in the web.xml deployment descriptor to a nonzero value. For example:
<load-on-startup>1</load-on-startup>
This will result in the JMX MBean for the Web service being available as early as possible.
OracleAS Web Services recommends that all Web services deployed on the current release provide the <load-on-startup>1</load-on-startup> setting in their web.xml deployment descriptor. This will ensure that the Application Server Control application works correctly.
