RoleEditorMBean (Abstract)

Overview | Related MBeans | Attributes | Operations

Overview

Provides a set of methods for creating, editing, and removing 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.

Fully Qualified Interface Name	If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.management.security.authorization.RoleEditorMBean`
Factory Methods	No factory methods. Instances of this MBean are created automatically.

Operations

This section describes the following operations:

createRole
getRoleExpression
isSet
listRolesForResource
removeRole

roleExists
setRoleExpression
unSet
wls_getDisplayName

createRole

Creates role for a resource.

Operation Name	`"createRole"`
Parameters	`Object [] { resourceId, roleName, expression }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource that scopes the new role. Each resource has its predefined 'hierachy'. This new role is applicable to all of the given resource's descendants if any. A null indicates a global role, no scoping resource, which applies to all resources within the container. `roleName` is an object of type `java.lang.String` that specifies: - The name of the role that this method creates. A null value will trigger NullPointerException. `expression` is an object of type `java.lang.String` that specifies: - The expression policy designates which user or group having this named 'role'. A null value indicates this role is not granted to anyone.
Signature	`String [] { "java.lang.String", "java.lang.String", "java.lang.String" }`
Returns	`void`
Exceptions	`weblogic.management.utils.AlreadyExistsException` `weblogic.management.utils.CreateException`

getRoleExpression

Returns the expression that defines the role granting policy.

Operation Name	`"getRoleExpression"`
Parameters	`Object [] { resourceId, roleName }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource that scopes the new role. Each resource has its predefined 'hierachy'. This new role is applicable to all of the given resource's descendants if any. A null indicates a global role, no scoping resource, which applies to all resources within the container. `roleName` is an object of type `java.lang.String` that specifies: - The role for which this method returns the role granding expression. A null value will trigger NullPointerException.
Signature	`String [] { "java.lang.String", "java.lang.String" }`
Returns	`String`
Exceptions	`weblogic.management.utils.NotFoundException`

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

Operation Name	`"isSet"`
Parameters	`Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to check
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`
Exceptions	`java.lang.IllegalArgumentException`

listRolesForResource

Lists the role names that are scoped by a resource. Returns a null list if there are no roles under this resource scoping.

Operation Name	`"listRolesForResource"`
Parameters	`Object [] { resourceId }` where: `resourceId` is an object of type `java.lang.String` that specifies: - A resource identifier. A null value specifies a global role.
Signature	`String [] { "java.lang.String" }`
Returns	`class`

removeRole

Removes a role from a resource.

Operation Name	`"removeRole"`
Parameters	`Object [] { resourceId, roleName }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource that scopes the role. Each role has a scoping resource. A null indicates a global role. `roleName` is an object of type `java.lang.String` that specifies: - The role that this method removes. A null value will trigger NullPointerException.
Signature	`String [] { "java.lang.String", "java.lang.String" }`
Returns	`void`
Exceptions	`weblogic.management.utils.NotFoundException` `weblogic.management.utils.RemoveException`

roleExists

Indicates whether a role exists.

Operation Name	`"roleExists"`
Parameters	`Object [] { resourceId, roleName }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource that scopes the role. Each role has a scoping resource. A null indicates a global role. `roleName` is an object of type `java.lang.String` that specifies: - The role for which this method searches.
Signature	`String [] { "java.lang.String", "java.lang.String" }`
Returns	`boolean`

setRoleExpression

Sets the policy expression for a role.

Operation Name	`"setRoleExpression"`
Parameters	`Object [] { resourceId, roleName, expression }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource that scopes the new role. Each resource has its predefined 'hierachy'. This role is applicable to all of the given resource's descendants if any. A null indicates a global role, no scoping resource, which applies to all resources within the container. `roleName` is an object of type `java.lang.String` that specifies: - The name of the role for which this method replaces a policy. A null value will trigger NullPointerException. `expression` is an object of type `java.lang.String` that specifies: - The expression policy designates which user or group having this named 'role'. A null value indicates this role is not granted to anyone.
Signature	`String [] { "java.lang.String", "java.lang.String", "java.lang.String" }`
Returns	`void`
Exceptions	`weblogic.management.utils.NotFoundException` `weblogic.management.utils.CreateException`

unSet

Restore the given property to its default value.

Operation Name	`"unSet"`
Parameters	`Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to restore
Signature	`String [] { "java.lang.String" }`
Returns	`void`
Exceptions	`java.lang.IllegalArgumentException` UnsupportedOperationException if called on a runtime implementation.

wls_getDisplayName

Returns the display name of an MBean.

Deprecated 9.0.0.0

Operation Name	`"wls_getDisplayName"`
Parameters	`null`
Signature	`null`
Returns	`String`