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