Package weblogic.management.security.authorization

Interface RoleAuxiliaryMBean

All Superinterfaces:

DescriptorBean, RoleEditorMBean, RoleReaderMBean, SettableBean, StandardInterface

public interface RoleAuxiliaryMBean
extends RoleEditorMBean

Provides a set of auxiliary methods for creating, editing, and removing role assignment policies. An RoleMapping-provider MBean can optionally extend this MBean.

Method Summary

Modifier and Type	Method	Description
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	getRoleAuxiliary(java.lang.String resourceId, java.lang.String roleName)	Get auxiliary role for a resource.
java.lang.String[][]	getRoleNames(java.lang.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.
java.lang.String[]	listAllRolesAndURIs(java.lang.String application, java.lang.String contextPath)	List all Role and URI pairings that have policy defined for the specified application and context path.
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.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

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.commo.StandardInterface

getName

Method Detail

createRole

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

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

MBeanExeption

javax.management.MBeanException

getRoleAuxiliary

java.lang.String getRoleAuxiliary(java.lang.String resourceId,
                                  java.lang.String roleName)
                           throws NotFoundException,
                                  javax.management.MBeanException

Get 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.

Throws:

NotFoundException

MBeanExeption

javax.management.MBeanException

exportResource

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 <code>java.lang.Exceptions</code;>.

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

listAllRolesAndURIs

java.lang.String[] listAllRolesAndURIs(java.lang.String application,
                                       java.lang.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.

getRoleNames

java.lang.String[][] getRoleNames(java.lang.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