Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2016-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2016-2024 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2016-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.transformations;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import com.unboundid.ldap.sdk.Attribute;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.ldap.sdk.schema.AttributeTypeDefinition;
import com.unboundid.ldap.sdk.schema.Schema;
import com.unboundid.util.Debug;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class provides an implementation of an entry transformation that can be
* used to replace existing attributes in entries with a default set of values.
* The default attributes will not be added to entries that do not have existing
* values for the target attributes.
*/
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class ReplaceAttributeTransformation
implements EntryTransformation
{
// The schema to use when processing.
@Nullable private final Schema schema;
// The set of attributes to replace in entries.
@NotNull private final Map attributes;
/**
* Creates a new replace attribute transformation that will replace existing
* values of the specified attribute with the provided set of default values.
*
* @param schema The schema to use to identify alternate names that
* may be used to reference the attributes to replace.
* It may be {@code null} to use a default standard
* schema.
* @param attributeName The name of the attribute for which to replace
* existing values. It must not be {@code null}.
* @param newValues The new values to use in place of the existing
* values for the specified attribute.
*/
public ReplaceAttributeTransformation(@Nullable final Schema schema,
@NotNull final String attributeName,
@NotNull final String... newValues)
{
this(schema, new Attribute(attributeName, schema, newValues));
}
/**
* Creates a new replace attribute transformation that will replace existing
* values of the specified attribute with the provided set of default values.
*
* @param schema The schema to use to identify alternate names that
* may be used to reference the attributes to replace.
* It may be {@code null} to use a default standard
* schema.
* @param attributeName The name of the attribute for which to replace
* existing values. It must not be {@code null}.
* @param newValues The new values to use in place of the existing
* values for the specified attribute.
*/
public ReplaceAttributeTransformation(@Nullable final Schema schema,
@NotNull final String attributeName,
@NotNull final Collection newValues)
{
this(schema, new Attribute(attributeName, schema, newValues));
}
/**
* Creates a new replace attribute transformation that will replace existing
* copies of the specified attributes with the provided versions.
*
* @param schema The schema to use to identify alternate names that may
* be used to reference the attributes to replace. It may
* be {@code null} to use a default standard schema.
* @param attributes The attributes to be used in place of existing
* attributes of the same type. It must not be
* {@code null} or empty.
*/
public ReplaceAttributeTransformation(@Nullable final Schema schema,
@NotNull final Attribute... attributes)
{
this(schema, StaticUtils.toList(attributes));
}
/**
* Creates a new replace attribute transformation that will replace existing
* copies of the specified attributes with the provided versions.
*
* @param schema The schema to use to identify alternate names that may
* be used to reference the attributes to replace. It may
* be {@code null} to use a default standard schema.
* @param attributes The attributes to be used in place of existing
* attributes of the same type. It must not be
* {@code null} or empty.
*/
public ReplaceAttributeTransformation(@Nullable final Schema schema,
@NotNull final Collection attributes)
{
// If a schema was provided, then use it. Otherwise, use the default
// standard schema.
Schema s = schema;
if (s == null)
{
try
{
s = Schema.getDefaultStandardSchema();
}
catch (final Exception e)
{
// This should never happen.
Debug.debugException(e);
}
}
this.schema = s;
// Identify all of the names that may be used to reference the attributes
// to replace.
final HashMap attrMap =
new HashMap<>(StaticUtils.computeMapCapacity(10));
for (final Attribute a : attributes)
{
final String baseName = StaticUtils.toLowerCase(a.getBaseName());
attrMap.put(baseName, a);
if (s != null)
{
final AttributeTypeDefinition at = s.getAttributeType(baseName);
if (at != null)
{
attrMap.put(StaticUtils.toLowerCase(at.getOID()),
new Attribute(at.getOID(), s, a.getValues()));
for (final String name : at.getNames())
{
final String lowerName = StaticUtils.toLowerCase(name);
if (! attrMap.containsKey(lowerName))
{
attrMap.put(lowerName, new Attribute(name, s, a.getValues()));
}
}
}
}
}
this.attributes = Collections.unmodifiableMap(attrMap);
}
/**
* {@inheritDoc}
*/
@Override()
@Nullable()
public Entry transformEntry(@NotNull final Entry e)
{
if (e == null)
{
return null;
}
// First, see if the entry has any of the target attributes. If not, we can
// just return the provided entry.
boolean hasAttributeToReplace = false;
final Collection originalAttributes = e.getAttributes();
for (final Attribute a : originalAttributes)
{
if (attributes.containsKey(StaticUtils.toLowerCase(a.getBaseName())))
{
hasAttributeToReplace = true;
break;
}
}
if (! hasAttributeToReplace)
{
return e;
}
// Create a copy of the entry with all appropriate attributes replaced with
// the appropriate default versions.
final ArrayList newAttributes =
new ArrayList<>(originalAttributes.size());
for (final Attribute a : originalAttributes)
{
final Attribute replacement =
attributes.get(StaticUtils.toLowerCase(a.getBaseName()));
if (replacement == null)
{
newAttributes.add(a);
}
else
{
if (a.hasOptions())
{
newAttributes.add(new Attribute(a.getName(), schema,
replacement.getRawValues()));
}
else
{
newAttributes.add(replacement);
}
}
}
return new Entry(e.getDN(), schema, newAttributes);
}
/**
* {@inheritDoc}
*/
@Override()
@Nullable()
public Entry translate(@NotNull final Entry original,
final long firstLineNumber)
{
return transformEntry(original);
}
/**
* {@inheritDoc}
*/
@Override()
@Nullable()
public Entry translateEntryToWrite(@NotNull final Entry original)
{
return transformEntry(original);
}
}
