DefaultRoleMapperMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean represents configuration attributes for the WebLogic Role Mapping provider.

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.DefaultRoleMapperMBean
   
Factory Methods No factory methods. Instances of this MBean are created automatically.

Related MBeans

This section describes attributes that provide access to other 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.

       
    Privileges Read only    
    Type RealmMBean
    Relationship type: Reference.

    Attributes

    This section describes the following attributes:

     

    Description

    Description of the WebLogic Role Mapping provider.

       
    Privileges Read only    
    Type java.lang.String
    Default Value WebLogic Role Mapping Provider
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

     

    Name of

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

     

    ProviderClassName

    Name of WebLogic Role Mapping provider.

       
    Privileges Read only    
    Type java.lang.String
    Default Value weblogic.security.providers.authorization.DefaultRoleMapperProviderImpl
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

     

    RoleDeploymentEnabled

    Returns whether this Role Mapping provider stores roles that are created while deploying a Web application or EJB.

       
    Privileges Read/Write    
    Type boolean
    Default Value true

     

    SupportedExportConstraints

    The security roles you want to be exported from this Role Mapping provider's database. If none are specified, all are exported.

       
    Privileges Read only    
    Type class 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 Role Mapping provider.

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

     

    SupportedImportConstraints

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

       
    Privileges Read only    
    Type class 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 Role Mapping provider from which the security roles were originally exported.

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

     

    Version

    The version number of the WebLogic Role Mapping provider.

       
    Privileges Read only    
    Type java.lang.String
    Default Value 1.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"    
    Parameters Object [] {  cursor }

    where:

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

      - The cursor returned from a previous list method.

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

    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"    
    Parameters Object [] {  cursor }

    where:

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

      - The cursor returned from a previous list method.

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

    createRole

    Creates role for a resource.

    Operation Name "createRole"    
    Parameters Object [] {  resourceId, roleName, expression, auxiliary }

    where:

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

      - The resource that scopes the new role. Each resource has its predefined 'hierachy'. This new role is applicable to all of the given resouce's descendants if any. A null indicates a global role, no scoping resource, which applies to all resources within the container.

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

      - The name of the role that this method creates. A null value will trigger NullPointerException.

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

      - The expression policy designates which user or group having this named 'role'. A null value indicates this role is not granted to anyone.

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

      - Auxiliary data to support WLP.

    Signature String [] { "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.AlreadyExistsException

    • weblogic.management.utils.CreateException

     

    createRole

    Creates role for a resource.

    Operation Name "createRole"    
    Parameters Object [] {  resourceId, roleName, expression }

    where:

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

      - The resource that scopes the new role. Each resource has its predefined 'hierachy'. This new role is applicable to all of the given resouce's descendants if any. A null indicates a global role, no scoping resource, which applies to all resources within the container.

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

      - The name of the role that this method creates. A null value will trigger NullPointerException.

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

      - The expression policy designates which user or group having this named 'role'. A null value indicates this role is not granted to anyone.

    Signature String [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.AlreadyExistsException

    • weblogic.management.utils.CreateException

     

    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"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
    Returns void
    Exceptions

    • weblogic.management.utils.InvalidParameterException

    • weblogic.management.utils.ErrorCollectionException

     

    exportResource

    Exports provider specific role 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 <code>java.lang.Exceptions</code;>.

    Operation Name "exportResource"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.InvalidParameterException

    • weblogic.management.utils.ErrorCollectionException

     

    getCurrentProperties

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

    Operation Name "getCurrentProperties"    
    Parameters Object [] {  cursor }

    where:

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

      - The cursor returned from a previous list method.

    Signature String [] { "java.lang.String" }
    Returns Properties
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

    getRegisteredPredicates

    Returns an array of class names of the registered predicates.

    Operation Name "getRegisteredPredicates"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String" }
    Returns class

     

    getRole

    Obtain a role definition. A null is returned when no role is found.

    The Properties is the same as those returned from the PropertiesListerMBean.

    Operation Name "getRole"    
    Parameters Object [] {  resourceId, roleName }

    where:

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

      - a security resource identifier.

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

      - a role name.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns Properties
    Exceptions

    • weblogic.management.utils.InvalidParameterException

     

    getRoleAuxiliary

    Get auxiliary role for a resource.

    Operation Name "getRoleAuxiliary"    
    Parameters Object [] {  resourceId, roleName }

    where:

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

      - The resource that scopes the role.

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

      - The name of the role that this method sets the auxiliary on. A null value will trigger NullPointerException.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

    • javax.management.MBeanException

     

    getRoleExpression

    Returns the expression that defines the role granting policy.

    Operation Name "getRoleExpression"    
    Parameters Object [] {  resourceId, roleName }

    where:

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

      - The resource that scopes the new role. Each resource has its predefined 'hierachy'. This new role is applicable to all of the given resouce's descendants if any. A null indicates a global role, no scoping resource, which applies to all resources within the container.

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

      - The role for which this method returns the role granding expression. A null value will trigger NullPointerException.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

     

    getRoleNames

    Returns array of resource/role name tuples of roles defined in the scope of resources of the given type or global roles, when the type is null.

    Operation Name "getRoleNames"    
    Parameters Object [] {  resourceType }

    where:

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

      - The resource type, or null to get global roles

    Signature String [] { "java.lang.String" }
    Returns class

     

    getRoleScopedByResource

    Obtain a role definition for a role scoped by a specified resource. This may result in a global role definition.

    If the role is defined at the specified resouce then a call to getRole would return the same result.

    A null is returned when no role is found.

    The Properties object is the same as those returned from the PropertiesListerMBean.

    Operation Name "getRoleScopedByResource"    
    Parameters Object [] {  resourceId, roleName }

    where:

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

      - a security resource identifier.

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

      - a role name.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns Properties
    Exceptions

    • weblogic.management.utils.InvalidParameterException

     

    haveCurrent

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

    Operation Name "haveCurrent"    
    Parameters Object [] {  cursor }

    where:

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

      - The cursor returned from a previous list method.

    Signature String [] { "java.lang.String" }
    Returns boolean
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

    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"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
    Returns void
    Exceptions

    • weblogic.management.utils.InvalidParameterException

    • weblogic.management.utils.ErrorCollectionException

     

    isRegisteredPredicate

    Whether or not the predicate with specified class name is registered.

    Operation Name "isRegisteredPredicate"    
    Parameters Object [] {  predicateClassName }

    where:

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

      The name of the Java class that implements the predicate.

    Signature String [] { "java.lang.String" }
    Returns boolean

     

    isSet

    Returns true if the specified attribute has been set explicitly in this MBean instance.

    Operation Name "isSet"    
    Parameters Object [] {  propertyName }

    where:

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

      property to check

    Signature String [] { "java.lang.String" }
    Returns boolean
    Exceptions

    • java.lang.IllegalArgumentException

     

    listAllRoles

    Obtain an unsorted list of role 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 "listAllRoles"    
    Parameters Object [] {  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 role definitions.

    Signature String [] { "java.lang.Integer" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

     

    listAllRolesAndURIs

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

    Operation Name "listAllRolesAndURIs"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns class

     

    listChildRoles

    Obtain a list of role 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 "listChildRoles"    
    Parameters Object [] {  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 role definitions.

    Signature String [] { "java.lang.String", "java.lang.Integer" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

    • weblogic.management.utils.InvalidParameterException

     

    listRepeatingActionsRoles

    Obtain a list of role 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.

    Operation Name "listRepeatingActionsRoles"    
    Parameters Object [] {  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 role definitions.

    Signature String [] { "java.lang.String", "java.lang.Integer" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

    • weblogic.management.utils.InvalidParameterException

     

    listRoles

    Obtain a list of role definitions for a specific 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 "listRoles"    
    Parameters Object [] {  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 role definitions.

    Signature String [] { "java.lang.String", "java.lang.Integer" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

    • weblogic.management.utils.InvalidParameterException

     

    listRolesByApplication

    Obtain an list of role 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 "listRolesByApplication"    
    Parameters Object [] {  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 role definitions.

    Signature String [] { "java.lang.String", "java.lang.Integer" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

    • weblogic.management.utils.InvalidParameterException

     

    listRolesByComponent

    Obtain an list of role 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 "listRolesByComponent"    
    Parameters Object [] {  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 role definitions.

    Signature String [] { "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.Integer" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

    • weblogic.management.utils.InvalidParameterException

     

    listRolesByResourceType

    Obtain an list of role 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 "listRolesByResourceType"    
    Parameters Object [] {  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 role definitions.

    Signature String [] { "java.lang.String", "java.lang.Integer" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException

    • weblogic.management.utils.InvalidParameterException

     

    listRolesForResource

    Lists the role names that are scoped by a resource. Returns a null list if there are no roles under this resource scoping.

    Operation Name "listRolesForResource"    
    Parameters Object [] {  resourceId }

    where:

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

      - A resource identifier. A null value specifies a global role.

    Signature String [] { "java.lang.String" }
    Returns class

     

    registerPredicate

    Registers a new predicate with the specified class name.

    Operation Name "registerPredicate"    
    Parameters Object [] {  predicateClassName }

    where:

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

      The name of the Java class that implements the predicate.

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.InvalidPredicateException

    • weblogic.management.utils.AlreadyExistsException

     

    removeRole

    Removes a role from a resource.

    Operation Name "removeRole"    
    Parameters Object [] {  resourceId, roleName }

    where:

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

      - The resource that scopes the role. Each role has a scoping resource. A null indicates a global role.

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

      - The role that this method removes. A null value will trigger NullPointerException.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.NotFoundException

    • weblogic.management.utils.RemoveException

     

    roleExists

    Indicates whether a role exists.

    Operation Name "roleExists"    
    Parameters Object [] {  resourceId, roleName }

    where:

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

      - The resource that scopes the role. Each role has a scoping resource. A null indicates a global role.

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

      - The role for which this method searches.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns boolean

     

    setRoleAuxiliary

    Set auxiliary role for a resource.

    Operation Name "setRoleAuxiliary"    
    Parameters Object [] {  resourceId, roleName, auxiliary }

    where:

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

      - The resource that scopes the role.

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

      - The name of the role that this method sets the auxiliary on. A null value will trigger NullPointerException.

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

      - Auxiliary data to support WLP.

    Signature String [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.AlreadyExistsException

    • weblogic.management.utils.CreateException

    • javax.management.MBeanException

     

    setRoleExpression

    Sets the policy expression for a role.

    Operation Name "setRoleExpression"    
    Parameters Object [] {  resourceId, roleName, expression }

    where:

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

      - The resource that scopes the new role. Each resource has its predefined 'hierachy'. This role is applicable to all of the given resouce's descendants if any. A null indicates a global role, no scoping resource, which applies to all resources within the container.

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

      - The name of the role for which this method replaces a policy. A null value will trigger NullPointerException.

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

      - The expression policy designates which user or group having this named 'role'. A null value indicates this role is not granted to anyone.

    Signature String [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.NotFoundException

    • weblogic.management.utils.CreateException

     

    unregisterPredicate

    Unregisters the currently registered predicate.

    Operation Name "unregisterPredicate"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • weblogic.management.utils.NotFoundException

     

    unSet

    Restore the given property to its default value.

    Operation Name "unSet"    
    Parameters Object [] {  propertyName }

    where:

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

      property to restore

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • java.lang.IllegalArgumentException
      UnsupportedOperationException if called on a runtime implementation.

     

    wls_getDisplayName

    Operation Name "wls_getDisplayName"    
    Parameters null
    Signature null
    Returns String