001/*
002 * Copyright 2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022 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) 2022 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.unboundidds.logs.v2.json;
037
038
039
040import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
041import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
042import com.unboundid.ldap.sdk.unboundidds.logs.v2.
043            CompareForwardAccessLogMessage;
044import com.unboundid.util.NotExtensible;
045import com.unboundid.util.NotMutable;
046import com.unboundid.util.NotNull;
047import com.unboundid.util.Nullable;
048import com.unboundid.util.ThreadSafety;
049import com.unboundid.util.ThreadSafetyLevel;
050import com.unboundid.util.json.JSONObject;
051
052
053
054/**
055 * This class provides a data structure that holds information about a
056 * JSON-formatted compare forward access log message.
057 * <BR>
058 * <BLOCKQUOTE>
059 *   <B>NOTE:</B>  This class, and other classes within the
060 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
061 *   supported for use against Ping Identity, UnboundID, and
062 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
063 *   for proprietary functionality or for external specifications that are not
064 *   considered stable or mature enough to be guaranteed to work in an
065 *   interoperable way with other types of LDAP servers.
066 * </BLOCKQUOTE>
067 */
068@NotExtensible()
069@NotMutable()
070@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
071public class JSONCompareForwardAccessLogMessage
072       extends JSONCompareRequestAccessLogMessage
073       implements CompareForwardAccessLogMessage
074{
075  /**
076   * The serial version UID for this serializable class.
077   */
078  private static final long serialVersionUID = -3714314814567308804L;
079
080
081
082  // The forward helper for this log message.
083  @NotNull private final JSONForwardAccessLogMessageHelper forwardHelper;
084
085
086
087  /**
088   * Creates a new JSON compare forward access log message from the provided
089   * JSON object.
090   *
091   * @param  jsonObject  The JSON object that contains an encoded representation
092   *                     of this log message.  It must not be {@code null}.
093   *
094   * @throws  LogException  If the provided JSON object cannot be parsed as a
095   *                        valid log message.
096   */
097  public JSONCompareForwardAccessLogMessage(
098              @NotNull final JSONObject jsonObject)
099         throws LogException
100  {
101    super(jsonObject);
102
103    forwardHelper = new JSONForwardAccessLogMessageHelper(this);
104  }
105
106
107
108  /**
109   * {@inheritDoc}
110   */
111  @Override()
112  @NotNull()
113  public AccessLogMessageType getMessageType()
114  {
115    return AccessLogMessageType.FORWARD;
116  }
117
118
119
120  /**
121   * {@inheritDoc}
122   */
123  @Override()
124  @Nullable()
125  public final String getTargetHost()
126  {
127    return forwardHelper.getTargetHost();
128  }
129
130
131
132  /**
133   * {@inheritDoc}
134   */
135  @Override()
136  @Nullable()
137  public final Integer getTargetPort()
138  {
139    return forwardHelper.getTargetPort();
140  }
141
142
143
144  /**
145   * {@inheritDoc}
146   */
147  @Override()
148  @Nullable()
149  public final String getTargetProtocol()
150  {
151    return forwardHelper.getTargetProtocol();
152  }
153}