001/*
002 * Copyright 2022-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022-2024 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-2024 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.ConnectAccessLogMessage;
043import com.unboundid.util.NotMutable;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048import com.unboundid.util.json.JSONObject;
049
050
051
052/**
053 * This class provides a data structure that holds information about a
054 * JSON-formatted connect access log message.
055 * <BR>
056 * <BLOCKQUOTE>
057 *   <B>NOTE:</B>  This class, and other classes within the
058 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
059 *   supported for use against Ping Identity, UnboundID, and
060 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
061 *   for proprietary functionality or for external specifications that are not
062 *   considered stable or mature enough to be guaranteed to work in an
063 *   interoperable way with other types of LDAP servers.
064 * </BLOCKQUOTE>
065 */
066@NotMutable()
067@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
068public final class JSONConnectAccessLogMessage
069       extends JSONAccessLogMessage
070       implements ConnectAccessLogMessage
071{
072  /**
073   * The serial version UID for this serializable class.
074   */
075  private static final long serialVersionUID = 2405380746589337636L;
076
077
078
079  // The source port for this log message.
080  @Nullable private final Integer sourcePort;
081
082  // The target port for this log message.
083  @Nullable private final Integer targetPort;
084
085  // The client connection policy name for this log message.
086  @Nullable private final String clientConnectionPolicyName;
087
088  // The protocol name for this log message.
089  @Nullable private final String protocolName;
090
091  // The source address for this log message.
092  @Nullable private final String sourceAddress;
093
094  // The target address for this log message.
095  @Nullable private final String targetAddress;
096
097
098
099  /**
100   * Creates a new JSON connect access log message from the provided JSON
101   * object.
102   *
103   * @param  jsonObject  The JSON object that contains an encoded representation
104   *                     of this log message.  It must not be {@code null}.
105   *
106   * @throws  LogException  If the provided JSON object cannot be parsed as a
107   *                        valid log message.
108   */
109  public JSONConnectAccessLogMessage(@NotNull final JSONObject jsonObject)
110         throws LogException
111  {
112    super(jsonObject);
113
114    sourceAddress =
115         getString(JSONFormattedAccessLogFields.CONNECT_FROM_ADDRESS);
116    sourcePort =
117         getIntegerNoThrow(JSONFormattedAccessLogFields.CONNECT_FROM_PORT);
118    targetAddress =
119         getString(JSONFormattedAccessLogFields.CONNECT_TO_ADDRESS);
120    targetPort =
121         getIntegerNoThrow(JSONFormattedAccessLogFields.CONNECT_TO_PORT);
122    protocolName = getString(JSONFormattedAccessLogFields.PROTOCOL);
123    clientConnectionPolicyName =
124         getString(JSONFormattedAccessLogFields.CLIENT_CONNECTION_POLICY);
125  }
126
127
128
129  /**
130   * {@inheritDoc}
131   */
132  @Override()
133  @NotNull()
134  public AccessLogMessageType getMessageType()
135  {
136    return AccessLogMessageType.CONNECT;
137  }
138
139
140
141  /**
142   * {@inheritDoc}
143   */
144  @Override()
145  @Nullable()
146  public String getSourceAddress()
147  {
148    return sourceAddress;
149  }
150
151
152
153  /**
154   * {@inheritDoc}
155   */
156  @Override()
157  @Nullable()
158  public Integer getSourcePort()
159  {
160    return sourcePort;
161  }
162
163
164
165  /**
166   * {@inheritDoc}
167   */
168  @Override()
169  @Nullable()
170  public String getTargetAddress()
171  {
172    return targetAddress;
173  }
174
175
176
177  /**
178   * {@inheritDoc}
179   */
180  @Override()
181  @Nullable()
182  public Integer getTargetPort()
183  {
184    return targetPort;
185  }
186
187
188
189  /**
190   * {@inheritDoc}
191   */
192  @Override()
193  @Nullable()
194  public String getProtocolName()
195  {
196    return protocolName;
197  }
198
199
200
201  /**
202   * {@inheritDoc}
203   */
204  @Override()
205  @Nullable()
206  public String getClientConnectionPolicy()
207  {
208    return clientConnectionPolicyName;
209  }
210}