Class SuffixP
- java.lang.Object
-
- org.apache.directory.fortress.core.impl.SuffixP
-
public class SuffixP extends Object
Process module for the suffix or root node of Fortress directory structure. The suffix represents the topmost node in a directory information tree. For example dc=companyName,dc=com. The suffix data is passed usingSuffix
class. This class does perform simple data validations. TheFortressAntTask.addSuffixes()
method calls theadd(org.apache.directory.fortress.core.model.Suffix)
from this class during initial base loads. RemovalFortressAntTask.deleteSuffixes()
is performed during regression tests and should never be executed targeting production directory systems.
This class will acceptSuffix
, and forward on to it's corresponding DAO classSuffixDAO
for add/delete of suffix.Class will throw
SecurityException
to caller in the event of security policy, data constraint violation or system error internal to DAO object. This class will forward DAO exceptions (FinderException
,CreateException
,UpdateException
,RemoveException
), orValidationException
asSecurityException
s with appropriate error id fromGlobalErrIds
.The
delete(org.apache.directory.fortress.core.model.Suffix)
method in this class is destructive as it will remove all nodes below the suffix 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.Simple error mapping is performed in
validate(org.apache.directory.fortress.core.model.Suffix)
class.This class is thread safe.
- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description SuffixP()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(Suffix suffix)
Add a new suffix to the Directory Information Tree (DIT).void
delete(Suffix suffix)
Remove the suffix along with descendant nodes.
-
-
-
Method Detail
-
add
public final void add(Suffix suffix) throws SecurityException
Add a new suffix to the Directory Information Tree (DIT). After added the node will be listed in domain component format, i.e. dc=companyName, dc=com, or dc=orgName, dc=org.- Parameters:
suffix
- contains the dc name and top level dc for target node.- Throws:
SecurityException
- in event of validation or system error.
-
delete
public final void delete(Suffix suffix) throws SecurityException
Remove the suffix along with descendant nodes. This is a destructive method which will remove all DIT nodes under the specified.This method is destructive and will remove all nodes below.
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.- Parameters:
suffix
- contains the dc name and top level dc for target node.- Throws:
SecurityException
- in event of validation or system error.
-
-