com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONAccessLogMessage 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

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.

There is a newer version: 7.0.1

Show newest version

/*
 * Copyright 2022-2023 Ping Identity Corporation
 * All Rights Reserved.
 */
/*
 * Copyright 2022-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) 2022-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.logs.v2.json;



import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
import com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage;
import com.unboundid.util.NotExtensible;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.json.JSONObject;



/**
 * This class provides a data structure that holds information about a
 * JSON-formatted access log message.
 * 

 * 
 *   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.
 * 
 */
@NotExtensible()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
public abstract class JSONAccessLogMessage
       extends JSONLogMessage
       implements AccessLogMessage
{
  /**
   * The serial version UID for this serializable class.
   */
  private static final long serialVersionUID = 8694184933366259453L;



  // The connection ID value from the log message.
  @Nullable private final Long connectionID;

  // The thread ID value from the log message.
  @Nullable private final Long threadID;

  // The instance name value from the log message.
  @Nullable private final String instanceName;

  // The product name value from the log message.
  @Nullable private final String productName;

  // The startup ID value from the log message.
  @Nullable private final String startupID;



  /**
   * Creates a new JSON access log message from the provided JSON object.
   *
   * @param  jsonObject  The JSON object that contains an encoded representation
   *                     of this log message.  It must not be {@code null}.
   *
   * @throws  LogException  If the provided JSON object cannot be parsed as a
   *                        valid log message.
   */
  protected JSONAccessLogMessage(@NotNull final JSONObject jsonObject)
            throws LogException
  {
    super(jsonObject);

    instanceName = getString(JSONFormattedAccessLogFields.INSTANCE_NAME);
    productName = getString(JSONFormattedAccessLogFields.PRODUCT_NAME);
    startupID = getString(JSONFormattedAccessLogFields.STARTUP_ID);
    threadID = getLongNoThrow(JSONFormattedAccessLogFields.THREAD_ID);
    connectionID =
         getLongNoThrow(JSONFormattedAccessLogFields.CONNECTION_ID);
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public final String getProductName()
  {
    return productName;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public final String getInstanceName()
  {
    return instanceName;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public final String getStartupID()
  {
    return startupID;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public final Long getThreadID()
  {
    return threadID;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable
  public final Long getConnectionID()
  {
    return connectionID;
  }
}