WebLogic Server 8.1 API Reference

weblogic.security.providers.authorization
Interface DefaultRoleMapperMBean

public interface DefaultRoleMapperMBean

extends weblogic.management.commo.StandardInterface, DeployableRoleMapperMBean, RoleEditorMBean, PredicateEditorMBean, ImportMBean, ExportMBean

This MBean represents configuration attributes for the WebLogic Role Mapping provider.

Author:

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

Method Summary

void	createRole(java.lang.String resourceId, java.lang.String roleName, java.lang.String expression, java.lang.String auxiliary) Creates role for a resource.
void	exportResource(java.lang.String filename, java.lang.String cn) Exports provider specific role data using an LDAP CN search filter to specify the resources for export.
java.lang.String	getDescription() A short description of the WebLogic Role Mapping provider.
java.lang.String	getProviderClassName() The name of the Java class used to load the WebLogic Role Mapping provider.
java.lang.String	getRoleAuxiliary(java.lang.String resourceId, java.lang.String roleName) Get auxiliary role for a resource.
java.lang.String[]	getSupportedExportConstraints() The security roles you want to be exported from this Role Mapping provider's database.
java.lang.String[]	getSupportedExportFormats() The format of the file to export.
java.lang.String[]	getSupportedImportConstraints() The security roles that you want to be imported into this Role Mapping provider's database.
java.lang.String[]	getSupportedImportFormats() The format of the file to import.
java.lang.String	getVersion() The version number of the WebLogic Role Mapping provider.
void	setRoleAuxiliary(java.lang.String resourceId, java.lang.String roleName, java.lang.String auxiliary) Set auxiliary role for a resource.

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

isRoleDeploymentEnabled, setRoleDeploymentEnabled

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

createRole, removeRole, setRoleExpression

Methods inherited from interface weblogic.security.providers.authorization.PredicateEditorMBean

registerPredicate, unregisterPredicate

Methods inherited from interface weblogic.management.security.ImportMBean

importData

Methods inherited from interface weblogic.management.security.ExportMBean

exportData

Methods inherited from interface weblogic.management.security.ProviderMBean

getRealm, setRealm

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

getRoleExpression, listRolesForResource, roleExists

Methods inherited from interface weblogic.security.providers.authorization.PredicateReaderMBean

getPredArgumentAllowedValues, getPredArgumentCount, getPredArgumentDefValue, getPredArgumentDescription, getPredArgumentMaxValue, getPredArgumentMinValue, getPredArgumentName, getPredArgumentType, getPredicateDescription, getPredicateDisplayName, getRegisteredPredicates, isPredArgumentValid, isRegisteredPredicate

Method Detail

getProviderClassName

public java.lang.String getProviderClassName()

The name of the Java class used to load the WebLogic Role Mapping provider.

Default Value: "weblogic.security.providers.authorization.DefaultRoleMapperProviderImpl"

getDescription

public java.lang.String getDescription()

A short description of the WebLogic Role Mapping provider.

Default Value: "Weblogic Role Mapping Provider"

getVersion

public java.lang.String getVersion()

The version number of the WebLogic Role Mapping provider.

Default Value: "1.0"

getSupportedImportFormats

public java.lang.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: new String[] { "DefaultRoles" }

getSupportedImportConstraints

public java.lang.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: new String[0]

getSupportedExportFormats

public java.lang.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: new String[] { "DefaultRoles" }

getSupportedExportConstraints

public java.lang.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: new String[0]

createRole

public void createRole(java.lang.String resourceId,
                       java.lang.String roleName,
                       java.lang.String expression,
                       java.lang.String auxiliary)
                throws AlreadyExistsException,
                       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:

AlreadyExistsException -

CreateException -

setRoleAuxiliary

public void setRoleAuxiliary(java.lang.String resourceId,
                             java.lang.String roleName,
                             java.lang.String auxiliary)
                      throws AlreadyExistsException,
                             CreateException,
                             javax.management.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:

AlreadyExistsException -

CreateException -

javax.management.MBeanException -

getRoleAuxiliary

public java.lang.String getRoleAuxiliary(java.lang.String resourceId,
                                         java.lang.String roleName)
                                  throws javax.management.MBeanException,
                                         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:

javax.management.MBeanException -

NotFoundException -

exportResource

public void exportResource(java.lang.String filename,
                           java.lang.String cn)
                    throws InvalidParameterException,
                           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:

InvalidParameterException -

ErrorCollectionException -