PolicyEditorMBean (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.PolicyEditorMBean`
Factory Methods	No factory methods. Instances of this MBean are created automatically.

Operations

This section describes the following operations:

createPolicy
getPolicyExpression
isSet
policyExists
removePolicy

setPolicyExpression
unSet
wls_getDisplayName

createPolicy

Creates a policy for accessing a resource.

Operation Name	`"createPolicy"`
Parameters	`Object [] { resourceId, expression }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The ID of the resource. A null value will trigger NullPointerException. For information about creating resources, refer to the Javadoc for `weblogic.security.spi.Resource`. `expression` is an object of type `java.lang.String` that specifies: - The expression that determines the type of access this policy allows to the resource. A null value prohibits any type of access.
Signature	`String [] { "java.lang.String", "java.lang.String" }`
Returns	`void`
Exceptions	`weblogic.management.utils.AlreadyExistsException` `weblogic.management.utils.CreateException`

getPolicyExpression

Returns the expression of an existing policy.

Operation Name	`"getPolicyExpression"`
Parameters	`Object [] { resourceId }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which this method returns the policy expression. A null value will trigger NullPointerException.
Signature	`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`

policyExists

Indicates whether a policy exists for a resource.

Operation Name	`"policyExists"`
Parameters	`Object [] { resourceId }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource within which this method searches for a policy. A null value will trigger NullPointerException.
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`

removePolicy

Removes a policy.

Operation Name	`"removePolicy"`
Parameters	`Object [] { resourceId }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which this method removes a policy. A null value may trigger NullPointerException.
Signature	`String [] { "java.lang.String" }`
Returns	`void`
Exceptions	`weblogic.management.utils.NotFoundException` `weblogic.management.utils.RemoveException`

setPolicyExpression

Sets a policy expression for a resource.

Operation Name	`"setPolicyExpression"`
Parameters	`Object [] { resourceId, expression }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which this method sets the policy expression. A null value will trigger NullPointerException. `expression` is an object of type `java.lang.String` that specifies: - The expression that determines the type of access this policy allows to the resource. A null value prohibits any type of access.
Signature	`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

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