weblogic.management.security.authorization
Interface PolicyListerMBean

All Superinterfaces:

DescriptorBean, ListerMBean, PropertiesListerMBean, SettableBean, StandardInterface

All Known Subinterfaces:

DefaultAuthorizerMBean

public interface PolicyListerMBean
extends PropertiesListerMBean

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.

listAllPolicies

String listAllPolicies(int maximumToReturn)
                       throws NotFoundException

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.

Parameters:

maximumToReturn - - The maximum number of entires to return. Use 0 to return all policy definitions.

Throws:

NotFoundException

listPoliciesByResourceType

String listPoliciesByResourceType(String resourceType,
                                  int maximumToReturn)
                                  throws NotFoundException,
                                         InvalidParameterException

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.

Parameters:

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

maximumToReturn - - The maximum number of entires to return. Use 0 to return all policy definitions.

Throws:

NotFoundException

InvalidParameterException

listPoliciesByApplication

String listPoliciesByApplication(String applicationName,
                                 int maximumToReturn)
                                 throws NotFoundException,
                                        InvalidParameterException

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.

Parameters:

applicationName - - The name of the application.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all policy definitions.

Throws:

NotFoundException

InvalidParameterException

listPoliciesByComponent

String listPoliciesByComponent(String componentName,
                               String componentType,
                               String applicationName,
                               int maximumToReturn)
                               throws NotFoundException,
                                      InvalidParameterException

Obtain an list of policy 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.

Parameters:

componentName - - The name of the component.

componentType - - The component type.

applicationName - - The name of the application.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all policy definitions.

Throws:

NotFoundException

InvalidParameterException

listChildPolicies

String listChildPolicies(String resourceId,
                         int maximumToReturn)
                         throws NotFoundException,
                                InvalidParameterException

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.

Parameters:

resourceId - - a security resource identifier.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all policy definitions.

Throws:

NotFoundException

InvalidParameterException

listRepeatingActionsPolicies

String listRepeatingActionsPolicies(String resourceId,
                                    int maximumToReturn)
                                    throws NotFoundException,
                                           InvalidParameterException

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.

Parameters:

resourceId - - a security resource identifier.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all policy definitions.

Throws:

NotFoundException

InvalidParameterException

getPolicy

Properties getPolicy(String resourceId)
                     throws InvalidParameterException

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

Parameters:

resourceId - - a security resource identifier.

Throws:

InvalidParameterException