com.example.opendj.meta.ExamplePluginCfgDefn Maven / Gradle / Ivy
Show all versions of opendj-server-example-plugin Show documentation
/*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions Copyright [year] [name of copyright owner]".
*
* Copyright 2008 Sun Microsystems, Inc.
*/
package com.example.opendj.meta;
import com.example.opendj.client.ExamplePluginCfgClient;
import com.example.opendj.server.ExamplePluginCfg;
import java.util.Collection;
import java.util.SortedSet;
import org.forgerock.opendj.config.AdministratorAction;
import org.forgerock.opendj.config.BooleanPropertyDefinition;
import org.forgerock.opendj.config.ClassPropertyDefinition;
import org.forgerock.opendj.config.client.ConcurrentModificationException;
import org.forgerock.opendj.config.client.ManagedObject;
import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException;
import org.forgerock.opendj.config.client.OperationRejectedException;
import org.forgerock.opendj.config.DefaultBehaviorProvider;
import org.forgerock.opendj.config.DefinedDefaultBehaviorProvider;
import org.forgerock.opendj.config.EnumPropertyDefinition;
import org.forgerock.opendj.config.ManagedObjectAlreadyExistsException;
import org.forgerock.opendj.config.ManagedObjectDefinition;
import org.forgerock.opendj.config.PropertyOption;
import org.forgerock.opendj.config.PropertyProvider;
import org.forgerock.opendj.config.server.ConfigurationChangeListener;
import org.forgerock.opendj.config.server.ServerManagedObject;
import org.forgerock.opendj.config.StringPropertyDefinition;
import org.forgerock.opendj.config.Tag;
import org.forgerock.opendj.ldap.DN;
import org.forgerock.opendj.ldap.LdapException;
import org.forgerock.opendj.server.config.meta.PluginCfgDefn;
import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType;
import org.forgerock.opendj.server.config.server.PluginCfg;
/**
* An interface for querying the Example Plugin managed object
* definition meta information.
*
* An example "Hello World" plugin.
*/
public final class ExamplePluginCfgDefn extends ManagedObjectDefinition {
/** The singleton configuration definition instance. */
private static final ExamplePluginCfgDefn INSTANCE = new ExamplePluginCfgDefn();
/** The "java-class" property definition. */
private static final ClassPropertyDefinition PD_JAVA_CLASS;
/** The "message" property definition. */
private static final StringPropertyDefinition PD_MESSAGE;
/** Build the "java-class" property definition. */
static {
ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
builder.setOption(PropertyOption.MANDATORY);
builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "java-class"));
DefaultBehaviorProvider provider = new DefinedDefaultBehaviorProvider("com.example.opendj.ExamplePlugin");
builder.setDefaultBehaviorProvider(provider);
builder.addInstanceOf("org.opends.server.api.plugin.DirectoryServerPlugin");
PD_JAVA_CLASS = builder.getInstance();
INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
}
/** Build the "message" property definition. */
static {
StringPropertyDefinition.Builder builder = StringPropertyDefinition.createBuilder(INSTANCE, "message");
builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "message"));
DefaultBehaviorProvider provider = new DefinedDefaultBehaviorProvider("Hello World");
builder.setDefaultBehaviorProvider(provider);
PD_MESSAGE = builder.getInstance();
INSTANCE.registerPropertyDefinition(PD_MESSAGE);
}
// Register the tags associated with this managed object definition.
static {
INSTANCE.registerTag(Tag.valueOf("core-server"));
}
/**
* Get the Example Plugin configuration definition singleton.
*
* @return Returns the Example Plugin configuration definition
* singleton.
*/
public static ExamplePluginCfgDefn getInstance() {
return INSTANCE;
}
/**
* Private constructor.
*/
private ExamplePluginCfgDefn() {
super("example-plugin", PluginCfgDefn.getInstance());
}
/** {@inheritDoc} */
public ExamplePluginCfgClient createClientConfiguration(
ManagedObject impl) {
return new ExamplePluginCfgClientImpl(impl);
}
/** {@inheritDoc} */
public ExamplePluginCfg createServerConfiguration(
ServerManagedObject impl) {
return new ExamplePluginCfgServerImpl(impl);
}
/** {@inheritDoc} */
public Class getServerConfigurationClass() {
return ExamplePluginCfg.class;
}
/**
* Get the "enabled" property definition.
*
* Indicates whether the plug-in is enabled for use.
*
* @return Returns the "enabled" property definition.
*/
public BooleanPropertyDefinition getEnabledPropertyDefinition() {
return PluginCfgDefn.getInstance().getEnabledPropertyDefinition();
}
/**
* Get the "invoke-for-internal-operations" property definition.
*
* Indicates whether the plug-in should be invoked for internal
* operations.
*
* Any plug-in that can be invoked for internal operations must
* ensure that it does not create any new internal operatons that can
* cause the same plug-in to be re-invoked.
*
* @return Returns the "invoke-for-internal-operations" property definition.
*/
public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition() {
return PluginCfgDefn.getInstance().getInvokeForInternalOperationsPropertyDefinition();
}
/**
* Get the "java-class" property definition.
*
* Specifies the fully-qualified name of the Java class that
* provides the plug-in implementation.
*
* @return Returns the "java-class" property definition.
*/
public ClassPropertyDefinition getJavaClassPropertyDefinition() {
return PD_JAVA_CLASS;
}
/**
* Get the "message" property definition.
*
* The message to be logged.
*
* @return Returns the "message" property definition.
*/
public StringPropertyDefinition getMessagePropertyDefinition() {
return PD_MESSAGE;
}
/**
* Get the "plugin-type" property definition.
*
* Specifies the set of plug-in types for the plug-in, which
* specifies the times at which the plug-in is invoked.
*
* @return Returns the "plugin-type" property definition.
*/
public EnumPropertyDefinition getPluginTypePropertyDefinition() {
return PluginCfgDefn.getInstance().getPluginTypePropertyDefinition();
}
/**
* Managed object client implementation.
*/
private static class ExamplePluginCfgClientImpl implements
ExamplePluginCfgClient {
/** Private implementation. */
private ManagedObject impl;
/** Private constructor. */
private ExamplePluginCfgClientImpl(
ManagedObject impl) {
this.impl = impl;
}
/** {@inheritDoc} */
public Boolean isEnabled() {
return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
}
/** {@inheritDoc} */
public void setEnabled(boolean value) {
impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
}
/** {@inheritDoc} */
public boolean isInvokeForInternalOperations() {
return impl.getPropertyValue(INSTANCE.getInvokeForInternalOperationsPropertyDefinition());
}
/** {@inheritDoc} */
public void setInvokeForInternalOperations(Boolean value) {
impl.setPropertyValue(INSTANCE.getInvokeForInternalOperationsPropertyDefinition(), value);
}
/** {@inheritDoc} */
public String getJavaClass() {
return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
}
/** {@inheritDoc} */
public void setJavaClass(String value) {
impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
}
/** {@inheritDoc} */
public String getMessage() {
return impl.getPropertyValue(INSTANCE.getMessagePropertyDefinition());
}
/** {@inheritDoc} */
public void setMessage(String value) {
impl.setPropertyValue(INSTANCE.getMessagePropertyDefinition(), value);
}
/** {@inheritDoc} */
public SortedSet getPluginType() {
return impl.getPropertyValues(INSTANCE.getPluginTypePropertyDefinition());
}
/** {@inheritDoc} */
public void setPluginType(Collection values) {
impl.setPropertyValues(INSTANCE.getPluginTypePropertyDefinition(), values);
}
/** {@inheritDoc} */
public ManagedObjectDefinition definition() {
return INSTANCE;
}
/** {@inheritDoc} */
public PropertyProvider properties() {
return impl;
}
/** {@inheritDoc} */
public void commit() throws ManagedObjectAlreadyExistsException,
MissingMandatoryPropertiesException, ConcurrentModificationException,
OperationRejectedException, LdapException {
impl.commit();
}
/** {@inheritDoc} */
public String toString() {
return impl.toString();
}
}
/**
* Managed object server implementation.
*/
private static class ExamplePluginCfgServerImpl implements
ExamplePluginCfg {
/** Private implementation. */
private ServerManagedObject impl;
/** The value of the "enabled" property. */
private final boolean pEnabled;
/** The value of the "invoke-for-internal-operations" property. */
private final boolean pInvokeForInternalOperations;
/** The value of the "java-class" property. */
private final String pJavaClass;
/** The value of the "message" property. */
private final String pMessage;
/** The value of the "plugin-type" property. */
private final SortedSet pPluginType;
/** Private constructor. */
private ExamplePluginCfgServerImpl(ServerManagedObject impl) {
this.impl = impl;
this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
this.pInvokeForInternalOperations = impl.getPropertyValue(INSTANCE.getInvokeForInternalOperationsPropertyDefinition());
this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
this.pMessage = impl.getPropertyValue(INSTANCE.getMessagePropertyDefinition());
this.pPluginType = impl.getPropertyValues(INSTANCE.getPluginTypePropertyDefinition());
}
/** {@inheritDoc} */
public void addExampleChangeListener(
ConfigurationChangeListener listener) {
impl.registerChangeListener(listener);
}
/** {@inheritDoc} */
public void removeExampleChangeListener(
ConfigurationChangeListener listener) {
impl.deregisterChangeListener(listener);
}
/** {@inheritDoc} */
public void addChangeListener(
ConfigurationChangeListener listener) {
impl.registerChangeListener(listener);
}
/** {@inheritDoc} */
public void removeChangeListener(
ConfigurationChangeListener listener) {
impl.deregisterChangeListener(listener);
}
/** {@inheritDoc} */
public boolean isEnabled() {
return pEnabled;
}
/** {@inheritDoc} */
public boolean isInvokeForInternalOperations() {
return pInvokeForInternalOperations;
}
/** {@inheritDoc} */
public String getJavaClass() {
return pJavaClass;
}
/** {@inheritDoc} */
public String getMessage() {
return pMessage;
}
/** {@inheritDoc} */
public SortedSet getPluginType() {
return pPluginType;
}
/** {@inheritDoc} */
public Class configurationClass() {
return ExamplePluginCfg.class;
}
/** {@inheritDoc} */
public DN dn() {
return impl.getDN();
}
/** {@inheritDoc} */
public String name() {
return impl.getName();
}
/** {@inheritDoc} */
public String toString() {
return impl.toString();
}
}
}