RoleListerMBean (Abstract)

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Provides a set of methods for listing data about roles. An Authorization-provider MBean can optionally extend this MBean. The WebLogic Server Administration Console detects when an Authorization provider extends this MBean and automatically provides a GUI for using these methods.

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.management.security.authorization.RoleListerMBean
   
Factory Methods No factory methods. Instances of this MBean are created automatically.    
Subtypes The following MBeans extend or implement this MBean type:

    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

     

    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

     

    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

     

    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

     

    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

     

    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

     

    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