weblogic.management.security.authorization

Interface RoleListerMBean

All Superinterfaces:

DescriptorBean, ListerMBean, PropertiesListerMBean, SettableBean, StandardInterface

public interface RoleListerMBean
extends PropertiesListerMBean

Provides a set of methods for listing data about roles. 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.

Method Summary

Modifier and Type	Method and Description
Properties	getRole(String resourceId, String roleName) Obtain a role definition.
Properties	getRoleScopedByResource(String resourceId, String roleName) Obtain a role definition for a role scoped by a specified resource.
String	listAllRoles(int maximumToReturn) Obtain an unsorted list of role definitions.
String	listChildRoles(String resourceId, int maximumToReturn) Obtain a list of role definitions for the children of a resource.
String	listRepeatingActionsRoles(String resourceId, int maximumToReturn) Obtain a list of role definitions for the actions that are repeating on a resource.
String	listRoles(String resourceId, int maximumToReturn) Obtain a list of role definitions for a specific resource.
String	listRolesByApplication(String applicationName, int maximumToReturn) Obtain an list of role definitions by application name.
String	listRolesByComponent(String componentName, String componentType, String applicationName, int maximumToReturn) Obtain an list of role definitions for a specific Java EE component.
String	listRolesByResourceType(String resourceType, int maximumToReturn) Obtain an list of role definitions by resource type.

Methods inherited from interface weblogic.management.utils.PropertiesListerMBean

getCurrentProperties

Methods inherited from interface weblogic.management.utils.ListerMBean

advance, close, haveCurrent

Methods inherited from interface weblogic.management.commo.StandardInterface

getName

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Method Detail

listAllRoles

String listAllRoles(int maximumToReturn)
             throws NotFoundException

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.

Parameters:

maximumToReturn - - The maximum number of entires to return. Use 0 to return all role definitions.

Throws:

NotFoundException

listRolesByResourceType

String listRolesByResourceType(String resourceType,
                               int maximumToReturn)
                        throws NotFoundException,
                               InvalidParameterException

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.

Parameters:

resourceType - - The name of the resource type specified by a weblogic.security.spi.Resource object.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all role definitions.

Throws:

NotFoundException

InvalidParameterException

listRolesByApplication

String listRolesByApplication(String applicationName,
                              int maximumToReturn)
                       throws NotFoundException,
                              InvalidParameterException

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.

Parameters:

applicationName - - The name of the application.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all role definitions.

Throws:

NotFoundException

InvalidParameterException

listRolesByComponent

String listRolesByComponent(String componentName,
                            String componentType,
                            String applicationName,
                            int maximumToReturn)
                     throws NotFoundException,
                            InvalidParameterException

Obtain an list of role definitions for a specific Java EE 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.

Parameters:

componentName - - The name of the component.

componentType - - The component type.

applicationName - - The name of the application.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all role definitions.

Throws:

NotFoundException

InvalidParameterException

listRoles

String listRoles(String resourceId,
                 int maximumToReturn)
          throws NotFoundException,
                 InvalidParameterException

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.

Parameters:

resourceId - - a security resource identifier.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all role definitions.

Throws:

NotFoundException

InvalidParameterException

listChildRoles

String listChildRoles(String resourceId,
                      int maximumToReturn)
               throws NotFoundException,
                      InvalidParameterException

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.

Parameters:

resourceId - - a security resource identifier.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all role definitions.

Throws:

NotFoundException

InvalidParameterException

listRepeatingActionsRoles

String listRepeatingActionsRoles(String resourceId,
                                 int maximumToReturn)
                          throws NotFoundException,
                                 InvalidParameterException

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.

Parameters:

resourceId - - a security resource identifier.

maximumToReturn - - The maximum number of entires to return. Use 0 to return all role definitions.

Throws:

NotFoundException

InvalidParameterException

getRole

Properties getRole(String resourceId,
                   String roleName)
            throws InvalidParameterException

Obtain a role definition.

A null is returned when no role is found.

The Properties is the same as those returned from the PropertiesListerMBean.

Parameters:

resourceId - - a security resource identifier.

roleName - - a role name.

Throws:

InvalidParameterException

getRoleScopedByResource

Properties getRoleScopedByResource(String resourceId,
                                   String roleName)
                            throws InvalidParameterException

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

Parameters:

resourceId - - a security resource identifier.

roleName - - a role name.

Throws:

InvalidParameterException