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.
Modifier and Type | Method and Description |
---|---|
Properties |
getPolicy(String resourceId)
Obtain a policy definition for a resource.
|
String |
listAllPolicies(int maximumToReturn)
Obtain an unsorted list of policy definitions.
|
String |
listChildPolicies(String resourceId,
int maximumToReturn)
Obtain a list of policy definitions for the children of a resource.
|
String |
listPoliciesByApplication(String applicationName,
int maximumToReturn)
Obtain an list of policy definitions by application name.
|
String |
listPoliciesByComponent(String componentName,
String componentType,
String applicationName,
int maximumToReturn)
Obtain an list of policy definitions for a specific Java EE component.
|
String |
listPoliciesByResourceType(String resourceType,
int maximumToReturn)
Obtain an list of policy definitions by resource type.
|
String |
listRepeatingActionsPolicies(String resourceId,
int maximumToReturn)
Obtain a list of policy definitions for the actions that are repeating on a resource.
|
getCurrentProperties
advance, close, haveCurrent
getName
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
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.
maximumToReturn
- - The maximum number of entires to return. Use 0 to return all policy definitions.NotFoundException
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.
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.NotFoundException
InvalidParameterException
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.
applicationName
- - The name of the application.maximumToReturn
- - The maximum number of entires to return. Use 0 to return all policy definitions.NotFoundException
InvalidParameterException
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.
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.NotFoundException
InvalidParameterException
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.
resourceId
- - a security resource identifier.maximumToReturn
- - The maximum number of entires to return. Use 0 to return all policy definitions.NotFoundException
InvalidParameterException
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.
resourceId
- - a security resource identifier.maximumToReturn
- - The maximum number of entires to return. Use 0 to return all policy definitions.NotFoundException
InvalidParameterException
Properties getPolicy(String resourceId) throws InvalidParameterException
Obtain a policy definition for a resource. A null is returned when no policy is found.
The Properties
object is the same as those retuned from the
PropertiesListerMBean
.
resourceId
- - a security resource identifier.InvalidParameterException