|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ReferentialIntegrityPluginCfgClient
A client-side interface for reading and modifying Referential Integrity Plugin settings.
The Referential Integrity Plugin maintains referential integrity for DN valued attributes.
Method Summary | |
---|---|
ManagedObjectDefinition<? extends ReferentialIntegrityPluginCfgClient,? extends ReferentialIntegrityPluginCfg> |
definition()
Get the configuration definition associated with this Referential Integrity Plugin. |
java.util.SortedSet<AttributeType> |
getAttributeType()
Gets the "attribute-type" property. |
java.util.SortedSet<DN> |
getBaseDN()
Gets the "base-dn" property. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.lang.String |
getLogFile()
Gets the "log-file" property. |
java.util.SortedSet<PluginCfgDefn.PluginType> |
getPluginType()
Gets the "plugin-type" property. |
long |
getUpdateInterval()
Gets the "update-interval" property. |
void |
setAttributeType(java.util.Collection<AttributeType> values)
Sets the "attribute-type" property. |
void |
setBaseDN(java.util.Collection<DN> values)
Sets the "base-dn" property. |
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setLogFile(java.lang.String value)
Sets the "log-file" property. |
void |
setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
Sets the "plugin-type" property. |
void |
setUpdateInterval(java.lang.Long value)
Sets the "update-interval" property. |
Methods inherited from interface org.opends.server.admin.std.client.PluginCfgClient |
---|
isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends ReferentialIntegrityPluginCfgClient,? extends ReferentialIntegrityPluginCfg> definition()
definition
in interface ConfigurationClient
definition
in interface PluginCfgClient
java.util.SortedSet<AttributeType> getAttributeType()
Specifies the attribute types for which referential integrity is to be maintained.
At least one attribute type must be specified, and the syntax of any attributes must be either a distinguished name (1.3.6.1.4.1.1466.115.121.1.12) or name and optional UID (1.3.6.1.4.1.1466.115.121.1.34).
void setAttributeType(java.util.Collection<AttributeType> values) throws IllegalPropertyValueException
Specifies the attribute types for which referential integrity is to be maintained.
At least one attribute type must be specified, and the syntax of any attributes must be either a distinguished name (1.3.6.1.4.1.1466.115.121.1.12) or name and optional UID (1.3.6.1.4.1.1466.115.121.1.34).
values
- The values of the "attribute-type" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.util.SortedSet<DN> getBaseDN()
Specifies the base DN that limits the scope within which referential integrity is maintained.
void setBaseDN(java.util.Collection<DN> values) throws IllegalPropertyValueException
Specifies the base DN that limits the scope within which referential integrity is maintained.
values
- The values of the "base-dn" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
getJavaClass
in interface PluginCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
setJavaClass
in interface PluginCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getLogFile()
Specifies the log file location where the update records are written when the plug-in is in background-mode processing.
The default location is the logs directory of the server instance, using the file name "referint".
void setLogFile(java.lang.String value) throws IllegalPropertyValueException
Specifies the log file location where the update records are written when the plug-in is in background-mode processing.
The default location is the logs directory of the server instance, using the file name "referint".
value
- The value of the "log-file" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
getPluginType
in interface PluginCfgClient
void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values) throws IllegalPropertyValueException
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
setPluginType
in interface PluginCfgClient
values
- The values of the "plugin-type" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.long getUpdateInterval()
Specifies the interval in seconds when referential integrity updates are made.
If this value is 0, then the updates are made synchronously in the foreground.
void setUpdateInterval(java.lang.Long value) throws IllegalPropertyValueException
Specifies the interval in seconds when referential integrity updates are made.
If this value is 0, then the updates are made synchronously in the foreground.
value
- The value of the "update-interval" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |