();
// The optional name of a boolean "enabled" property in the
// aggregated managed object. This property must not be false
// while the aggregated managed object is referenced.
private String targetEnabledPropertyName = null;
// Private constructor
private Builder(AbstractManagedObjectDefinition d,
String propertyName) {
super(d, propertyName);
}
/**
* Sets the name of the managed object which is the parent of the
* aggregated managed objects.
*
* This must be defined before the property definition can be
* built.
*
* @param pathString
* The string representation of the managed object path
* specifying the parent of the aggregated managed
* objects.
*/
public final void setParentPath(String pathString) {
this.parentPathString = pathString;
}
/**
* Sets the relation in the parent managed object which contains
* the aggregated managed objects.
*
* This must be defined before the property definition can be
* built.
*
* @param rdName
* The name of a relation in the parent managed object
* which contains the aggregated managed objects.
*/
public final void setRelationDefinition(String rdName) {
this.rdName = rdName;
}
/**
* Registers a boolean "enabled" property in this managed object.
* When all the registered properties are true, the enabled
* property in the aggregated managed object must also be true.
*
* By default no source properties are defined which indicates
* that the target property must always be true. When there is one
* or more source properties defined, a target property must also
* be defined.
*
* @param sourceEnabledPropertyName
* The optional boolean "enabled" property in this
* managed object.
*/
public final void addSourceEnabledPropertyName(
String sourceEnabledPropertyName) {
this.sourceEnabledPropertyNames.add(sourceEnabledPropertyName);
}
/**
* Sets the optional boolean "enabled" property in the aggregated
* managed object. This property must not be false while the
* aggregated managed object is referenced.
*
* By default no target property is defined. It must be defined,
* if the source property is defined.
*
* @param targetEnabledPropertyName
* The optional boolean "enabled" property in the
* aggregated managed object.
*/
public final void setTargetEnabledPropertyName(
String targetEnabledPropertyName) {
this.targetEnabledPropertyName = targetEnabledPropertyName;
}
/**
* {@inheritDoc}
*/
@Override
protected AggregationPropertyDefinition buildInstance(
AbstractManagedObjectDefinition d, String propertyName,
EnumSet options, AdministratorAction adminAction,
DefaultBehaviorProvider defaultBehavior) {
// Make sure that the parent path has been defined.
if (parentPathString == null) {
throw new IllegalStateException("Parent path undefined");
}
// Make sure that the relation definition has been defined.
if (rdName == null) {
throw new IllegalStateException("Relation definition undefined");
}
// Make sure that if a source property is specified then a
// target property is also specified.
if (!sourceEnabledPropertyNames.isEmpty()
&& targetEnabledPropertyName == null) {
throw new IllegalStateException(
"One or more source properties defined but " +
"target property is undefined");
}
return new AggregationPropertyDefinition(d, propertyName, options,
adminAction, defaultBehavior, parentPathString, rdName,
sourceEnabledPropertyNames, targetEnabledPropertyName);
}
}
/**
* A change listener which prevents the named component from being
* disabled.
*/
private class ReferentialIntegrityChangeListener implements
ConfigurationChangeListener {
// The error message which should be returned if an attempt is
// made to disable the referenced component.
private final Message message;
// The path of the referenced component.
private final ManagedObjectPath path;
// Creates a new referential integrity delete listener.
private ReferentialIntegrityChangeListener(ManagedObjectPath path,
Message message) {
this.path = path;
this.message = message;
}
/**
* {@inheritDoc}
*/
public ConfigChangeResult applyConfigurationChange(S configuration) {
PropertyProvider provider = configuration.properties();
Collection values = provider
.getPropertyValues(getTargetEnabledPropertyDefinition());
if (values.iterator().next() == false) {
// This should not happen - the
// isConfigurationChangeAcceptable() call-back should have
// trapped this.
throw new IllegalStateException("Attempting to disable a referenced "
+ configuration.definition().getUserFriendlyName());
} else {
return new ConfigChangeResult(ResultCode.SUCCESS, false);
}
}
/**
* {@inheritDoc}
*/
public boolean isConfigurationChangeAcceptable(S configuration,
List unacceptableReasons) {
// Always prevent the referenced component from being
// disabled.
PropertyProvider provider = configuration.properties();
Collection values = provider
.getPropertyValues(getTargetEnabledPropertyDefinition());
if (values.iterator().next() == false) {
unacceptableReasons.add(message);
return false;
}
return true;
}
// Gets the path associated with this listener.
private ManagedObjectPath getManagedObjectPath() {
return path;
}
}
/**
* A delete listener which prevents the named component from being
* deleted.
*/
private class ReferentialIntegrityDeleteListener implements
ConfigurationDeleteListener {
// The DN of the referenced configuration entry.
private final DN dn;
// The error message which should be returned if an attempt is
// made to delete the referenced component.
private final Message message;
// Creates a new referential integrity delete listener.
private ReferentialIntegrityDeleteListener(DN dn, Message message) {
this.dn = dn;
this.message = message;
}
/**
* {@inheritDoc}
*/
public ConfigChangeResult applyConfigurationDelete(S configuration) {
// This should not happen - the
// isConfigurationDeleteAcceptable() call-back should have
// trapped this.
if (configuration.dn().equals(dn)) {
// This should not happen - the
// isConfigurationDeleteAcceptable() call-back should have
// trapped this.
throw new IllegalStateException("Attempting to delete a referenced "
+ configuration.definition().getUserFriendlyName());
} else {
return new ConfigChangeResult(ResultCode.SUCCESS, false);
}
}
/**
* {@inheritDoc}
*/
public boolean isConfigurationDeleteAcceptable(S configuration,
List unacceptableReasons) {
if (configuration.dn().equals(dn)) {
// Always prevent deletion of the referenced component.
unacceptableReasons.add(message);
return false;
}
return true;
}
}
/**
* The server-side constraint handler implementation.
*/
private class ServerHandler extends ServerConstraintHandler {
// The associated property definition.
private final AggregationPropertyDefinition pd;
// Creates a new server-side constraint handler.
private ServerHandler(AggregationPropertyDefinition pd) {
this.pd = pd;
}
/**
* {@inheritDoc}
*/
@Override
public boolean isUsable(ServerManagedObject managedObject,
Collection unacceptableReasons) throws ConfigException {
SortedSet names = managedObject.getPropertyValues(pd);
ServerManagementContext context = ServerManagementContext.getInstance();
BooleanPropertyDefinition tpd = pd.getTargetEnabledPropertyDefinition();
List spdlist = pd
.getSourceEnabledPropertyDefinitions();
Message thisUFN = managedObject.getManagedObjectDefinition()
.getUserFriendlyName();
String thisDN = managedObject.getDN().toString();
Message thatUFN = pd.getRelationDefinition().getUserFriendlyName();
boolean isUsable = true;
for (String name : names) {
ManagedObjectPath path = pd.getChildPath(name);
String thatDN = path.toDN().toString();
if (!context.managedObjectExists(path)) {
Message msg = ERR_SERVER_REFINT_DANGLING_REFERENCE.get(name, pd
.getName(), thisUFN, thisDN, thatUFN, thatDN);
unacceptableReasons.add(msg);
isUsable = false;
} else if (tpd != null) {
// Check that the referenced component is enabled.
ServerManagedObject ref = context.getManagedObject(path);
if (!spdlist.isEmpty()) {
// Target must be enabled but only if the source
// properties are enabled.
boolean isRequired = true;
for (BooleanPropertyDefinition spd : spdlist) {
if (!managedObject.getPropertyValue(spd)) {
isRequired = false;
break;
}
}
if (isRequired && !ref.getPropertyValue(tpd)) {
Message msg = ERR_SERVER_REFINT_SOURCE_ENABLED_TARGET_DISABLED
.get(name, pd.getName(), thisUFN, thisDN, thatUFN, thatDN);
unacceptableReasons.add(msg);
isUsable = false;
}
} else {
// Target must always be enabled.
if (!ref.getPropertyValue(tpd)) {
Message msg = ERR_SERVER_REFINT_TARGET_DISABLED.get(name, pd
.getName(), thisUFN, thisDN, thatUFN, thatDN);
unacceptableReasons.add(msg);
isUsable = false;
}
}
}
}
return isUsable;
}
/**
* {@inheritDoc}
*/
@Override
public void performPostAdd(ServerManagedObject managedObject)
throws ConfigException {
// First make sure existing listeners associated with this
// managed object are removed. This is required in order to
// prevent multiple change listener registrations from
// occurring, for example if this call-back is invoked multiple
// times after the same add event.
performPostDelete(managedObject);
// Add change and delete listeners against all referenced
// components.
BooleanPropertyDefinition tpd = pd.getTargetEnabledPropertyDefinition();
List spdlist = pd
.getSourceEnabledPropertyDefinitions();
Message thisUFN = managedObject.getManagedObjectDefinition()
.getUserFriendlyName();
String thisDN = managedObject.getDN().toString();
Message thatUFN = pd.getRelationDefinition().getUserFriendlyName();
// Referenced managed objects will only need a change listener
// if they have can be disabled.
boolean needsChangeListeners;
if (tpd != null) {
needsChangeListeners = true;
for (BooleanPropertyDefinition spd : spdlist) {
if (!managedObject.getPropertyValue(spd)) {
needsChangeListeners = false;
break;
}
}
} else {
needsChangeListeners = false;
}
// Delete listeners need to be registered against the parent
// entry of the referenced components.
ServerManagementContext context = ServerManagementContext.getInstance();
ManagedObjectPath parentPath = pd.getParentPath();
ServerManagedObject parent = context.getManagedObject(parentPath);
// Create entries in the listener tables.
List dlist =
new LinkedList();
deleteListeners.put(managedObject.getDN(), dlist);
List clist =
new LinkedList();
changeListeners.put(managedObject.getDN(), clist);
for (String name : managedObject.getPropertyValues(pd)) {
ManagedObjectPath path = pd.getChildPath(name);
DN dn = path.toDN();
String thatDN = dn.toString();
// Register the delete listener.
Message msg = ERR_SERVER_REFINT_CANNOT_DELETE.get(thatUFN, thatDN, pd
.getName(), thisUFN, thisDN);
ReferentialIntegrityDeleteListener dl =
new ReferentialIntegrityDeleteListener(dn, msg);
parent.registerDeleteListener(pd.getRelationDefinition(), dl);
dlist.add(dl);
// Register the change listener if required.
if (needsChangeListeners) {
ServerManagedObject ref = context.getManagedObject(path);
msg = ERR_SERVER_REFINT_CANNOT_DISABLE.get(thatUFN, thatDN, pd
.getName(), thisUFN, thisDN);
ReferentialIntegrityChangeListener cl =
new ReferentialIntegrityChangeListener(path, msg);
ref.registerChangeListener(cl);
clist.add(cl);
}
}
}
/**
* {@inheritDoc}
*/
@Override
public void performPostDelete(ServerManagedObject managedObject)
throws ConfigException {
// Remove any registered delete and change listeners.
ServerManagementContext context = ServerManagementContext.getInstance();
DN dn = managedObject.getDN();
// Delete listeners need to be deregistered against the parent
// entry of the referenced components.
ManagedObjectPath parentPath = pd.getParentPath();
ServerManagedObject parent = context.getManagedObject(parentPath);
if (deleteListeners.containsKey(dn)) {
for (ReferentialIntegrityDeleteListener dl : deleteListeners.get(dn)) {
parent.deregisterDeleteListener(pd.getRelationDefinition(), dl);
}
deleteListeners.remove(dn);
}
// Change listeners need to be deregistered from their
// associated referenced component.
if (changeListeners.containsKey(dn)) {
for (ReferentialIntegrityChangeListener cl : changeListeners.get(dn)) {
ManagedObjectPath path = cl.getManagedObjectPath();
ServerManagedObject ref = context.getManagedObject(path);
ref.deregisterChangeListener(cl);
}
changeListeners.remove(dn);
}
}
/**
* {@inheritDoc}
*/
@Override
public void performPostModify(ServerManagedObject managedObject)
throws ConfigException {
// Remove all the constraints associated with this managed
// object and then re-register them.
performPostDelete(managedObject);
performPostAdd(managedObject);
}
}
/**
* Creates an aggregation property definition builder.
*
* @param
* The type of client managed object configuration that
* this aggregation property definition refers to.
* @param
* The type of server managed object configuration that
* this aggregation property definition refers to.
* @param d
* The managed object definition associated with this
* property definition.
* @param propertyName
* The property name.
* @return Returns the new aggregation property definition builder.
*/
public static
Builder createBuilder(
AbstractManagedObjectDefinition d, String propertyName) {
return new Builder(d, propertyName);
}
// The active server-side referential integrity change listeners
// associated with this property.
private final Map>
changeListeners =
new HashMap>();
// The active server-side referential integrity delete listeners
// associated with this property.
private final Map>
deleteListeners =
new HashMap>();
// The name of the managed object which is the parent of the
// aggregated managed objects.
private ManagedObjectPath parentPath;
// The string representation of the managed object path specifying
// the parent of the aggregated managed objects.
private final String parentPathString;
// The name of a relation in the parent managed object which
// contains the aggregated managed objects.
private final String rdName;
// The relation in the parent managed object which contains the
// aggregated managed objects.
private InstantiableRelationDefinition relationDefinition;
// The decoded source property definitions.
private List sourceEnabledProperties;
// The optional names of boolean "enabled" properties in this
// managed object. When all of the properties are true or if there
// are none defined, the enabled property in the aggregated managed
// object must also be true.
private final List sourceEnabledPropertyNames;
// The decoded target property definition.
private BooleanPropertyDefinition targetEnabledProperty;
// The optional name of a boolean "enabled" property in the
// aggregated managed object. This property must not be false
// while the aggregated managed object is referenced.
private final String targetEnabledPropertyName;
// Private constructor.
private AggregationPropertyDefinition(
AbstractManagedObjectDefinition d, String propertyName,
EnumSet options, AdministratorAction adminAction,
DefaultBehaviorProvider defaultBehavior, String parentPathString,
String rdName, List sourceEnabledPropertyNames,
String targetEnabledPropertyName) {
super(d, String.class, propertyName, options, adminAction, defaultBehavior);
this.parentPathString = parentPathString;
this.rdName = rdName;
this.sourceEnabledPropertyNames = sourceEnabledPropertyNames;
this.targetEnabledPropertyName = targetEnabledPropertyName;
}
/**
* {@inheritDoc}
*/
@Override
public R accept(PropertyDefinitionVisitor v, P p) {
return v.visitAggregation(this, p);
}
/**
* {@inheritDoc}
*/
@Override
public R accept(PropertyValueVisitor v, String value, P p) {
return v.visitAggregation(this, value, p);
}
/**
* {@inheritDoc}
*/
@Override
public String decodeValue(String value)
throws IllegalPropertyValueStringException {
ensureNotNull(value);
try {
validateValue(value);
return value;
} catch (IllegalPropertyValueException e) {
throw new IllegalPropertyValueStringException(this, value);
}
}
/**
* Constructs a DN for a referenced managed object having the
* provided name. This method is implemented by first calling
* {@link #getChildPath(String)} and then invoking
* {@code ManagedObjectPath.toDN()} on the returned path.
*
* @param name
* The name of the child managed object.
* @return Returns a DN for a referenced managed object having the
* provided name.
*/
public final DN getChildDN(String name) {
return getChildPath(name).toDN();
}
/**
* Constructs a managed object path for a referenced managed object
* having the provided name.
*
* @param name
* The name of the child managed object.
* @return Returns a managed object path for a referenced managed
* object having the provided name.
*/
public final ManagedObjectPath getChildPath(String name) {
return parentPath.child(relationDefinition, name);
}
/**
* {@inheritDoc}
*/
public Collection getClientConstraintHandlers() {
// TODO: not yet implemented.
return Collections.emptyList();
}
/**
* Gets the name of the managed object which is the parent of the
* aggregated managed objects.
*
* @return Returns the name of the managed object which is the
* parent of the aggregated managed objects.
*/
public final ManagedObjectPath getParentPath() {
return parentPath;
}
/**
* Gets the relation in the parent managed object which contains the
* aggregated managed objects.
*
* @return Returns the relation in the parent managed object which
* contains the aggregated managed objects.
*/
public final InstantiableRelationDefinition getRelationDefinition() {
return relationDefinition;
}
/**
* {@inheritDoc}
*/
public Collection getServerConstraintHandlers() {
ServerConstraintHandler handler = new ServerHandler(this);
return Collections.singleton(handler);
}
/**
* Gets the optional boolean "enabled" properties in this managed
* object. When these properties are all true or if there are no
* properties, the enabled property in the aggregated managed object
* must also be true.
*
* @return Returns the optional boolean "enabled" properties in this
* managed object, which may be empty.
*/
public final List
getSourceEnabledPropertyDefinitions() {
return sourceEnabledProperties;
}
/**
* Gets the optional boolean "enabled" property in the aggregated
* managed object. This property must not be false while the
* aggregated managed object is referenced.
*
* @return Returns the optional boolean "enabled" property in the
* aggregated managed object, or null if none
* is defined.
*/
public final BooleanPropertyDefinition getTargetEnabledPropertyDefinition() {
return targetEnabledProperty;
}
/**
* {@inheritDoc}
*/
@Override
public String normalizeValue(String value)
throws IllegalPropertyValueException {
try {
Reference reference = Reference.parseName(parentPath,
relationDefinition, value);
return reference.getNormalizedName();
} catch (IllegalArgumentException e) {
throw new IllegalPropertyValueException(this, value);
}
}
/**
* {@inheritDoc}
*/
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
builder.append(" parentPath=");
builder.append(parentPath);
builder.append(" relationDefinition=");
builder.append(relationDefinition.getName());
builder.append(" sourceEnabledPropertyName=[");
boolean isFirst = true;
for (String name : sourceEnabledPropertyNames) {
if (!isFirst) {
builder.append(", ");
} else {
isFirst = false;
}
builder.append(name);
}
builder.append(']');
if (targetEnabledPropertyName != null) {
builder.append(" targetEnabledPropertyName=");
builder.append(targetEnabledPropertyName);
}
}
/**
* {@inheritDoc}
*/
@Override
public void validateValue(String value) throws IllegalPropertyValueException {
try {
Reference.parseName(parentPath, relationDefinition, value);
} catch (IllegalArgumentException e) {
throw new IllegalPropertyValueException(this, value);
}
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
@Override
protected void initialize() throws Exception {
// Decode the path.
parentPath = ManagedObjectPath.valueOf(parentPathString);
// Decode the relation definition.
AbstractManagedObjectDefinition parent = parentPath
.getManagedObjectDefinition();
RelationDefinition rd = parent.getRelationDefinition(rdName);
relationDefinition = (InstantiableRelationDefinition) rd;
// Now decode the property definitions.
AbstractManagedObjectDefinition d = getManagedObjectDefinition();
sourceEnabledProperties = new LinkedList();
for (String name : sourceEnabledPropertyNames) {
PropertyDefinition pd = d.getPropertyDefinition(name);
// Runtime cast is required to workaround a
// bug in JDK versions prior to 1.5.0_08.
sourceEnabledProperties.add(BooleanPropertyDefinition.class.cast(pd));
}
if (targetEnabledPropertyName == null) {
targetEnabledProperty = null;
} else {
PropertyDefinition pd;
d = relationDefinition.getChildDefinition();
pd = d.getPropertyDefinition(targetEnabledPropertyName);
// Runtime cast is required to workaround a
// bug in JDK versions prior to 1.5.0_08.
targetEnabledProperty = BooleanPropertyDefinition.class.cast(pd);
}
}
}