001/*
002 * Copyright 2016-2021 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2016-2021 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2016-2021 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.experimental;
037
038
039
040import com.unboundid.ldap.sdk.Entry;
041import com.unboundid.ldap.sdk.LDAPException;
042import com.unboundid.ldap.sdk.OperationType;
043import com.unboundid.ldap.sdk.ResultCode;
044import com.unboundid.util.Debug;
045import com.unboundid.util.NotMutable;
046import com.unboundid.util.NotNull;
047import com.unboundid.util.ThreadSafety;
048import com.unboundid.util.ThreadSafetyLevel;
049
050import static com.unboundid.ldap.sdk.experimental.ExperimentalMessages.*;
051
052
053
054/**
055 * This class represents an entry that holds information about an abandon
056 * operation processed by an LDAP server, as per the specification described in
057 * draft-chu-ldap-logschema-00.
058 */
059@NotMutable()
060@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
061public final class DraftChuLDAPLogSchema00AbandonEntry
062       extends DraftChuLDAPLogSchema00Entry
063{
064  /**
065   * The name of the attribute used to hold the message ID of the operation to
066   * abandon.
067   */
068  @NotNull public static final String ATTR_ID_TO_ABANDON = "reqId";
069
070
071
072  /**
073   * The serial version UID for this serializable class.
074   */
075  private static final long serialVersionUID = -5205545654036097510L;
076
077
078
079  // The message ID of the operation to abandon.
080  private final int idToAbandon;
081
082
083
084  /**
085   * Creates a new instance of this abandon access log entry from the provided
086   * entry.
087   *
088   * @param  entry  The entry used to create this abandon access log entry.
089   *
090   * @throws  LDAPException  If the provided entry cannot be decoded as a valid
091   *                         abandon access log entry as per the specification
092   *                         contained in draft-chu-ldap-logschema-00.
093   */
094  public DraftChuLDAPLogSchema00AbandonEntry(@NotNull final Entry entry)
095         throws LDAPException
096  {
097    super(entry, OperationType.ABANDON);
098
099    final String idString = entry.getAttributeValue(ATTR_ID_TO_ABANDON);
100    if (idString == null)
101    {
102      throw new LDAPException(ResultCode.DECODING_ERROR,
103           ERR_LOGSCHEMA_DECODE_MISSING_REQUIRED_ATTR.get(entry.getDN(),
104                ATTR_ID_TO_ABANDON));
105    }
106    else
107    {
108      try
109      {
110        idToAbandon = Integer.parseInt(idString);
111      }
112      catch (final Exception e)
113      {
114        Debug.debugException(e);
115        throw new LDAPException(ResultCode.DECODING_ERROR,
116             ERR_LOGSCHEMA_DECODE_ABANDON_ID_ERROR.get(entry.getDN(),
117                  ATTR_ID_TO_ABANDON, idString),
118             e);
119      }
120    }
121  }
122
123
124
125  /**
126   * Retrieves the target message ID (i.e., the message ID of the operation to
127   * abandon) for the abandon request described by this abandon access log
128   * entry.
129   *
130   * @return  The target message ID for the abandon request described by this
131   *          abandon access log entry.
132   */
133  public int getIDToAbandon()
134  {
135    return idToAbandon;
136  }
137}