Package org.apache.directory.fortress.core.ant

Class Delcontainer

java.lang.Object

org.apache.directory.fortress.core.ant.Delcontainer

public class Delcontainer
extends Object

The class is used by FortressAntTask to remove OrganizationalUnits used to drive OrganizationalUnitP.delete( org.apache.directory.fortress.core.model.OrganizationalUnit). It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.

This class name, 'Delcontainer', is used for the xml tag in the load script.

 
 <target name="all">
     <FortressAdmin>
         <delcontainer>
           ...
         </delcontainer>
     </FortressAdmin>
 </target>
 
 

This class is destructive as it will remove all nodes below the container using recursive delete function.
Extreme care should be taken during execution to ensure target dn is correct and permanent removal of data is intended. There is no 'undo' for this operation.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
Delcontainer()	All Ant data entities must have a default constructor.

Method Summary

Modifier and Type	Method	Description
void	addContainer(OrganizationalUnit ou)	This method name, 'addContainer', is used for derived xml tag 'container' in the load script.
List<OrganizationalUnit>	getContainers()	Used by FortressAntTask.deleteContainers() to retrieve list of OrganizationalUnits as defined in input xml file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Delcontainer

public Delcontainer()

All Ant data entities must have a default constructor.

Method Detail

addContainer

public void addContainer(OrganizationalUnit ou)

This method name, 'addContainer', is used for derived xml tag 'container' in the load script.

 
 <delcontainer>
     <container name="Config"/>
     <container name="People"/>
     <container name="Policies"/>
     <container name="RBAC"/>
     <container name="Roles" parent="RBAC"/>
     <container name="Permissions" parent="RBAC"/>
     <container name="Constraints" parent="RBAC"/>
     <container name="ARBAC"/>
     <container name="OS-U" parent="ARBAC"/>
     <container name="OS-P" parent="ARBAC"/>
     <container name="AdminRoles" parent="ARBAC"/>
     <container name="AdminPerms" parent="ARBAC"/>
 </delcontainer>
 
 

Parameters:

ou - contains reference to data element targeted for deletion.

getContainers

public List<OrganizationalUnit> getContainers()

Used by FortressAntTask.deleteContainers() to retrieve list of OrganizationalUnits as defined in input xml file.

Returns:

collection containing OrganizationalUnits targeted for removal.