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.security.providers.authorization
Interface DefaultRoleMapperMBean

All Superinterfaces:

ApplicationVersionerMBean, DeployableRoleMapperMBean, weblogic.descriptor.DescriptorBean, ExportMBean, ImportMBean, ListerMBean, weblogic.security.providers.authorization.PredicateEditorMBean, weblogic.security.providers.authorization.PredicateReaderMBean, weblogic.management.utils.PropertiesListerMBean, ProviderMBean, RoleEditorMBean, RoleListerMBean, RoleMapperMBean, RoleReaderMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface

public interface DefaultRoleMapperMBean

extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, DeployableRoleMapperMBean, RoleEditorMBean, RoleListerMBean, weblogic.security.providers.authorization.PredicateEditorMBean, ApplicationVersionerMBean, ImportMBean, ExportMBean

This MBean represents configuration attributes for the WebLogic Role Mapping provider.Deprecation of MBeanHome and Type-Safe InterfacesThis is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes 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

void	createRole(String resourceId, String roleName, String expression, String auxiliary) Creates role for a resource.
void	exportResource(String filename, String cn) Exports provider specific role data using an LDAP CN search filter to specify the resources for export.
String	getDescription() A short description of the WebLogic Role Mapping provider.
String	getName() The name of this configuration.
String	getProviderClassName() The name of this WebLogic Role Mapping provider.
String	getRoleAuxiliary(String resourceId, String roleName) Get auxiliary role for a resource.
String[][]	getRoleNames(String resourceType) Returns array of resource/role name tuples of roles defined in the scope of resources of the given type or global roles, when the type is null.
String[]	getSupportedExportConstraints() The security roles you want to be exported from this Role Mapping provider's database.
String[]	getSupportedExportFormats() The format of the file to export.
String[]	getSupportedImportConstraints() The security roles that you want to be imported into this Role Mapping provider's database.
String[]	getSupportedImportFormats() The format of the file to import.
String	getVersion() The version number of the WebLogic Role Mapping provider.
String[]	listAllRolesAndURIs(String application, String contextPath) List all Role and URI pairings that have policy defined for the specified application and context path.
void	setRoleAuxiliary(String resourceId, String roleName, String auxiliary) Set auxiliary role for a resource.

Methods inherited from interface weblogic.management.commo.StandardInterface

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

Methods inherited from interface weblogic.management.security.authorization.DeployableRoleMapperMBean

isRoleDeploymentEnabled, setRoleDeploymentEnabled

Methods inherited from interface weblogic.management.security.ProviderMBean

getRealm

Methods inherited from interface weblogic.management.security.authorization.RoleEditorMBean

createRole, removeRole, setRoleExpression

Methods inherited from interface weblogic.management.security.authorization.RoleReaderMBean

getRoleExpression, listRolesForResource, roleExists

Methods inherited from interface weblogic.management.security.authorization.RoleListerMBean

getRole, getRoleScopedByResource, listAllRoles, listChildRoles, listRepeatingActionsRoles, listRoles, listRolesByApplication, listRolesByComponent, listRolesByResourceType

Methods inherited from interface weblogic.management.utils.ListerMBean

advance, close, haveCurrent

Methods inherited from interface weblogic.management.security.ImportMBean

importData

Methods inherited from interface weblogic.management.security.ExportMBean

exportData

Method Detail

createRole

public void createRole(String resourceId,
                       String roleName,
                       String expression,
                       String auxiliary)
                throws weblogic.management.utils.AlreadyExistsException,
                       weblogic.management.utils.CreateException

Creates role for a resource.

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 name of the role that this method creates. A null value will trigger NullPointerException.

expression - - The expression policy designates which user or group having this named 'role'. A null value indicates this role is not granted to anyone.

auxiliary - - Auxiliary data to support WLP.

Throws:

weblogic.management.utils.AlreadyExistsException

weblogic.management.utils.CreateException

exportResource

public void exportResource(String filename,
                           String cn)
                    throws weblogic.management.utils.InvalidParameterException,
                           weblogic.management.utils.ErrorCollectionException

Exports provider specific role data using an LDAP CN search filter to specify the resources for export. When errors occur, the MBean throws an ErrorCollectionException containing a list of java.lang.Exceptions.

Parameters:

filename - - The full path to the filename used to write data.

cn - - The LDAP CN to be used when exporting data.

Throws:

weblogic.management.utils.InvalidParameterException

weblogic.management.utils.ErrorCollectionException

getDescription

public String getDescription()

A short description of the WebLogic Role Mapping provider.

Specified by:

getDescription in interface ProviderMBean

Default value:

"WebLogic Role Mapping Provider"

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

getName

public String getName()

Description copied from interface: ProviderMBean

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:

getName in interface weblogic.management.commo.StandardInterface

Default value:

"DefaultRoleMapper"

A dynamic MBean attribute.

false

getProviderClassName

public String getProviderClassName()

The name of this WebLogic Role Mapping provider.

Specified by:

getProviderClassName in interface ProviderMBean

Default value:

"weblogic.security.providers.authorization.DefaultRoleMapperProviderImpl"

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

Excluded: Should not appear in public javadocs

Internal: Should not appear in public javadocs

getRoleAuxiliary

public String getRoleAuxiliary(String resourceId,
                               String roleName)
                        throws MBeanException,
                               weblogic.management.utils.NotFoundException

Get auxiliary role for a resource.

Parameters:

resourceId - - The resource that scopes the role.

roleName - - The name of the role that this method gets the auxiliary from. A null value will trigger NullPointerException.

Throws:

MBeanException

weblogic.management.utils.NotFoundException

getRoleNames

public String[][] getRoleNames(String resourceType)

Returns array of resource/role name tuples of roles defined in the scope of resources of the given type or global roles, when the type is null.

Parameters:

resourceType - - The resource type, or null to get global roles

getSupportedExportConstraints

public String[] getSupportedExportConstraints()

The security roles you want to be exported from this Role Mapping provider's database. If none are specified, all are exported.

Specified by:

getSupportedExportConstraints in interface ExportMBean

Default value:

""

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

getSupportedExportFormats

public String[] getSupportedExportFormats()

The format of the file to export. The list of supported export formats is determined by this Role Mapping provider.

Specified by:

getSupportedExportFormats in interface ExportMBean

Default value:

"DefaultRoles"

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

getSupportedImportConstraints

public String[] getSupportedImportConstraints()

The security roles that you want to be imported into this Role Mapping provider's database. If none are specified, all are imported.

Specified by:

getSupportedImportConstraints in interface ImportMBean

Default value:

""

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

getSupportedImportFormats

public String[] getSupportedImportFormats()

The format of the file to import. The list of supported import formats is determined by the Role Mapping provider from which the security roles were originally exported.

Specified by:

getSupportedImportFormats in interface ImportMBean

Default value:

"DefaultRoles"

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

getVersion

public String getVersion()

The version number of the WebLogic Role Mapping provider.

Specified by:

getVersion in interface ProviderMBean

Default value:

"1.0"

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

listAllRolesAndURIs

public String[] listAllRolesAndURIs(String application,
                                    String contextPath)

List all Role and URI pairings that have policy defined for the specified application and context path.

Parameters:

application - - The name of the deployed application.

contextPath - - The context path for the application.

setRoleAuxiliary

public void setRoleAuxiliary(String resourceId,
                             String roleName,
                             String auxiliary)
                      throws weblogic.management.utils.AlreadyExistsException,
                             weblogic.management.utils.CreateException,
                             MBeanException

Set auxiliary role for a resource.

Parameters:

resourceId - - The resource that scopes the role.

roleName - - The name of the role that this method sets the auxiliary on. A null value will trigger NullPointerException.

auxiliary - - Auxiliary data to support WLP.

Throws:

weblogic.management.utils.AlreadyExistsException

weblogic.management.utils.CreateException

MBeanException