StructuralObjectClassVirtualAttributeProvider.java revision ea1068c292e9b341af6d6b563cd8988a96be20a9
/*
* 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 legal-notices/CDDLv1_0.txt
* or http://forgerock.org/license/CDDLv1.0.html.
* 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 legal-notices/CDDLv1_0.txt.
* 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 2009 Sun Microsystems, Inc.
* Portions Copyright 2012-2015 ForgeRock AS
*/
package org.opends.server.extensions;
import java.util.List;
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.ldap.ConditionResult;
import org.forgerock.opendj.ldap.ResultCode;
import org.opends.server.admin.std.server.StructuralObjectClassVirtualAttributeCfg;
import org.opends.server.api.VirtualAttributeProvider;
import org.opends.server.core.SearchOperation;
import org.opends.server.types.Attribute;
import org.opends.server.types.Attributes;
import org.opends.server.types.Entry;
import org.opends.server.types.VirtualAttributeRule;
import static org.opends.messages.ExtensionMessages.*;
/**
* This class implements a virtual attribute provider that is meant to serve
* the structuralObjectClass operational attribute as described in RFC 4512.
*/
public class StructuralObjectClassVirtualAttributeProvider
extends VirtualAttributeProvider<StructuralObjectClassVirtualAttributeCfg>
{
/**
* Creates a new instance of this structuralObjectClass virtual attribute
* provider.
*/
public StructuralObjectClassVirtualAttributeProvider()
{
super();
// All initialization should be performed in the
// initializeVirtualAttributeProvider method.
}
/** {@inheritDoc} */
@Override
public boolean isMultiValued()
{
return false;
}
/** {@inheritDoc} */
@Override
public Attribute getValues(Entry entry, VirtualAttributeRule rule)
{
return Attributes.create(rule.getAttributeType(), entry
.getStructuralObjectClass().getNameOrOID());
}
/** {@inheritDoc} */
@Override
public boolean hasValue(Entry entry, VirtualAttributeRule rule)
{
//A structural object class is always present in an entry.
return true;
}
/** {@inheritDoc} */
@Override
public ConditionResult matchesSubstring(Entry entry,
VirtualAttributeRule rule,
ByteString subInitial,
List<ByteString> subAny,
ByteString subFinal)
{
//Substring matching is not supported.
return ConditionResult.UNDEFINED;
}
/** {@inheritDoc} */
@Override
public ConditionResult greaterThanOrEqualTo(Entry entry,
VirtualAttributeRule rule,
ByteString value)
{
// An object class can not be used for ordering.
return ConditionResult.UNDEFINED;
}
/** {@inheritDoc} */
@Override
public ConditionResult lessThanOrEqualTo(Entry entry,
VirtualAttributeRule rule,
ByteString value)
{
// An object class can not be used for ordering.
return ConditionResult.UNDEFINED;
}
/** {@inheritDoc} */
@Override
public ConditionResult approximatelyEqualTo(Entry entry,
VirtualAttributeRule rule,
ByteString value)
{
// An object class can not be used in approximate matching.
return ConditionResult.UNDEFINED;
}
/** {@inheritDoc} */
@Override
public boolean isSearchable(VirtualAttributeRule rule,
SearchOperation searchOperation,
boolean isPreIndexed)
{
// This attribute is not searchable, since it will have the same value in
// tons of entries.
return false;
}
/** {@inheritDoc} */
@Override
public void processSearch(VirtualAttributeRule rule,
SearchOperation searchOperation)
{
searchOperation.setResultCode(ResultCode.UNWILLING_TO_PERFORM);
LocalizableMessage message = ERR_VATTR_NOT_SEARCHABLE.get(
rule.getAttributeType().getNameOrOID());
searchOperation.appendErrorMessage(message);
}
}