com.unboundid.ldap.sdk.unboundidds.extensions.NotificationDestinationDetails 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 2014-2023 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2014-2023 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) 2014-2023 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.unboundidds.extensions;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import com.unboundid.asn1.ASN1OctetString;
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;
import com.unboundid.util.Validator;
/**
* This class represents a data structure with information about a notification
* destination defined in a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent
* 8661 server instance.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class NotificationDestinationDetails
implements Serializable
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -6596207374277234834L;
// The encoded details for this notification destination.
@NotNull private final List details;
// The subscriptions defined for this notification destination.
@NotNull private final List subscriptions;
// The unique ID for this notification destination.
@NotNull private final String id;
/**
* Creates a new notification destination details object with the provided
* information.
*
* @param id The unique ID for this notification destination. It
* must not be {@code null}.
* @param details The encoded details for this notification
* destination. It must not be {@code null} or empty.
* @param subscriptions The subscriptions defined for this notification
* destination. It may be {@code null} or empty if
* there are no subscriptions for this destination.
*/
public NotificationDestinationDetails(@NotNull final String id,
@NotNull final Collection details,
@Nullable final Collection
subscriptions)
{
Validator.ensureNotNull(id);
Validator.ensureNotNull(details);
Validator.ensureFalse(details.isEmpty());
this.id = id;
this.details =
Collections.unmodifiableList(new ArrayList<>(details));
if (subscriptions == null)
{
this.subscriptions = Collections.emptyList();
}
else
{
this.subscriptions =
Collections.unmodifiableList(new ArrayList<>(subscriptions));
}
}
/**
* Retrieves the unique ID for this destination details object.
*
* @return The unique ID for this destination details object.
*/
@NotNull()
public String getID()
{
return id;
}
/**
* Retrieves the encoded details for this destination details object.
*
* @return The encoded details for this destination details object.
*/
@NotNull()
public List getDetails()
{
return details;
}
/**
* Retrieves the subscriptions defined for this notification destination, if
* any.
*
* @return The subscriptions defined for this notification destination, or
* an empty list if there are no subscriptions for this destination.
*/
@NotNull()
public List getSubscriptions()
{
return subscriptions;
}
/**
* Retrieves a string representation of this notification subscription details
* object.
*
* @return A string representation of this notification subscription details
* object.
*/
@Override()
@NotNull()
public String toString()
{
final StringBuilder buffer = new StringBuilder();
toString(buffer);
return buffer.toString();
}
/**
* Appends a string representation of this notification subscription details
* object to the provided buffer.
*
* @param buffer The buffer to which the information should be appended.
*/
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("NotificationDestination(id='");
buffer.append(id);
buffer.append("', subscriptionIDs={");
final Iterator subscriptionIterator =
subscriptions.iterator();
while (subscriptionIterator.hasNext())
{
buffer.append('\'');
buffer.append(subscriptionIterator.next().getID());
buffer.append('\'');
if (subscriptionIterator.hasNext())
{
buffer.append(", ");
}
}
buffer.append("})");
}
}