001/*
002 * Copyright 2016-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2016-2020 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-2020 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.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049import static com.unboundid.ldap.sdk.experimental.ExperimentalMessages.*;
050
051
052
053/**
054 * This class represents an entry that holds information about an abandon
055 * operation processed by an LDAP server, as per the specification described in
056 * draft-chu-ldap-logschema-00.
057 */
058@NotMutable()
059@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
060public final class DraftChuLDAPLogSchema00AbandonEntry
061       extends DraftChuLDAPLogSchema00Entry
062{
063  /**
064   * The name of the attribute used to hold the message ID of the operation to
065   * abandon.
066   */
067  public static final String ATTR_ID_TO_ABANDON = "reqId";
068
069
070
071  /**
072   * The serial version UID for this serializable class.
073   */
074  private static final long serialVersionUID = -5205545654036097510L;
075
076
077
078  // The message ID of the operation to abandon.
079  private final int idToAbandon;
080
081
082
083  /**
084   * Creates a new instance of this abandon access log entry from the provided
085   * entry.
086   *
087   * @param  entry  The entry used to create this abandon access log entry.
088   *
089   * @throws  LDAPException  If the provided entry cannot be decoded as a valid
090   *                         abandon access log entry as per the specification
091   *                         contained in draft-chu-ldap-logschema-00.
092   */
093  public DraftChuLDAPLogSchema00AbandonEntry(final Entry entry)
094         throws LDAPException
095  {
096    super(entry, OperationType.ABANDON);
097
098    final String idString = entry.getAttributeValue(ATTR_ID_TO_ABANDON);
099    if (idString == null)
100    {
101      throw new LDAPException(ResultCode.DECODING_ERROR,
102           ERR_LOGSCHEMA_DECODE_MISSING_REQUIRED_ATTR.get(entry.getDN(),
103                ATTR_ID_TO_ABANDON));
104    }
105    else
106    {
107      try
108      {
109        idToAbandon = Integer.parseInt(idString);
110      }
111      catch (final Exception e)
112      {
113        Debug.debugException(e);
114        throw new LDAPException(ResultCode.DECODING_ERROR,
115             ERR_LOGSCHEMA_DECODE_ABANDON_ID_ERROR.get(entry.getDN(),
116                  ATTR_ID_TO_ABANDON, idString),
117             e);
118      }
119    }
120  }
121
122
123
124  /**
125   * Retrieves the target message ID (i.e., the message ID of the operation to
126   * abandon) for the abandon request described by this abandon access log
127   * entry.
128   *
129   * @return  The target message ID for the abandon request described by this
130   *          abandon access log entry.
131   */
132  public int getIDToAbandon()
133  {
134    return idToAbandon;
135  }
136}