PolicyListerMBean (Abstract)

Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

Provides a set of methods for listing data about policies. 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.PolicyListerMBean

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

    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

    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

    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

    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

    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

    wls_getDisplayName

       
    Operation Name"wls_getDisplayName"
    Parametersnull
    Signaturenull
    ReturnsString