com.tivoli.pd.jadmin
Class PDProtObjectSpace

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

public class PDProtObjectSpace
extends java.lang.Object

Policy Director Protected ObjectSpace class.

Object Spaces are the containers that contain protected objects in the protected name space. Each is uniquely identified by its namespace ID.

This class is not meant to be instantiated; rather its static methods can be used to manipulate protected objectspaces within the Management Server.

Unlike the PDAdmin C API, there is no type associated with a protected objectspace. Extended attributes need to be used instead which will be supported in the future.

Modes: Local,Remote

Method Summary

static void	createProtObjectSpace(PDContext context, java.lang.String id, java.lang.String description, PDMessages messages) Creates a protected objectspace object in the Management Server.
static void	deleteProtObjectSpace(PDContext context, java.lang.String id, PDMessages messages) Deletes a protected objectspace object in the Management Server.
static java.util.ArrayList	listProtObjectSpaces(PDContext context, PDMessages messages) Returns a list of names of all existing protected object spaces in the Management Server.

Methods inherited from class java.lang.Object

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

Method Detail

createProtObjectSpace

public static void createProtObjectSpace(PDContext context,
                                         java.lang.String id,
                                         java.lang.String description,
                                         PDMessages messages)
                                  throws PDException

Creates a protected objectspace object in the Management Server.

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

Parameters:

context - PDContext to be used to communicate with the Management Server. Cannot be null.

id - name of the objectspace. A valid name needs to start with a forward slash followed by one or more characters. Cannot be null.

description - description of the objectspace. If null, an empty string is assumed. The input parameter is not changed.

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

Throws:

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

listProtObjectSpaces

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

Returns a list of names of all existing protected object spaces in the Management Server.

Parameters:

context - PDContext to be used to communicate with the Management Server. Cannot be null.

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

Returns:

an ArrayList of Strings that are the names of all existing protected objectspaces. Cannot be empty because it will contain at least the protected objectspaces that are created by default by Policy Director.

Throws:

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

deleteProtObjectSpace

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

Deletes a protected objectspace object in the Management Server.

Parameters:

context - PDContext to be used to communicate with the Management Server. Cannot be null.

id - name of the objectspace to be deleted. This needs be the one used to create this objectspace. Cannot be null.

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

Throws:

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