WLDFRESTNotificationBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Use this interface to define a REST action, which is sent when a diagnostic policy evaluates to true.

Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.

           
Since12.2.1.0.0
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.diagnostics.descriptor.WLDFRESTNotificationBean
Factory Methods
Additional Access Points In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:
    Access Points Inherited from WLDFNotificationBean Because this MBean extends or implements WLDFNotificationBean, you can also access this MBean by retrieving WLDFNotificationBeans. The following attributes contain WLDFNotificationBeans and its subtypes:


      Attributes

      This section describes the following attributes:


      AcceptedResponseType

      Configures the Accept header of the HTTP request to the REST end point. The response entity of the REST invocation is ignored by the server.

             
      Privileges Read/Write
      Typejava.lang.String
      Default Valueapplication/json
      Legal Values
      • application/json
      • text/plain
      • text/xml
      • text/html

      CustomNotificationProperties

      Allows customizing the JSON object delivered to the REST end point.

             
      Privileges Read/Write
      Typejava.util.Properties

      Enabled

      Specifies whether this action is enabled.

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      EndpointURL

      The REST end point URL which will be invoked with the action payload.

             
      Privileges Read/Write
      Typejava.lang.String

      HttpAuthenticationMode

      The HTTP authentication mode when invoking the REST end point URL.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueNone
      Legal Values
      • None
      • Basic

      HttpAuthenticationPassword

      The HTTP authentication password when the REST end point is secured.

             
      Privileges Read/Write
      Typejava.lang.String
      Encryptedtrue

      HttpAuthenticationPasswordEncrypted

      The encrypted HTTP authentication password when the REST end point is secured.

             
      Privileges Read/Write
      Typebyte[]
      Encryptedtrue

      HttpAuthenticationUserName

      The HTTP authentication user name when the REST end point is secured.

             
      Privileges Read/Write
      Typejava.lang.String

      Id

      Return the unique id of this bean instance.

             
      Privileges Read only
      Typelong
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Name

      The name of the WebLogic Diagnostic Framework (WLDF) bean.

             
      Privileges Read only
      Typejava.lang.String

      RestInvocationMethodType

      The REST method for invoking the end point.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValuePUT
      Legal Values
      • PUT
      • POST

      Timeout

      The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.

             
      Available Since Release 12.2.1.0.0
      Privileges Read/Write
      Typeint
      Default Value0
      Minimum value0