The following sections describe the data models on which the REST resources operate. These data models describe the information exchanged in REST resources.
This entity represents errors and exceptions.
The properties of the java.lang.Throwable entity are as follows:
This property contains the stack trace of errors and exceptions.
Type: java.lang.Throwable
This property contains the reason why the error or exception was thrown.
Type: string
This entity represents a JSONObject with a property for each property in the properties object, where the key is the property's name the the value is a string containing the property's value.
The authenticated user that is making the request.
The properties of the weblogic.management.rest.bean.model.CurrentUser entity are as follows:
The ID of the partition where the component that is being invoked resides.
Type: string
The human readable name of the partition ID.
Type: string
The login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
Type: string
A Version entity describes a version of the WebLogic Server resources.
The properties of the weblogic.management.rest.bean.model.Version entity are as follows:
True if this is the default version.
Type: boolean
The lifecycle of this version: active or deprecated
Type: string
The name of this version.
Type: string
This MBean provides deployment operations for an application. Currently only start and stop are supported. In the future, this MBean may be enhanced with operations to support deployment applications to the domain as well as extended WLS deployment features such as production redeployment and partial deployment of modules in an enterprise application.
The properties of the weblogic.management.runtime.AppDeploymentRuntimeMBean entity are as follows:
The application's name.
Type: string
Constraints: Read Only, Restart Required
The application's version identifier.
Type: string
Constraints: Read Only, Restart Required
The list of modules for the application. These modules can be used in module level targeting.
Type: array of string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
The name of the partition the application is in.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Provides access to runtime state for deployed applications.
The properties of the weblogic.management.runtime.AppRuntimeStateRuntimeMBean entity are as follows:
Type: array of string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean provides deployment operations.
A DeploymentManager object is a stateless interface into the WebLogic Server deployment framework. It currently provides access to the AppDeploymentRuntimeMBeans that allow the user to start and stop deployments. In the future, this MBean may be enhanced with operations to support deployment applications to the domain, as well as extended WebLogic Server deployment features, such as production redeployment and partial deployment of modules in an enterprise application.
This MBean emits notifications when an application is created or removed and when the application state changes. The notification types are:
appdeployment.created
appdeployment.deleted
appdeployment.state.new
appdeployment.state.prepared
appdeployment.state.admin
appdeployment.state.active
appdeployment.state.retired
appdeployment.state.failed
appdeployment.state.update.pending
appdeployment.state.unknown
The userdata is the object name of the application.
The properties of the weblogic.management.runtime.DeploymentManagerMBean entity are as follows:
The maximum number of progress objects allowed.
Type: int
Constraints: Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean is the user API for monitoring deployment operations and exists only on an Administration Server. Currently only start and stop operations initiated by AppDeploymentRuntimeMBean are supported.
The properties of the weblogic.management.runtime.DeploymentProgressObjectMBean entity are as follows:
The name of the application for the current deployment operation.
Type: string
Constraints: Read Only, Restart Required
This property indicates whether an asynchronous job has completed.
Type: boolean
Provides an ordered array of status messages generated for the current deployment operation.
Type: array of string
Constraints: Read Only, Restart Required
This property indicates the time when the asynchronous job ended.
Type: java.util.Date
The targets on which the current deployment operation failed.
Type: array of string
Constraints: Read Only, Restart Required
The unique ID for the current deployment operation.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
The deployment operation type for the current deployment operation. Possible values are 1 (start) and 2 (stop).
Type: int
Constraints: Read Only, Restart Required
This property indicates whether an asynchronous job has succeeded, failed, or is in progress.
Type: string
If the current deployment operation has failed, this method may return zero or more exception(s) which represent the root cause of the failure. The array will not contain WLS exception classes; instead they will be new Exceptions containing the stack traces and messages from the original WLS Exceptions.
Type: array of java.lang.Throwable
Constraints: Read Only, Restart Required
This property indicates the time when an asynchronous job was started.
Type: java.util.Date
The time that the current deployment operation began. The value is in milliseconds consistent with the system time.
Type: long
Constraints: Read Only, Restart Required
The state of the current deployment operation. Possible values are STATE_INITIALIZED, STATE_RUNNING, STATE_COMPLETED, STATE_FAILED and STATE_DEFERRED.
Type: string
Constraints: Read Only, Restart Required
The targets specified for the current deployment operation.
Type: array of string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class is used for domain level partition handling.
The properties of the weblogic.management.runtime.DomainPartitionRuntimeMBean entity are as follows:
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
Returns partition ID value for corresponding partition.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class is used for monitoring a WebLogic domain. A domain may contain zero or more clusters. A cluster may be looked up by a logical name.
The properties of the weblogic.management.runtime.DomainRuntimeMBean entity are as follows:
Returns the domain partition runtime MBean for the "current" partition
Type: weblogic.management.runtime.DomainPartitionRuntimeMBean reference
Constraints: Read Only, Restart Required
The user-specified name of this MBean instance.
This name is included as one of the key properties in the MBean's javax.management.ObjectName
Name=user-specified-name
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.runtime.EditSessionConfigurationManagerMBean entity are as follows:
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity are as follows:
The original creator of the edit session.
Type: string
Constraints: Read Only, Restart Required
The current editor of the edit session. The editor owns the lock.
Type: string
Constraints: Read Only, Restart Required
The description of the edit session configuration.
Type: string
Constraints: Read Only, Restart Required
The name of the edit session configuration.
Type: string
Constraints: Read Only, Restart Required
The JNDI name of the related EditSessionServer
Type: string
Constraints: Read Only, Restart Required
Returns true if another edit session activates its changes after the last activation of this edit session or after its creation but before this edit session was ever activated.
It indicates that this edit session configuration is probably not the actual runtime configuration. Use the resolve method to merge changes to this configuration.
If this edit session configuration was also modified then there can be conflicts between this session and the runtime configuration. Use the resolve method to remove possible inconsistencies.
Type: boolean
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
The partition name to which this edit session belongs.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean provides deployment operations for a library..
The properties of the weblogic.management.runtime.LibDeploymentRuntimeMBean entity are as follows:
The library's implementation version, null if none is set
Type: string
Constraints: Read Only, Restart Required
The library's identifier.
Type: string
Constraints: Read Only, Restart Required
The library's name.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
The name of the partition the library is in.
Type: string
Constraints: Read Only, Restart Required
The library's specification version, null if none is set
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.runtime.PartitionLifeCycleRuntimeMBean entity are as follows:
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
The current state of the partition.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Exposes information about a long-running task related to the partition life cycle.
The properties of the weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean entity are as follows:
This property indicates whether an asynchronous job has completed.
Type: boolean
A description of this task.
Type: string
Constraints: Read Only, Restart Required
This property indicates the time when the asynchronous job ended.
Type: java.util.Date
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
Returns the name of the current operation.
Type: string
Constraints: Read Only, Restart Required
The task of which this task is a part.
A value of null indicates that this task is not a subtask.
Type: weblogic.management.runtime.TaskRuntimeMBean reference
Constraints: Read Only, Restart Required
Returns the name of the partition being operated on.
Type: string
Constraints: Read Only, Restart Required
The progress of this task.
Type: string
Constraints: Read Only, Restart Required
Indicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
This property indicates the time when an asynchronous job was started.
Type: java.util.Date
The time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
Indicates whether this task was initiated by the server versus a user.
Type: boolean
Constraints: Read Only, Restart Required
Returns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
The status of this task.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entity are as follows:
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
Current resource group state.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entity are as follows:
This property indicates whether an asynchronous job has completed.
Type: boolean
A description of this task.
Type: string
Constraints: Read Only, Restart Required
This property indicates the time when the asynchronous job ended.
Type: java.util.Date
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
Returns the name of the current operation.
Type: string
Constraints: Read Only, Restart Required
The task of which this task is a part.
A value of null indicates that this task is not a subtask.
Type: weblogic.management.runtime.TaskRuntimeMBean reference
Constraints: Read Only, Restart Required
The progress of this task.
Type: string
Constraints: Read Only, Restart Required
Returns the name of the resource group being operated on.
Type: string
Constraints: Read Only, Restart Required
Indicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
This property indicates the time when an asynchronous job was started.
Type: java.util.Date
The time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
Indicates whether this task was initiated by the server versus a user.
Type: boolean
Constraints: Read Only, Restart Required
Returns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
The status of this task.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Provides methods for retrieving runtime information about a server instance and for transitioning a server from one state to another.
The properties of the weblogic.management.runtime.ServerRuntimeMBean entity are as follows:
The address on which the Administration Server is listening for connections. For example, this might return the string: santiago
Type: string
Constraints: Read Only, Restart Required
The port on which the Administration Server is listening for connections.
Type: int
Constraints: Read Only, Restart Required
Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.
Type: boolean
Constraints: Read Only, Restart Required
The URL that clients use to connect to this server's default network channel.
The returned value indicates the default protocol, listen address and listen port:
protocol://listen-addresslisten-port
Note: The default protocol, listen address and listen port are persisted in the domain's config.xml file, however when a server instance is started, command-line options can override these persisted values. This getDefaultURL method returns the URL values that are currently being used, not necessarily the values that are specified in config.xml
The returned URL will be consistent with dynamic channel updates.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The version of this WebLogic Server instance (server).
Type: string
Constraints: Read Only, Restart Required
Exposes monitoring information about an ongoing and potentially long-running administrative process. This should be taken to mean, at minimum, any OA&M operation involving I/O. Examples include starting and stopping servers, deploying and undeploying applications, or migrating services.
An MBean operation of this sort should fork a separate thread to perform the actual work and immediately return an instance of TaskRuntimeMBean to the caller. The caller can then use this to track the task's progress as desired. Users can also query for all instances of TaskRuntimeMBean to get a summary of both currently-running and recently-completed tasks.
Instance of TaskRuntimeMBean continue to exist in the MBeanServer after the completion of the work they describe. They will eventually either be explicitly deregistered by the user, or removed by a scavenger process which periodically purges instances of TaskRuntimeMBean that have been completed for some time.
The properties of the weblogic.management.runtime.TaskRuntimeMBean entity are as follows:
This property indicates whether an asynchronous job has completed.
Type: boolean
A description of this task.
Type: string
Constraints: Read Only, Restart Required
This property indicates the time when the asynchronous job ended.
Type: java.util.Date
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required
The task of which this task is a part.
A value of null indicates that this task is not a subtask.
Type: weblogic.management.runtime.TaskRuntimeMBean reference
Constraints: Read Only, Restart Required
The progress of this task.
Type: string
Constraints: Read Only, Restart Required
Indicates whether the task is still running.
Type: boolean
Constraints: Read Only, Restart Required
This property indicates the time when an asynchronous job was started.
Type: java.util.Date
The time at which this task was started.
Type: long
Constraints: Read Only, Restart Required
Indicates whether this task was initiated by the server versus a user.
Type: boolean
Constraints: Read Only, Restart Required
Returns an exception describing the error, if any, that occurred while performing this task.
Type: java.lang.Throwable
Constraints: Read Only, Restart Required
The status of this task.
Type: string
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required