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 NameIf 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"
    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
    • 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"
    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
    • 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"
    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
    • 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"
    ParametersObject [] {  resourceIdroleName }

    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.

    SignatureString [] { "java.lang.String", "java.lang.String" }
    ReturnsProperties
    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 resource 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"
    ParametersObject [] {  resourceIdroleName }

    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.

    SignatureString [] { "java.lang.String", "java.lang.String" }
    ReturnsProperties
    Exceptions
    • weblogic.management.utils.InvalidParameterException

    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
    • weblogic.management.utils.InvalidCursorException

    isSet

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

       
    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

    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"
    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 role definitions.

    SignatureString [] { "java.lang.Integer" }
    ReturnsString
    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"
    ParametersObject [] {  resourceIdmaximumToReturn }

    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.

    SignatureString [] { "java.lang.String", "java.lang.Integer" }
    ReturnsString
    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"
    ParametersObject [] {  resourceIdmaximumToReturn }

    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.

    SignatureString [] { "java.lang.String", "java.lang.Integer" }
    ReturnsString
    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"
    ParametersObject [] {  resourceIdmaximumToReturn }

    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.

    SignatureString [] { "java.lang.String", "java.lang.Integer" }
    ReturnsString
    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"
    ParametersObject [] {  applicationNamemaximumToReturn }

    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.

    SignatureString [] { "java.lang.String", "java.lang.Integer" }
    ReturnsString
    Exceptions
    • weblogic.management.utils.NotFoundException
    • weblogic.management.utils.InvalidParameterException

    listRolesByComponent

    Obtain an list of role definitions for a specific Java EE 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"
    ParametersObject [] {  componentNamecomponentTypeapplicationNamemaximumToReturn }

    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.

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.Integer" }
    ReturnsString
    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"
    ParametersObject [] {  resourceTypemaximumToReturn }

    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.

    SignatureString [] { "java.lang.String", "java.lang.Integer" }
    ReturnsString
    Exceptions
    • weblogic.management.utils.NotFoundException
    • weblogic.management.utils.InvalidParameterException

    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.

    wls_getDisplayName

    Returns the display name of an MBean.

    Deprecated 9.0.0.0

       
    Operation Name"wls_getDisplayName"
    Parametersnull
    Signaturenull
    ReturnsString