/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2008-2009 Sun Microsystems, Inc.
*/
package org.opends.server.admin;
/**
* A managed object composite relationship definition which represents
* a composition of a single managed object (i.e. the managed object
* must be present).
*
* @param <C>
* The type of client managed object configuration that this
* relation definition refers to.
* @param <S>
* The type of server managed object configuration that this
* relation definition refers to.
*/
public final class SingletonRelationDefinition
<C extends ConfigurationClient, S extends Configuration>
extends RelationDefinition<C, S> {
/**
* An interface for incrementally constructing singleton relation
* definitions.
*
* @param <C>
* The type of client managed object configuration that
* this relation definition refers to.
* @param <S>
* The type of server managed object configuration that
* this relation definition refers to.
*/
public static final class Builder
<C extends ConfigurationClient, S extends Configuration>
extends AbstractBuilder<C, S, SingletonRelationDefinition<C, S>> {
// The optional default managed object associated with this
// singleton relation.
private DefaultManagedObject<? extends C, ? extends S>
defaultManagedObject = null;
/**
* Creates a new builder which can be used to incrementally build
* an singleton relation definition.
*
* @param pd
* The parent managed object definition.
* @param name
* The name of the relation.
* @param cd
* The child managed object definition.
*/
public Builder(AbstractManagedObjectDefinition<?, ?> pd, String name,
AbstractManagedObjectDefinition<C, S> cd) {
super(pd, name, cd);
}
/**
* Sets the optional default managed object associated with this
* singleton relation definition.
*
* @param defaultManagedObject
* The default managed object or <code>null</code> if
* there is no default managed object defined for this
* relation definition.
*/
public void setDefaultManagedObject(
DefaultManagedObject<? extends C, ? extends S> defaultManagedObject) {
this.defaultManagedObject = defaultManagedObject;
}
/**
* {@inheritDoc}
*/
@Override
protected SingletonRelationDefinition<C, S> buildInstance(
Common<C, S> common) {
return new SingletonRelationDefinition<C, S>(common,
defaultManagedObject);
}
}
// The optional default managed object associated with this
// singleton relation.
private final DefaultManagedObject<? extends C, ? extends S>
defaultManagedObject;
// Private constructor.
private SingletonRelationDefinition(Common<C, S> common,
DefaultManagedObject<? extends C, ? extends S> defaultManagedObject) {
super(common);
this.defaultManagedObject = defaultManagedObject;
}
/**
* {@inheritDoc}
*/
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p) {
return v.visitSingleton(this, p);
}
/**
* Gets the optional default managed object associated with this
* singleton relation definition.
*
* @return Returns the default managed object or <code>null</code>
* if there is no default managed object defined for this
* relation definition.
*/
public DefaultManagedObject<? extends C, ? extends S>
getDefaultManagedObject() {
return defaultManagedObject;
}
/**
* {@inheritDoc}
*/
@Override
public void toString(StringBuilder builder) {
builder.append("name=");
builder.append(getName());
builder.append(" type=singleton parent=");
builder.append(getParentDefinition().getName());
builder.append(" child=");
builder.append(getChildDefinition().getName());
}
/**
* {@inheritDoc}
*/
@Override
protected void initialize() throws Exception {
if (defaultManagedObject != null) {
defaultManagedObject.initialize();
}
}
}