You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2016/11/30 17:52:02 UTC
svn commit: r1772097 - in
/directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger:
LdapOperation.java StoredProcedureParameter.java TriggerUtils.java
Author: elecharny
Date: Wed Nov 30 17:52:02 2016
New Revision: 1772097
URL: http://svn.apache.org/viewvc?rev=1772097&view=rev
Log:
Added some missing javadoc
Modified:
directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java
directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java
directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/TriggerUtils.java
Modified: directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java?rev=1772097&r1=1772096&r2=1772097&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java (original)
+++ directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java Wed Nov 30 17:52:02 2016
@@ -28,18 +28,25 @@ package org.apache.directory.api.ldap.tr
*/
public enum LdapOperation
{
+ /** The Modify operation */
MODIFY("Modify"),
+ /** The Add operation */
ADD("Add"),
+ /** The Delete operation */
DELETE("Delete"),
+ /** The ModDN operation */
MODIFYDN("ModifyDN"),
+ /** The Rename operation */
MODIFYDN_RENAME("ModifyDN.Rename"),
+ /** The Export operation */
MODIFYDN_EXPORT("ModifyDN.Export"),
+ /** The Import operation */
MODIFYDN_IMPORT("ModifyDN.Import");
private final String name;
Modified: directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java?rev=1772097&r1=1772096&r2=1772097&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java (original)
+++ directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java Wed Nov 30 17:52:02 2016
@@ -31,6 +31,9 @@ import org.apache.directory.api.ldap.mod
*/
public abstract class StoredProcedureParameter
{
+ /**
+ * The generic LdapContext factory
+ */
public static final class Generic_LDAP_CONTEXT extends StoredProcedureParameter
{
private Dn ctxName;
@@ -43,18 +46,30 @@ public abstract class StoredProcedurePar
}
+ /**
+ * Creates a new instance of StoredProcedureParameter
+ *
+ * @param ctxName The context name
+ * @return A new instance of StoredProcedureParameter
+ */
public static StoredProcedureParameter instance( Dn ctxName )
{
return new Generic_LDAP_CONTEXT( ctxName );
}
+ /**
+ * @return The context name
+ */
public Dn getCtxName()
{
return ctxName;
}
+ /**
+ * @see Object#toString()
+ */
@Override
public String toString()
{
@@ -62,6 +77,10 @@ public abstract class StoredProcedurePar
}
}
+
+ /**
+ * The generic Operation Principal factory
+ */
public static final class Generic_OPERATION_PRINCIPAL extends StoredProcedureParameter
{
private static Generic_OPERATION_PRINCIPAL instance = new Generic_OPERATION_PRINCIPAL( "$operationPrincipal" );
@@ -73,6 +92,9 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The generic Operation Principal instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
@@ -129,15 +151,19 @@ public abstract class StoredProcedurePar
{
return true;
}
+
if ( obj == null )
{
return false;
}
+
if ( getClass() != obj.getClass() )
{
return false;
}
- final StoredProcedureParameter other = ( StoredProcedureParameter ) obj;
+
+ StoredProcedureParameter other = ( StoredProcedureParameter ) obj;
+
if ( name == null )
{
if ( other.name != null )
@@ -149,9 +175,14 @@ public abstract class StoredProcedurePar
{
return false;
}
+
return true;
}
+
+ /**
+ * The Modify Object factory
+ */
public static final class Modify_OBJECT extends StoredProcedureParameter
{
private static Modify_OBJECT instance = new Modify_OBJECT( "$object" );
@@ -163,12 +194,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify Object instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify Modification factory
+ */
public static final class Modify_MODIFICATION extends StoredProcedureParameter
{
private static Modify_MODIFICATION instance = new Modify_MODIFICATION( "$modification" );
@@ -180,12 +218,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify Modification instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify Old Entry factory
+ */
public static final class Modify_OLD_ENTRY extends StoredProcedureParameter
{
private static Modify_OLD_ENTRY instance = new Modify_OLD_ENTRY( "$oldEntry" );
@@ -197,12 +242,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify Old Entry instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify New Entry factory
+ */
public static final class Modify_NEW_ENTRY extends StoredProcedureParameter
{
private static Modify_NEW_ENTRY instance = new Modify_NEW_ENTRY( "$newEntry" );
@@ -214,12 +266,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify New Entry instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Add Entry factory
+ */
public static final class Add_ENTRY extends StoredProcedureParameter
{
private static Add_ENTRY instance = new Add_ENTRY( "$entry" );
@@ -231,12 +290,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Add Entry instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Add Attributes factory
+ */
public static final class Add_ATTRIBUTES extends StoredProcedureParameter
{
private static Add_ATTRIBUTES instance = new Add_ATTRIBUTES( "$attributes" );
@@ -248,12 +314,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Add Attributes instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Delete Name factory
+ */
public static final class Delete_NAME extends StoredProcedureParameter
{
private static Delete_NAME instance = new Delete_NAME( "$name" );
@@ -265,12 +338,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Delete Name instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Delete Deleted factory
+ */
public static final class Delete_DELETED_ENTRY extends StoredProcedureParameter
{
private static Delete_DELETED_ENTRY instance = new Delete_DELETED_ENTRY( "$deletedEntry" );
@@ -282,12 +362,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Delete Deleted instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify DN Entry factory
+ */
public static final class ModifyDN_ENTRY extends StoredProcedureParameter
{
private static ModifyDN_ENTRY instance = new ModifyDN_ENTRY( "$entry" );
@@ -299,12 +386,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify DN Entry instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify New Rdn factory
+ */
public static final class ModifyDN_NEW_RDN extends StoredProcedureParameter
{
private static ModifyDN_NEW_RDN instance = new ModifyDN_NEW_RDN( "$newrdn" );
@@ -316,12 +410,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify New Rdn instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify DN Delete Old RDN factory
+ */
public static final class ModifyDN_DELETE_OLD_RDN extends StoredProcedureParameter
{
private static ModifyDN_DELETE_OLD_RDN instance = new ModifyDN_DELETE_OLD_RDN( "$deleteoldrdn" );
@@ -333,12 +434,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify DN Delete Old RDN instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify DN New Superior factory
+ */
public static final class ModifyDN_NEW_SUPERIOR extends StoredProcedureParameter
{
private static ModifyDN_NEW_SUPERIOR instance = new ModifyDN_NEW_SUPERIOR( "$newSuperior" );
@@ -350,12 +458,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify DN New Superior instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify DN Old RDN factory
+ */
public static final class ModifyDN_OLD_RDN extends StoredProcedureParameter
{
private static ModifyDN_OLD_RDN instance = new ModifyDN_OLD_RDN( "$oldRDN" );
@@ -367,12 +482,19 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify DN Old RDN instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
+ /**
+ * The Modify DN Old Superior DN factory
+ */
public static final class ModifyDN_OLD_SUPERIOR_DN extends StoredProcedureParameter
{
private static ModifyDN_OLD_SUPERIOR_DN instance = new ModifyDN_OLD_SUPERIOR_DN( "$oldRDN" );
@@ -384,16 +506,18 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify DN Old Superior DN instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
}
}
+
/**
- *
- *
- * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * The Modify DN New DN factory
*/
public static final class ModifyDN_NEW_DN extends StoredProcedureParameter
{
@@ -406,6 +530,9 @@ public abstract class StoredProcedurePar
}
+ /**
+ * @return The Modify DN New DN instance
+ */
public static StoredProcedureParameter instance()
{
return instance;
Modified: directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/TriggerUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/TriggerUtils.java?rev=1772097&r1=1772096&r2=1772097&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/TriggerUtils.java (original)
+++ directory/shared/trunk/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/TriggerUtils.java Wed Nov 30 17:52:02 2016
@@ -41,12 +41,6 @@ import org.apache.directory.api.ldap.mod
*/
public final class TriggerUtils
{
- public static final String TRIGGER_EXECUTION_SPECIFIC_AREA_VALUE = SchemaConstants.TRIGGER_EXECUTION_SPECIFIC_AREA;
- public static final String TRIGGER_EXECUTION_SUBENTRY_OC = "triggerExecutionSubentry";
- public static final String ENTRY_TRIGGER_SPECIFICATION_ATTR = "entryTriggerSpecification";
- public static final String PRESCRIPTIVE_TRIGGER_SPECIFICATION_ATTR = "prescriptiveTriggerSpecification";
-
-
/**
* Private constructor.
*/
@@ -55,21 +49,35 @@ public final class TriggerUtils
}
+ /**
+ * Defines the Administration point and administrative role for the TriggerExecution specific point
+ * @param apCtx The administrative point context
+ * @throws NamingException If the operation failed
+ */
public static void defineTriggerExecutionSpecificPoint( LdapContext apCtx ) throws NamingException
{
- Attributes ap = apCtx.getAttributes( "", new String[]
- { SchemaConstants.ADMINISTRATIVE_ROLE_AT } );
+ Attributes ap = apCtx.getAttributes( "", new String[] { SchemaConstants.ADMINISTRATIVE_ROLE_AT } );
Attribute administrativeRole = ap.get( SchemaConstants.ADMINISTRATIVE_ROLE_AT );
- if ( administrativeRole == null
- || !AttributeUtils.containsValueCaseIgnore( administrativeRole, TRIGGER_EXECUTION_SPECIFIC_AREA_VALUE ) )
+
+ if ( ( administrativeRole == null )
+ || !AttributeUtils.containsValueCaseIgnore( administrativeRole, SchemaConstants.TRIGGER_EXECUTION_SPECIFIC_AREA ) )
{
Attributes changes = new BasicAttributes( SchemaConstants.ADMINISTRATIVE_ROLE_AT,
- TRIGGER_EXECUTION_SPECIFIC_AREA_VALUE, true );
+ SchemaConstants.TRIGGER_EXECUTION_SPECIFIC_AREA, true );
apCtx.modifyAttributes( "", DirContext.ADD_ATTRIBUTE, changes );
}
}
+ /**
+ * Create the Trigger execution subentry
+ *
+ * @param apCtx The administration point context
+ * @param subentryCN The CN used by the suentry
+ * @param subtreeSpec The subtree specification
+ * @param prescriptiveTriggerSpec The prescriptive trigger specification
+ * @throws NamingException If the operation failed
+ */
public static void createTriggerExecutionSubentry(
LdapContext apCtx,
String subentryCN,
@@ -81,28 +89,43 @@ public final class TriggerUtils
subentry.put( objectClass );
objectClass.add( SchemaConstants.TOP_OC );
objectClass.add( SchemaConstants.SUBENTRY_OC );
- objectClass.add( TRIGGER_EXECUTION_SUBENTRY_OC );
+ objectClass.add( SchemaConstants.TRIGGER_EXECUTION_SUBENTRY_OC );
subentry.put( SchemaConstants.SUBTREE_SPECIFICATION_AT, subtreeSpec );
- subentry.put( PRESCRIPTIVE_TRIGGER_SPECIFICATION_ATTR, prescriptiveTriggerSpec );
+ subentry.put( SchemaConstants.PRESCRIPTIVE_TRIGGER_SPECIFICATION_AT, prescriptiveTriggerSpec );
apCtx.createSubcontext( "cn=" + subentryCN, subentry );
}
+ /**
+ * Load an prescriptive trigger specification
+ *
+ * @param apCtx The administrative point context
+ * @param subentryCN The subentry CN
+ * @param triggerSpec The trigger specification
+ * @throws NamingException If the operation failed
+ */
public static void loadPrescriptiveTriggerSpecification(
LdapContext apCtx,
String subentryCN,
String triggerSpec ) throws NamingException
{
- Attributes changes = new BasicAttributes( PRESCRIPTIVE_TRIGGER_SPECIFICATION_ATTR, triggerSpec, true );
+ Attributes changes = new BasicAttributes( SchemaConstants.PRESCRIPTIVE_TRIGGER_SPECIFICATION_AT, triggerSpec, true );
apCtx.modifyAttributes( "cn=" + subentryCN, DirContext.ADD_ATTRIBUTE, changes );
}
+ /**
+ * Load the etrigger specification entry
+ *
+ * @param ctx The context
+ * @param triggerSpec The trigger specification
+ * @throws NamingException If the operation failed
+ */
public static void loadEntryTriggerSpecification(
LdapContext ctx,
String triggerSpec ) throws NamingException
{
- Attributes changes = new BasicAttributes( ENTRY_TRIGGER_SPECIFICATION_ATTR, triggerSpec, true );
+ Attributes changes = new BasicAttributes( SchemaConstants.ENTRY_TRIGGER_SPECIFICATION_AT, triggerSpec, true );
ctx.modifyAttributes( "", DirContext.ADD_ATTRIBUTE, changes );
}
}