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.
| 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.security.providers.authorization.DefaultRoleMapperMBean
|
||
| Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
| Access Points Inherited from RoleMapperMBean |
Because this MBean extends or implements RoleMapperMBean, you can also access this MBean by retrieving RoleMapperMBeans. The following attributes contain RoleMapperMBeans and its subtypes:
|
This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.
|
|
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
| Privileges | Read only |
| Type | RealmMBean |
| Relationship type: | Reference. |
This section describes the following attributes:
A short description of the WebLogic Role Mapping provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | WebLogic Role Mapping Provider |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | DefaultRoleMapper |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The name of this WebLogic Role Mapping provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | weblogic.security.providers.authorization.DefaultRoleMapperProviderImpl |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns whether this Role Mapping provider stores roles that are created while deploying a Web application or EJB.
| Privileges | Read/Write |
| Type | boolean |
| Default Value | true |
The security roles you want to be exported from this Role Mapping provider's database. If none are specified, all are exported.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The format of the file to export. The list of supported export formats is determined by this Role Mapping provider.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | DefaultRoles |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The security roles that you want to be imported into this Role Mapping provider's database. If none are specified, all are imported.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | DefaultRoles |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The version number of the WebLogic Role Mapping provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | 1.0 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
Advances the list to the next element in the list.
| Operation Name | "advance" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.
| Operation Name | "close" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Creates role for a resource.
| Operation Name | "createRole" |
| Parameters | Object [] { resourceId, roleName, expression }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Creates role for a resource.
| Operation Name | "createRole" |
| Parameters | Object [] { resourceId, roleName, expression, auxiliary }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Exports provider specific data in a specified format. When
errors occur, the MBean throws an ErrorCollectionException
containing a list of java.lang.Exceptions, where the
text of each exception describes the error.
| Operation Name | "exportData" |
| Parameters | Object [] { format, filename, constraints }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns |
void
|
| Exceptions |
|
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 <code>java.lang.Exceptions</code;>.
| Operation Name | "exportResource" |
| Parameters | Object [] { filename, cn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
The properties of the current item in the list. Returns null if there is no current item.
| Operation Name | "getCurrentProperties" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Properties
|
| Exceptions |
|
Returns an array of class names of the registered predicates.
| Operation Name | "getRegisteredPredicates" |
| Parameters | Object [] { nameFilter }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
class |
Obtain a role definition. A null is returned when no role is found.
The Properties is the same as those returned from
the PropertiesListerMBean.
| Operation Name | "getRole" |
| Parameters | Object [] { resourceId, roleName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | Properties
|
| Exceptions |
|
Get auxiliary role for a resource.
| Operation Name | "getRoleAuxiliary" |
| Parameters | Object [] { resourceId, roleName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
Returns the expression that defines the role granting policy.
| Operation Name | "getRoleExpression" |
| Parameters | Object [] { resourceId, roleName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
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.
| Operation Name | "getRoleNames" |
| Parameters | Object [] { resourceType }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
class |
Obtain a role definition for a role scoped by a specified resource. This may result in a global role definition.
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.
| Operation Name | "getRoleScopedByResource" |
| Parameters | Object [] { resourceId, roleName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | Properties
|
| Exceptions |
|
Returns true if there are more objects in the list, and false otherwise.
| Operation Name | "haveCurrent" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
Imports provider specific data from a specified format. When
errors occur, the MBean throws an ErrorCollectionException
containing a list of java.lang.Exceptions, where the
text of each exception describes the error.
| Operation Name | "importData" |
| Parameters | Object [] { format, filename, constraints }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns |
void
|
| Exceptions |
|
Specifies whether or not the predicate with specified class name is registered.
| Operation Name | "isRegisteredPredicate" |
| Parameters | Object [] { predicateClassName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
Obtain an unsorted list of role definitions.
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.
| Operation Name | "listAllRoles" |
| Parameters | Object [] { maximumToReturn }
where:
|
| Signature | String [] {
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
List all Role and URI pairings that have policy defined for the specified application and context path.
| Operation Name | "listAllRolesAndURIs" |
| Parameters | Object [] { application, contextPath }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
class |
Obtain a list of role definitions for the children of a resource.
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.
| Operation Name | "listChildRoles" |
| Parameters | Object [] { resourceId, maximumToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
Obtain a list of role definitions for the actions that are repeating on a resource.
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.
| Operation Name | "listRepeatingActionsRoles" |
| Parameters | Object [] { resourceId, maximumToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
Obtain a list of role definitions for a specific resource.
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.
| Operation Name | "listRoles" |
| Parameters | Object [] { resourceId, maximumToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
Obtain an list of role definitions by application name.
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.
| Operation Name | "listRolesByApplication" |
| Parameters | Object [] { applicationName, maximumToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
Obtain an list of role definitions for a specific J2EE component.
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.
| Operation Name | "listRolesByComponent" |
| Parameters | Object [] { componentName, componentType, applicationName, maximumToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
Obtain an list of role definitions by resource type.
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.
| Operation Name | "listRolesByResourceType" |
| Parameters | Object [] { resourceType, maximumToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
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:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
class |
Registers a new predicate with the specified class name.
| Operation Name | "registerPredicate" |
| Parameters | Object [] { predicateClassName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Removes a role from a resource.
| Operation Name | "removeRole" |
| Parameters | Object [] { resourceId, roleName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Indicates whether a role exists.
| Operation Name | "roleExists" |
| Parameters | Object [] { resourceId, roleName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
boolean
|
Set auxiliary role for a resource.
| Operation Name | "setRoleAuxiliary" |
| Parameters | Object [] { resourceId, roleName, auxiliary }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Sets the policy expression for a role.
| Operation Name | "setRoleExpression" |
| Parameters | Object [] { resourceId, roleName, expression }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Unregisters the currently registered predicate.
| Operation Name | "unregisterPredicate" |
| Parameters | Object [] { predicateClassName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
| Operation Name | "wls_getDisplayName" |
| Parameters | null |
| Signature | null |
| Returns | String
|