/*
* 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.
* Portions Copyright 2012 ForgeRock AS
*/
package org.opends.server.extensions;
import org.opends.messages.Message;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.opends.server.admin.server.ConfigurationChangeListener;
import org.opends.server.admin.std.server.UserDefinedVirtualAttributeCfg;
import org.opends.server.api.VirtualAttributeProvider;
import org.opends.server.config.ConfigException;
import org.opends.server.core.SearchOperation;
import org.opends.server.types.*;
/**
* This class implements a virtual attribute provider that allows administrators
* to define their own values that will be inserted into any entry that matches
* the criteria defined in the virtual attribute rule. This can be used to
* provide functionality like Class of Service (CoS) in the Sun Java System
* Directory Server.
*/
public class UserDefinedVirtualAttributeProvider
extends VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>
implements ConfigurationChangeListener<UserDefinedVirtualAttributeCfg>
{
// The current configuration for this virtual attribute provider.
private UserDefinedVirtualAttributeCfg currentConfig;
/**
* Creates a new instance of this member virtual attribute provider.
*/
public UserDefinedVirtualAttributeProvider()
{
super();
// All initialization should be performed in the
// initializeVirtualAttributeProvider method.
}
/**
* {@inheritDoc}
*/
@Override()
public void initializeVirtualAttributeProvider(
UserDefinedVirtualAttributeCfg configuration)
throws ConfigException, InitializationException
{
this.currentConfig = configuration;
configuration.addUserDefinedChangeListener(this);
}
/**
* {@inheritDoc}
*/
@Override()
public void finalizeVirtualAttributeProvider()
{
currentConfig.removeUserDefinedChangeListener(this);
}
/**
* {@inheritDoc}
*/
@Override()
public boolean isMultiValued()
{
if (currentConfig == null)
{
return true;
}
else
{
return (currentConfig.getValue().size() > 1);
}
}
/**
* {@inheritDoc}
*/
@Override()
public Set<AttributeValue> getValues(Entry entry,
VirtualAttributeRule rule)
{
AttributeType attributeType = rule.getAttributeType();
Set<String> userDefinedValues = currentConfig.getValue();
switch (userDefinedValues.size()) {
case 0:
return Collections.emptySet();
case 1:
String valueString = userDefinedValues.iterator().next();
AttributeValue value =
AttributeValues.create(attributeType, valueString);
return Collections.singleton(value);
default:
HashSet<AttributeValue> values =
new HashSet<AttributeValue>(userDefinedValues.size());
for (String valueString2 : userDefinedValues)
{
values.add(AttributeValues.create(attributeType, valueString2));
}
return Collections.unmodifiableSet(values);
}
}
/**
* {@inheritDoc}
*/
@Override()
public boolean isSearchable(VirtualAttributeRule rule,
SearchOperation searchOperation,
boolean isPreIndexed)
{
// We will not allow searches based only on user-defined virtual attributes.
return false;
}
/**
* {@inheritDoc}
*/
@Override()
public void processSearch(VirtualAttributeRule rule,
SearchOperation searchOperation)
{
searchOperation.setResultCode(ResultCode.UNWILLING_TO_PERFORM);
return;
}
/**
* {@inheritDoc}
*/
public boolean isConfigurationChangeAcceptable(
UserDefinedVirtualAttributeCfg configuration,
List<Message> unacceptableReasons)
{
// The new configuration should always be acceptable.
return true;
}
/**
* {@inheritDoc}
*/
public ConfigChangeResult applyConfigurationChange(
UserDefinedVirtualAttributeCfg configuration)
{
// Just accept the new configuration as-is.
currentConfig = configuration;
return new ConfigChangeResult(ResultCode.SUCCESS, false);
}
}