com.unboundid.ldap.protocol.ModifyRequestProtocolOp Maven / Gradle / Ivy
/*
* Copyright 2009-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2009-2021 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) 2009-2021 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.protocol;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import com.unboundid.asn1.ASN1Buffer;
import com.unboundid.asn1.ASN1BufferSequence;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.asn1.ASN1StreamReader;
import com.unboundid.asn1.ASN1StreamReaderSequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.Modification;
import com.unboundid.ldap.sdk.ModifyRequest;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.Debug;
import com.unboundid.util.InternalUseOnly;
import com.unboundid.util.NotMutable;
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;
import com.unboundid.util.Validator;
import static com.unboundid.ldap.protocol.ProtocolMessages.*;
/**
* This class provides an implementation of an LDAP modify request protocol op.
*/
@InternalUseOnly()
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class ModifyRequestProtocolOp
implements ProtocolOp
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -6294739625253826184L;
// The list of modifications for this modify request.
@NotNull private final List modifications;
// The entry DN for this modify request.
@NotNull private final String dn;
/**
* Creates a new modify request protocol op with the provided information.
*
* @param dn The entry DN for this modify request.
* @param modifications The list of modifications to include in this modify
* request.
*/
public ModifyRequestProtocolOp(@NotNull final String dn,
@NotNull final List modifications)
{
this.dn = dn;
this.modifications = Collections.unmodifiableList(modifications);
}
/**
* Creates a new modify request protocol op from the provided modify request
* object.
*
* @param request The modify request object to use to create this protocol
* op.
*/
public ModifyRequestProtocolOp(@NotNull final ModifyRequest request)
{
dn = request.getDN();
modifications = request.getModifications();
}
/**
* Creates a new modify request protocol op read from the provided ASN.1
* stream reader.
*
* @param reader The ASN.1 stream reader from which to read the modify
* request protocol op.
*
* @throws LDAPException If a problem occurs while reading or parsing the
* modify request.
*/
ModifyRequestProtocolOp(@NotNull final ASN1StreamReader reader)
throws LDAPException
{
try
{
reader.beginSequence();
dn = reader.readString();
Validator.ensureNotNull(dn);
final ArrayList mods = new ArrayList<>(5);
final ASN1StreamReaderSequence modSequence = reader.beginSequence();
while (modSequence.hasMoreElements())
{
mods.add(Modification.readFrom(reader));
}
modifications = Collections.unmodifiableList(mods);
}
catch (final LDAPException le)
{
Debug.debugException(le);
throw le;
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_MODIFY_REQUEST_CANNOT_DECODE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* Retrieves the target entry DN for this modify request.
*
* @return The target entry DN for this modify request.
*/
@NotNull()
public String getDN()
{
return dn;
}
/**
* Retrieves the list of modifications for this modify request.
*
* @return The list of modifications for this modify request.
*/
@NotNull()
public List getModifications()
{
return modifications;
}
/**
* {@inheritDoc}
*/
@Override()
public byte getProtocolOpType()
{
return LDAPMessage.PROTOCOL_OP_TYPE_MODIFY_REQUEST;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public ASN1Element encodeProtocolOp()
{
final ArrayList modElements =
new ArrayList<>(modifications.size());
for (final Modification m : modifications)
{
modElements.add(m.encode());
}
return new ASN1Sequence(LDAPMessage.PROTOCOL_OP_TYPE_MODIFY_REQUEST,
new ASN1OctetString(dn),
new ASN1Sequence(modElements));
}
/**
* Decodes the provided ASN.1 element as a modify request protocol op.
*
* @param element The ASN.1 element to be decoded.
*
* @return The decoded modify request protocol op.
*
* @throws LDAPException If the provided ASN.1 element cannot be decoded as
* a modify request protocol op.
*/
@NotNull()
public static ModifyRequestProtocolOp decodeProtocolOp(
@NotNull final ASN1Element element)
throws LDAPException
{
try
{
final ASN1Element[] elements =
ASN1Sequence.decodeAsSequence(element).elements();
final String dn =
ASN1OctetString.decodeAsOctetString(elements[0]).stringValue();
final ASN1Element[] modElements =
ASN1Sequence.decodeAsSequence(elements[1]).elements();
final ArrayList mods = new ArrayList<>(modElements.length);
for (final ASN1Element e : modElements)
{
mods.add(Modification.decode(ASN1Sequence.decodeAsSequence(e)));
}
return new ModifyRequestProtocolOp(dn, mods);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_MODIFY_REQUEST_CANNOT_DECODE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* {@inheritDoc}
*/
@Override()
public void writeTo(@NotNull final ASN1Buffer writer)
{
final ASN1BufferSequence opSequence =
writer.beginSequence(LDAPMessage.PROTOCOL_OP_TYPE_MODIFY_REQUEST);
writer.addOctetString(dn);
final ASN1BufferSequence modSequence = writer.beginSequence();
for (final Modification m : modifications)
{
m.writeTo(writer);
}
modSequence.end();
opSequence.end();
}
/**
* Creates a modify request from this protocol op.
*
* @param controls The set of controls to include in the modify request.
* It may be empty or {@code null} if no controls should be
* included.
*
* @return The modify request that was created.
*/
@NotNull()
public ModifyRequest toModifyRequest(@Nullable final Control... controls)
{
return new ModifyRequest(dn, modifications, controls);
}
/**
* Retrieves a string representation of this protocol op.
*
* @return A string representation of this protocol op.
*/
@Override()
@NotNull()
public String toString()
{
final StringBuilder buffer = new StringBuilder();
toString(buffer);
return buffer.toString();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("ModifyRequestProtocolOp(dn='");
buffer.append(dn);
buffer.append("', mods={");
final Iterator iterator = modifications.iterator();
while (iterator.hasNext())
{
iterator.next().toString(buffer);
if (iterator.hasNext())
{
buffer.append(',');
}
}
buffer.append("})");
}
}