com.tivoli.pd.jadmin
Class PDActionGroup

java.lang.Object
  com.tivoli.pd.jadmin.PDActionGroup

All Implemented Interfaces:

java.lang.Cloneable

public class PDActionGroup
extends java.lang.Object
implements java.lang.Cloneable

Security Access Manager Action Group class.

Each PDAction object belongs to a single PDActionGroup object. An action group allows a Security Access Manager application to group all its custom PDAction objects into a single group. The action group concept replaces the concept of type associated with PDAction objects.

Security Access Manager, by default, contains a primary action group and several actions in this group. It is possible to use the methods in this class to customize the default action group set by adding new action groups. The primary action group cannot be deleted.

Modes: Local,Remote

Field Summary

static java.lang.String

PDACTIONGROUP_PRIMARY_NAME Constant indicating the primary action group name.

Method Summary

static void	createActionGroup(PDContext context, java.lang.String actionGroupId, PDMessages messages) Creates an action group in the policy server.
static void	deleteActionGroup(PDContext context, java.lang.String actionGroupId, PDMessages messages) Deletes the specified action group from the policy server.
static java.util.ArrayList	listActionGroups(PDContext context, PDMessages messages) Returns a list of names of all action groups that exist in the policy server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PDACTIONGROUP_PRIMARY_NAME

public static final java.lang.String PDACTIONGROUP_PRIMARY_NAME

Constant indicating the primary action group name.

See Also:

Constant Field Values

Method Detail

createActionGroup

public static void createActionGroup(PDContext context,
                                     java.lang.String actionGroupId,
                                     PDMessages messages)
                              throws PDException

Creates an action group in the policy server.

This method is equivalent to the ivadmin_action_group_create() C API.

Parameters:

context - the context for communicating with the policy server. Cannot be null.

actionGroupId - name of the action group. Cannot be the primary action group. Cannot be null.

messages - in/out parameter; empty PDMessages on input; might contain zero or more informational or warning messages on output. Cannot be null.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

listActionGroups

public static java.util.ArrayList listActionGroups(PDContext context,
                                                   PDMessages messages)
                                            throws PDException

Returns a list of names of all action groups that exist in the policy server.

This method is equivalent to the ivadmin_action_group_list() C API.

Parameters:

context - the context for communicating with the policy server. Cannot be null.

messages - in/out parameter; empty PDMessages on input; might contain zero or more informational or warning messages on output. Cannot be null.

Returns:

an ArrayList of String objects that are the names of all the action groups that exist in policy server. It cannot be empty because it will contain at least the name of the primary action group created by default by Security Access Manager.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

deleteActionGroup

public static void deleteActionGroup(PDContext context,
                                     java.lang.String actionGroupId,
                                     PDMessages messages)
                              throws PDException

Deletes the specified action group from the policy server. Any actions that exist in the specified action group are also deleted. ACL entries that contain the deleted actions continue to exist but the action field in those ACL entries is set to blank.

This method is equivalent to the ivadmin_action_group_delete() C API.

Parameters:

context - the context for communicating with the policy server. Cannot be null.

actionGroupId - name of the action group to be deleted. Cannot be the primary action group. Cannot be null.

messages - in/out parameter; empty PDMessages on input; might contain zero or more informational or warning messages on output. Cannot be null.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.