DefaultAuthorizerMBean

Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

This MBean represents configuration attributes for the WebLogic Authorization provider.Deprecation of MBeanHome and Type-Safe InterfacesThis is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Fully Qualified Interface Name

If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.security.providers.authorization.DefaultAuthorizerMBean

Factory Methods

No factory methods. Instances of this MBean are created automatically.

Access Points Inherited from AuthorizerMBean

Because this MBean extends or implements AuthorizerMBean, you can also access this MBean by retrieving AuthorizerMBeans. The following attributes contain AuthorizerMBeans and its subtypes:

    Child MBeans

    This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

      Realm

      Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeRealmMBean

      Attributes

      This section describes the following attributes:

      Description

      A short description of the WebLogic Authorization provider.

             
      Privileges Read only
      Typejava.lang.String
      Default ValueWebLogic Authorization Provider
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Name

             
      Privileges Read only
      Typejava.lang.String
      Default ValueDefaultAuthorizer
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      PolicyDeploymentEnabled

      Returns whether this Authorization provider stores policies that are created while deploying a Web application or EJB.

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      ProviderClassName

      The name of this WebLogic Authorization provider.

             
      Privileges Read only
      Typejava.lang.String
      Default Valueweblogic.security.providers.authorization.DefaultAuthorizationProviderImpl
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedExportConstraints

      The security policies that you want exported from this Authorization provider's database. If none are specified, all are exported.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedExportFormats

      The format of the file to export. The list of supported export formats is determined by this Authorization provider.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value DefaultAtz
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedImportConstraints

      The security policies that you want to be imported into this Authorization provider's database. If none are specified, all are imported.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedImportFormats

      The format of the file to import. The list of supported import formats is determined by the Authorization provider from which the security policies were originally exported.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value DefaultAtz
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Version

      The version of the WebLogic Authorization provider.

             
      Privileges Read only
      Typejava.lang.String
      Default Value1.0
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Operations

      This section describes the following operations:

      advance

      Advances the list to the next element in the list.

         
      Operation Name"advance"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor returned from a previous list method.
      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions

      close

      Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.

         
      Operation Name"close"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor returned from a previous list method.
      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions

      createPolicy

      Creates a policy for accessing a resource.

         
      Operation Name"createPolicy"
      ParametersObject [] {  resourceId, expression }

      where:

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

        - The ID of the resource. A null value will trigger NullPointerException.

        For information about creating resources, refer to the Javadoc for weblogic.security.spi.Resource.

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

        - The expression that determines the type of access this policy allows to the resource. A null value prohibits any type of access.
      SignatureString [] { "java.lang.String", "java.lang.String" }
      Returns void

      Exceptions

      exportData

      Exports provider specific data in a specified format. When errors occur, the MBean throws an ErrorCollectionException containing a list of java.lang.Exceptions, where the text of each exception describes the error.

         
      Operation Name"exportData"
      ParametersObject [] {  format, filename, constraints }

      where:

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

        - The format for exporting provider specific data.

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

        - The full path to the filename used to write data.

      • constraints is an object of type java.util.Properties that specifies:

        - The constraints to be used when exporting data. A null value indicates that all data will be exported.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
      Returns void

      Exceptions

      exportResource

      Exports provider specific policy data using an LDAP CN search filter to specify the resources for export. When errors occur, the MBean throws an ErrorCollectionException containing a list of java.lang.Exceptions.

         
      Operation Name"exportResource"
      ParametersObject [] {  filename, cn }

      where:

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

        - The full path to the filename used to write data.

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

        - The LDAP CN to be used when exporting data.
      SignatureString [] { "java.lang.String", "java.lang.String" }
      Returns void

      Exceptions

      getCurrentProperties

      The properties of the current item in the list. Returns null if there is no current item.

         
      Operation Name"getCurrentProperties"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor returned from a previous list method.
      SignatureString [] { "java.lang.String" }
      ReturnsProperties

      Exceptions

      getPolicy

      Obtain a policy definition for a resource. A null is returned when no policy is found. <p> The PropertiesPropertiesListerMBean.

         
      Operation Name"getPolicy"
      ParametersObject [] {  resourceId }

      where:

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

        - a security resource identifier.
      SignatureString [] { "java.lang.String" }
      ReturnsProperties

      Exceptions

      getPolicyExpression

      Returns the expression of an existing policy.

         
      Operation Name"getPolicyExpression"
      ParametersObject [] {  resourceId }

      where:

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

        - The resource for which this method returns the policy expression. A null value will trigger NullPointerException.
      SignatureString [] { "java.lang.String" }
      ReturnsString

      Exceptions

      getRegisteredPredicates

      Returns an array of class names of the registered predicates.

         
      Operation Name"getRegisteredPredicates"
      ParametersObject [] {  nameFilter }

      where:

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

        - A string filter which can contain the wildcard (*) character and the backslash (/) escape character.
      SignatureString [] { "java.lang.String" }
      Returns class

      getResourceNames

      Returns resource names of policies associated with resources of the given type.

         
      Operation Name"getResourceNames"
      ParametersObject [] {  resourceType }

      where:

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

        - The resource type.
      SignatureString [] { "java.lang.String" }
      Returns class

      haveCurrent

      Returns true if there are more objects in the list, and false otherwise.

         
      Operation Name"haveCurrent"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor returned from a previous list method.
      SignatureString [] { "java.lang.String" }
      Returns boolean

      Exceptions

      importData

      Imports provider specific data from a specified format. When errors occur, the MBean throws an ErrorCollectionException containing a list of java.lang.Exceptions, where the text of each exception describes the error.

         
      Operation Name"importData"
      ParametersObject [] {  format, filename, constraints }

      where:

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

        - The format for importing provider specific data.

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

        - The full path to the filename used to read data.

      • constraints is an object of type java.util.Properties that specifies:

        - The constraints to be used when importing data. A null value indicates that all data will be imported.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
      Returns void

      Exceptions

      isRegisteredPredicate

      Specifies whether or not the predicate with specified class name is registered.Deprecation of MBeanHome and Type-Safe InterfacesThis is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

         
      Operation Name"isRegisteredPredicate"
      ParametersObject [] {  predicateClassName }

      where:

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

        - The name of the Java class that implements the predicate.
      SignatureString [] { "java.lang.String" }
      Returns boolean

      listAllPolicies

      Obtain an unsorted list of policy definitions.

      This method returns a cursor that you can pass to the methods from weblogic.management.utils.PropertiesListerMBean (which this MBean extends) to iterate through the returned list.

         
      Operation Name"listAllPolicies"
      ParametersObject [] {  maximumToReturn }

      where:

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of entires to return. Use 0 to return all policy definitions.
      SignatureString [] { "java.lang.Integer" }
      ReturnsString

      Exceptions

      listAllURIs

      List all URI strings that have policy defined for the specified application and context path.

         
      Operation Name"listAllURIs"
      ParametersObject [] {  application, contextPath }

      where:

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

        - The name of the deployed application.

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

        - The context path for the application.
      SignatureString [] { "java.lang.String", "java.lang.String" }
      Returns class

      listChildPolicies

      Obtain a list of policy definitions for the children of a resource.

      This method returns a cursor that you can pass to the methods from weblogic.management.utils.PropertiesListerMBean (which this MBean extends) to iterate through the returned list.

         
      Operation Name"listChildPolicies"
      ParametersObject [] {  resourceId, maximumToReturn }

      where:

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

        - a security resource identifier.

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of entires to return. Use 0 to return all policy definitions.
      SignatureString [] { "java.lang.String", "java.lang.Integer" }
      ReturnsString

      Exceptions

      listPoliciesByApplication

      Obtain an list of policy definitions by application name.

      This method returns a cursor that you can pass to the methods from weblogic.management.utils.PropertiesListerMBean (which this MBean extends) to iterate through the returned list.

         
      Operation Name"listPoliciesByApplication"
      ParametersObject [] {  applicationName, maximumToReturn }

      where:

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

        - The name of the application.

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of entires to return. Use 0 to return all policy definitions.
      SignatureString [] { "java.lang.String", "java.lang.Integer" }
      ReturnsString

      Exceptions

      listPoliciesByComponent

      Obtain an list of policy definitions for a specific J2EE component.

      This method returns a cursor that you can pass to the methods from weblogic.management.utils.PropertiesListerMBean (which this MBean extends) to iterate through the returned list.

         
      Operation Name"listPoliciesByComponent"
      ParametersObject [] {  componentName, componentType, applicationName, maximumToReturn }

      where:

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

        - The name of the component.

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

        - The component type.

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

        - The name of the application.

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of entires to return. Use 0 to return all policy definitions.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.Integer" }
      ReturnsString

      Exceptions

      listPoliciesByResourceType

      Obtain an list of policy definitions by resource type.

      This method returns a cursor that you can pass to the methods from weblogic.management.utils.PropertiesListerMBean (which this MBean extends) to iterate through the returned list.

         
      Operation Name"listPoliciesByResourceType"
      ParametersObject [] {  resourceType, maximumToReturn }

      where:

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

        - The name of the resource type specified by a weblogic.security.spi.Resource object.

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of entires to return. Use 0 to return all policy definitions.
      SignatureString [] { "java.lang.String", "java.lang.Integer" }
      ReturnsString

      Exceptions

      listRepeatingActionsPolicies

      Obtain a list of policy definitions for the actions that are repeating on a resource.

      This method returns a cursor that you can pass to the methods from weblogic.management.utils.PropertiesListerMBean (which this MBean extends) to iterate through the returned list.

      Obtain a list of policy definitions for the actions that are repeating on a resource.

         
      Operation Name"listRepeatingActionsPolicies"
      ParametersObject [] {  resourceId, maximumToReturn }

      where:

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

        - a security resource identifier.

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of entires to return. Use 0 to return all policy definitions.
      SignatureString [] { "java.lang.String", "java.lang.Integer" }
      ReturnsString

      Exceptions

      policyExists

      Indicates whether a policy exists for a resource.

         
      Operation Name"policyExists"
      ParametersObject [] {  resourceId }

      where:

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

        - The resource within which this method searches for a policy. A null value will trigger NullPointerException.
      SignatureString [] { "java.lang.String" }
      Returns boolean

      registerPredicate

      Registers a new predicate with the specified class name.

         
      Operation Name"registerPredicate"
      ParametersObject [] {  predicateClassName }

      where:

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

        - The name of the Java class that implements the predicate.
      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions

      removePolicy

      Removes a policy.

         
      Operation Name"removePolicy"
      ParametersObject [] {  resourceId }

      where:

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

        - The resource for which this method removes a policy. A null value may trigger NullPointerException.
      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions

      setPolicyExpression

      Sets a policy expression for a resource.

         
      Operation Name"setPolicyExpression"
      ParametersObject [] {  resourceId, expression }

      where:

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

        - The resource for which this method sets the policy expression. A null value will trigger NullPointerException.

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

        - The expression that determines the type of access this policy allows to the resource. A null value prohibits any type of access.
      SignatureString [] { "java.lang.String", "java.lang.String" }
      Returns void

      Exceptions

      unregisterPredicate

      Unregisters the currently registered predicate.

         
      Operation Name"unregisterPredicate"
      ParametersObject [] {  predicateClassName }

      where:

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

        - The name of the Java class that implements predicate to be unregistered.
      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions

      wls_getDisplayName

         
      Operation Name"wls_getDisplayName"
      Parametersnull
      Signaturenull
      ReturnsString