NoSQLResourceBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Root descriptor bean for a WebLogic NoSQL system resource.

Descriptor changes are dynamic. Compatible provider-property changes replace provider runtimes without invalidating application manager or repository handles. Changes that affect resource selection or provider compatibility invalidate affected applications, which must then be fully redeployed before using NoSQL again.

       
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.j2ee.descriptor.wl.NoSQLResourceBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


      Properties

      Returns the provider-specific configuration properties for this NoSQL resource.

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeNoSQLPropertiesBean
      Relationship type: Containment.


      Attributes

      This section describes the following attributes:


      DatabaseType

      Returns the provider-neutral Jakarta Data database type for this resource.

      The legal values identify database types that may be supported by providers installed in the domain. A legal descriptor value does not imply that every provider supports that type. When a resource is targeted, WebLogic validates the selected provider and database-type combination. Provider capabilities and available WebLogic managed runtime implementations are validated separately.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueDOCUMENT
      Legal Values
      • DOCUMENT
      • KEY_VALUE
      • COLUMN
      • GRAPH

      DefaultResource

      Returns whether this resource is eligible for default selection when a Jakarta NoSQL-backed repository omits {@code dataStore}.

      Default selection requires exactly one valid, locally targeted resource explicitly bound to the application and marked as a default.

      This setting does not establish an application binding or grant authorization.

             
      Privileges Read/Write
      Typeboolean

      JNDIName

      Returns the JNDI name assigned to this NoSQL resource.

             
      Privileges Read/Write
      Typejava.lang.String

      Name

      Returns the unique name that identifies this NoSQL resource in the WebLogic domain.

             
      Privileges Read/Write
      Typejava.lang.String

      ProviderName

      Returns the name of the NoSQL provider used by this resource.

             
      Privileges Read/Write
      Typejava.lang.String
      Legal Values
      • oracle-nosql
      • mongodb
      • dynamodb
      • couchbase
      • couchdb
      • elasticsearch
      • solr


      Operations

      This section describes the following operations:


        isSet

        Return true if the given property has been explicitly set in this bean.

           
        Operation Name"isSet"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          property to check

        SignatureString [] { "java.lang.String" }
        Returns boolean
        Exceptions
        • java.lang.IllegalArgumentException
          IllegalArgumentException if propertyName is not a recognized property

        unSet

        Restore the given property to its default value.

           
        Operation Name"unSet"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          property to restore

        SignatureString [] { "java.lang.String" }
        Returns void
        Exceptions
        • java.lang.IllegalArgumentException
          UnsupportedOperationException if called on a runtime implementation.