GroupEditorMBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.security.authentication
Interface GroupEditorMBean

All Superinterfaces:: DescriptorBean, GroupReaderMBean, GroupRemoverMBean, ListerMBean, NameListerMBean, SettableBean, StandardInterface

All Known Subinterfaces:: DefaultAuthenticatorMBean, SQLAuthenticatorMBean

public interface GroupEditorMBean
extends GroupReaderMBean, GroupRemoverMBean
extends GroupReaderMBean, GroupRemoverMBean

Provides a set of methods for creating, editing, and removing groups. An Authentication provider MBean can optionally implement this MBean. The WebLogic Server Administration Console detects when an Authentication provider implements this MBean and automatically provides a tab for using these methods.

Method Summary
`void`	`addMemberToGroup(String groupName, String memberUserOrGroupName)` Adds a user or group (member) to a group.
`void`	`createGroup(String groupName, String description)` Creates a group.
`void`	`removeMemberFromGroup(String groupName, String memberUserOrGroupName)` Removes a user or group (member) from a group.
`void`	`setGroupDescription(String groupName, String description)` Sets the description for an existing group.

Methods inherited from interface weblogic.management.security.authentication.GroupReaderMBean
`getGroupDescription, groupExists, isMember, listGroups`

Methods inherited from interface weblogic.management.utils.NameListerMBean
`getCurrentName`

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`

Methods inherited from interface weblogic.descriptor.SettableBean
`isSet, unSet`

Methods inherited from interface weblogic.management.security.authentication.GroupRemoverMBean
`removeGroup`

Method Detail

createGroup

void createGroup(String groupName,
                 String description)
                 throws AlreadyExistsException,
                        InvalidParameterException

Creates a group.

Parameters:: groupName - - The name of the new group. The name cannot be the name of an existing user or group. The Authentication provider determines syntax requirements for the group name.; description - - The description of the group.
Throws:: AlreadyExistsException; InvalidParameterException

setGroupDescription

void setGroupDescription(String groupName,
                         String description)
                         throws NotFoundException,
                                InvalidParameterException

Sets the description for an existing group.

Parameters:: groupName - - The name of an existing group.; description - - The description of the group.
Throws:: NotFoundException; InvalidParameterException

addMemberToGroup

void addMemberToGroup(String groupName,
                      String memberUserOrGroupName)
                      throws NotFoundException,
                             InvalidParameterException

Adds a user or group (member) to a group. If the member already belongs to the group, this method does nothing.

Parameters:: groupName - - The name of an existing group to which this method adds a member.; memberUserOrGroupName - - The name of the member, which must be an existing user or group.
Throws:: NotFoundException; InvalidParameterException

removeMemberFromGroup

void removeMemberFromGroup(String groupName,
                           String memberUserOrGroupName)
                           throws NotFoundException,
                                  InvalidParameterException

Removes a user or group (member) from a group. If the member is not in the group, this method does nothing.

Parameters:: groupName - - The name of an existing group from which this method removes a member.; memberUserOrGroupName - - The name of the member, which must be an existing user or group.
Throws:: NotFoundException; InvalidParameterException