|
Oracle Fusion Middleware Oracle WebLogic Server MBean Javadoc 11g Release 1 (10.3.3) Part Number E13945-03 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RoleListerMBean
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.
In addition to being used as
a base class that provides functionality to security provider
MBeans, JMX applications can use this class directly as a type-safe
interface. When used as a type-safe interface, a JMX application
imports this class and accesses it through
weblogic.management.MBeanHome
. As of 9.0, the
MBeanHome
interface and all type-safe interfaces for
WebLogic Server MBeans are deprecated. Instead, JMX applications that
interact with WebLogic Server MBeans should use standard JMX design
patterns in which clients use the
javax.management.MBeanServerConnection
interface to
discover MBeans, attributes, and attribute types at runtime.
Method Summary | |
---|---|
Properties |
getRole(String resourceId,
String roleName)
Obtain a role definition. |
Properties |
getRoleScopedByResource(String resourceId,
String roleName)
Obtain a role definition for a role scoped by a specified resource. |
String |
listAllRoles(int maximumToReturn)
Obtain an unsorted list of role definitions. |
String |
listChildRoles(String resourceId,
int maximumToReturn)
Obtain a list of role definitions for the children of a resource. |
String |
listRepeatingActionsRoles(String resourceId,
int maximumToReturn)
Obtain a list of role definitions for the actions that are repeating on a resource. |
String |
listRoles(String resourceId,
int maximumToReturn)
Obtain a list of role definitions for a specific resource. |
String |
listRolesByApplication(String applicationName,
int maximumToReturn)
Obtain an list of role definitions by application name. |
String |
listRolesByComponent(String componentName,
String componentType,
String applicationName,
int maximumToReturn)
Obtain an list of role definitions for a specific J2EE component. |
String |
listRolesByResourceType(String resourceType,
int maximumToReturn)
Obtain an list of role definitions by resource type. |
Methods inherited from interface weblogic.management.utils.PropertiesListerMBean |
---|
getCurrentProperties |
Methods inherited from interface weblogic.management.utils.ListerMBean |
---|
advance, close, haveCurrent |
Method Detail |
---|
String listAllRoles(int maximumToReturn) throws NotFoundException
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 role definitions.
NotFoundException
String listRolesByResourceType(String resourceType, int maximumToReturn) throws NotFoundException, InvalidParameterException
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 role definitions.
NotFoundException
InvalidParameterException
String listRolesByApplication(String applicationName, int maximumToReturn) throws NotFoundException, InvalidParameterException
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 role definitions.
NotFoundException
InvalidParameterException
String listRolesByComponent(String componentName, String componentType, String applicationName, int maximumToReturn) throws NotFoundException, InvalidParameterException
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 role definitions.
NotFoundException
InvalidParameterException
String listRoles(String resourceId, int maximumToReturn) throws NotFoundException, InvalidParameterException
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 role definitions.
NotFoundException
InvalidParameterException
String listChildRoles(String resourceId, int maximumToReturn) throws NotFoundException, InvalidParameterException
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 role definitions.
weblogic.management.utils.NotFoundException
weblogic.management.utils.InvalidParameterException
NotFoundException
InvalidParameterException
String listRepeatingActionsRoles(String resourceId, int maximumToReturn) throws NotFoundException, InvalidParameterException
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 role definitions.
NotFoundException
InvalidParameterException
Properties getRole(String resourceId, String roleName) throws InvalidParameterException
The Properties
is the same as those returned from the PropertiesListerMBean
.
resourceId
- - a security resource identifier.roleName
- - a role name.
InvalidParameterException
Properties getRoleScopedByResource(String resourceId, String roleName) throws InvalidParameterException
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
.
resourceId
- - a security resource identifier.roleName
- - a role name.
InvalidParameterException
|
Copyright 1996, 2010, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Oracle WebLogic Server MBean Javadoc 11g Release 1 (10.3.3) Part Number E13945-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |