com.unboundid.ldap.sdk.ReadOnlyEntry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2008-2022 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2022 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) 2008-2022 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;
import java.util.Collection;
import com.unboundid.ldap.sdk.schema.Schema;
import com.unboundid.ldif.LDIFException;
import com.unboundid.util.NotExtensible;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class defines an {@link Entry} subclass in which the contents of the
* entry cannot be modified. Any attempt to call a method which could be used
* to alter the contents of the entry will result in an
* {@link UnsupportedOperationException}.
*/
@NotExtensible()
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public class ReadOnlyEntry
extends Entry
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -6482574870325012756L;
/**
* Creates a new read-only entry with the provided DN and set of attributes.
*
* @param dn The DN for this entry. It must not be {@code null}.
* @param attributes The set of attributes for this entry. It must not be
* {@code null}.
*/
public ReadOnlyEntry(@NotNull final String dn,
@NotNull final Attribute... attributes)
{
this(dn, null, attributes);
}
/**
* Creates a new read-only entry with the provided DN and set of attributes.
*
* @param dn The DN for this entry. It must not be {@code null}.
* @param schema The schema to use for operations involving this entry.
* It may be {@code null} if no schema is available.
* @param attributes The set of attributes for this entry. It must not be
* {@code null}.
*/
public ReadOnlyEntry(@NotNull final String dn, @Nullable final Schema schema,
@NotNull final Attribute... attributes)
{
super(dn, schema, attributes);
}
/**
* Creates a new read-only entry with the provided DN and set of attributes.
*
* @param dn The DN for this entry. It must not be {@code null}.
* @param attributes The set of attributes for this entry. It must not be
* {@code null}.
*/
public ReadOnlyEntry(@NotNull final DN dn,
@NotNull final Attribute... attributes)
{
this(dn, null, attributes);
}
/**
* Creates a new read-only entry with the provided DN and set of attributes.
*
* @param dn The DN for this entry. It must not be {@code null}.
* @param schema The schema to use for operations involving this entry.
* It may be {@code null} if no schema is available.
* @param attributes The set of attributes for this entry. It must not be
* {@code null}.
*/
public ReadOnlyEntry(@NotNull final DN dn, @Nullable final Schema schema,
@NotNull final Attribute... attributes)
{
super(dn, schema, attributes);
}
/**
* Creates a new read-only entry with the provided DN and set of attributes.
*
* @param dn The DN for this entry. It must not be {@code null}.
* @param attributes The set of attributes for this entry. It must not be
* {@code null}.
*/
public ReadOnlyEntry(@NotNull final String dn,
@NotNull final Collection attributes)
{
this(dn, null, attributes);
}
/**
* Creates a new read-only entry with the provided DN and set of attributes.
*
* @param dn The DN for this entry. It must not be {@code null}.
* @param schema The schema to use for operations involving this entry.
* It may be {@code null} if no schema is available.
* @param attributes The set of attributes for this entry. It must not be
* {@code null}.
*/
public ReadOnlyEntry(@NotNull final String dn, @Nullable final Schema schema,
@NotNull final Collection attributes)
{
super(dn, schema, attributes);
}
/**
* Creates a new read-only entry with the provided DN and set of attributes.
*
* @param dn The DN for this entry. It must not be {@code null}.
* @param attributes The set of attributes for this entry. It must not be
* {@code null}.
*/
public ReadOnlyEntry(@NotNull final DN dn,
@NotNull final Collection attributes)
{
this(dn, null, attributes);
}
/**
* Creates a new read-only entry with the provided DN and set of attributes.
*
* @param dn The DN for this entry. It must not be {@code null}.
* @param schema The schema to use for operations involving this entry.
* It may be {@code null} if no schema is available.
* @param attributes The set of attributes for this entry. It must not be
* {@code null}.
*/
public ReadOnlyEntry(@NotNull final DN dn, @Nullable final Schema schema,
@NotNull final Collection attributes)
{
super(dn, schema, attributes);
}
/**
* Creates a new read-only entry from the provided {@link Entry}.
*
* @param entry The entry to use to create this read-only entry.
*/
public ReadOnlyEntry(@NotNull final Entry entry)
{
super(entry);
}
/**
* Creates a new read-only entry from the provided LDIF representation.
*
* @param ldifLines The set of lines that comprise an LDIF representation
* of the entry. It must not be {@code null} or empty.
*
* @throws LDIFException If the provided lines cannot be decoded as an entry
* in LDIF format.
*/
public ReadOnlyEntry(@NotNull final String... ldifLines)
throws LDIFException
{
this(null, ldifLines);
}
/**
* Creates a new read-only entry from the provided LDIF representation.
*
* @param schema The schema to use for operations involving this entry.
* It may be {@code null} if no schema is available.
* @param ldifLines The set of lines that comprise an LDIF representation
* of the entry. It must not be {@code null} or empty.
*
* @throws LDIFException If the provided lines cannot be decoded as an entry
* in LDIF format.
*/
public ReadOnlyEntry(@Nullable final Schema schema,
@NotNull final String... ldifLines)
throws LDIFException
{
super(schema, ldifLines);
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param dn The DN for this entry. It must not be {@code null}.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public void setDN(@NotNull final String dn)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param dn The DN for this entry. It must not be {@code null}.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public void setDN(@NotNull final DN dn)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attribute The attribute to be added. It must not be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean addAttribute(@NotNull final Attribute attribute)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name for the attribute to be added. It must
* not be {@code null}.
* @param attributeValue The value for the attribute to be added. It must
* not be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean addAttribute(@NotNull final String attributeName,
@NotNull final String attributeValue)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name for the attribute to be added. It must
* not be {@code null}.
* @param attributeValue The value for the attribute to be added. It must
* not be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean addAttribute(@NotNull final String attributeName,
@NotNull final byte[] attributeValue)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name for the attribute to be added. It must
* not be {@code null}.
* @param attributeValues The set of values for the attribute to be added.
* It must not be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean addAttribute(@NotNull final String attributeName,
@NotNull final String... attributeValues)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name for the attribute to be added. It must
* not be {@code null}.
* @param attributeValues The set of values for the attribute to be added.
* It must not be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean addAttribute(@NotNull final String attributeName,
@NotNull final byte[]... attributeValues)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name of the attribute to remove. It must not be
* {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean removeAttribute(@NotNull final String attributeName)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name of the attribute to remove. It must not
* be {@code null}.
* @param attributeValue The value of the attribute to remove. It must not
* be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean removeAttributeValue(@NotNull final String attributeName,
@NotNull final String attributeValue)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name of the attribute to remove. It must not
* be {@code null}.
* @param attributeValue The value of the attribute to remove. It must not
* be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean removeAttributeValue(@NotNull final String attributeName,
@NotNull final byte[] attributeValue)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name of the attribute to remove. It must not
* be {@code null}.
* @param attributeValues The values of the attribute to remove. It must
* not be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean removeAttributeValues(@NotNull final String attributeName,
@NotNull final String... attributeValues)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name of the attribute to remove. It must not
* be {@code null}.
* @param attributeValues The values of the attribute to remove. It must
* not be {@code null}.
*
* @return This method will never return successfully.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public boolean removeAttributeValues(@NotNull final String attributeName,
@NotNull final byte[]... attributeValues)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attribute The attribute to be included in this entry. It must not
* be {@code null}.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public void setAttribute(@NotNull final Attribute attribute)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name to use for the attribute. It must not be
* {@code null}.
* @param attributeValue The value to use for the attribute. It must not be
* {@code null}.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public void setAttribute(@NotNull final String attributeName,
@NotNull final String attributeValue)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name to use for the attribute. It must not be
* {@code null}.
* @param attributeValue The value to use for the attribute. It must not be
* {@code null}.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public void setAttribute(@NotNull final String attributeName,
@NotNull final byte[] attributeValue)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name to use for the attribute. It must not be
* {@code null}.
* @param attributeValues The set of values to use for the attribute. It
* must not be {@code null}.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public void setAttribute(@NotNull final String attributeName,
@NotNull final String... attributeValues)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
/**
* Throws an {@code UnsupportedOperationException} to indicate that this is a
* read-only entry.
*
* @param attributeName The name to use for the attribute. It must not be
* {@code null}.
* @param attributeValues The set of values to use for the attribute. It
* must not be {@code null}.
*
* @throws UnsupportedOperationException To indicate that this is a
* read-only entry.
*/
@Override()
public void setAttribute(@NotNull final String attributeName,
@NotNull final byte[]... attributeValues)
throws UnsupportedOperationException
{
throw new UnsupportedOperationException();
}
}