BEA Systems, Inc.

Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)


weblogic.management.security.authorization
Interface RoleReaderMBean

All Superinterfaces:
weblogic.descriptor.DescriptorBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface
All Known Subinterfaces:
DefaultRoleMapperMBean, RoleEditorMBean

public interface RoleReaderMBean
extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean

Provides a set of methods for reading 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.

Deprecation of MBeanHome and Type-Safe Interfaces

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. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary
 String getRoleExpression(String resourceId, String roleName)
          Returns the expression that defines the role granting policy.
 String[] listRolesForResource(String resourceId)
          Lists the role names that are scoped by a resource.
 boolean roleExists(String resourceId, String roleName)
          Indicates whether a role exists.
 
Methods inherited from interface weblogic.management.commo.StandardInterface
getName, setName, wls_getDisplayName, wls_getInterfaceClassName, wls_getObjectName
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener
 
Methods inherited from interface weblogic.descriptor.SettableBean
isSet, unSet
 

Method Detail

getRoleExpression

public String getRoleExpression(String resourceId,
                                String roleName)
                         throws weblogic.management.utils.NotFoundException
Returns the expression that defines the role granting policy.

Parameters:
resourceId - - The resource that scopes the new role. Each resource has its predefined 'hierachy'. This new role is applicable to all of the given resouce's descendants if any. A null indicates a global role, no scoping resource, which applies to all resources within the container.
roleName - - The role for which this method returns the role granding expression. A null value will trigger NullPointerException.
Throws:
weblogic.management.utils.NotFoundException

listRolesForResource

public String[] listRolesForResource(String resourceId)
Lists the role names that are scoped by a resource. Returns a null list if there are no roles under this resource scoping.

Parameters:
resourceId - - A resource identifier. A null value specifies a global role.

roleExists

public boolean roleExists(String resourceId,
                          String roleName)
Indicates whether a role exists.

Parameters:
resourceId - - The resource that scopes the role. Each role has a scoping resource. A null indicates a global role.
roleName - - The role for which this method searches.

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs90
Copyright 2005 BEA Systems Inc.