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

Class Deluser

java.lang.Object

org.apache.directory.fortress.core.ant.Deluser

public class Deluser
extends Object

The class is used by FortressAntTask to load UserAnts used to drive AdminMgr.disableUser(org.apache.directory.fortress.core.model.User). 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, 'Deluser', is used for the xml tag in the load script.

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

Author:

Apache Directory Project

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addUser(UserAnt user)	This method name, 'addUser', is used for derived xml tag 'user' in the load script.
List<UserAnt>	getUsers()	Used by FortressAntTask.deleteUsers() to retrieve list of Users 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

Deluser

public Deluser()

All Ant data entities must have a default constructor.

Method Detail

addUser

public void addUser(UserAnt user)

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

 
 <deluser>
     <user userId="demoUser1"/>
     <user userId="demoUser3"/>
     <user userId="demoUser4"/>
     <user userId="demoUser5"/>
     <user userId="demoUser7"/>
     <user userId="demoUser9"/>
 </deluser>
 
 

Parameters:

user - contains reference to data element targeted for removal.

getUsers

public List<UserAnt> getUsers()

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

Returns:

collection containing UserAnts targeted for removal.