001/*
002 * Copyright 2022-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022-2023 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-2023 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.text;
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            ExtendedForwardAccessLogMessage;
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;
050
051
052
053/**
054 * This class provides a data structure that holds information about a
055 * text-formatted extended 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 TextFormattedExtendedForwardAccessLogMessage
071       extends TextFormattedExtendedRequestAccessLogMessage
072       implements ExtendedForwardAccessLogMessage
073{
074  /**
075   * The serial version UID for this serializable class.
076   */
077  private static final long serialVersionUID = -3551286281578035269L;
078
079
080
081  // The forward helper for this log message.
082  @NotNull private final TextFormattedForwardAccessLogMessageHelper
083       forwardHelper;
084
085
086
087  /**
088   * Creates a new text-formatted extended forward access log message from the
089   * provided message string.
090   *
091   * @param  logMessageString  The string representation of this log message.
092   *                           It must not be {@code null}.
093   *
094   * @throws  LogException  If the provided string cannot be parsed as a valid
095   *                        log message.
096   */
097  public TextFormattedExtendedForwardAccessLogMessage(
098              @NotNull final String logMessageString)
099         throws LogException
100  {
101    this(new TextFormattedLogMessage(logMessageString));
102  }
103
104
105
106  /**
107   * Creates a new text-formatted extended forward access log message from the
108   * provided message.
109   *
110   * @param  logMessage  The log message to use to create this extended forward
111   *                     access log
112   *                     message.  It must not be {@code null}.
113   */
114  TextFormattedExtendedForwardAccessLogMessage(
115       @NotNull final TextFormattedLogMessage logMessage)
116  {
117    super(logMessage);
118
119    forwardHelper = new TextFormattedForwardAccessLogMessageHelper(this);
120  }
121
122
123
124  /**
125   * {@inheritDoc}
126   */
127  @Override()
128  @NotNull()
129  public AccessLogMessageType getMessageType()
130  {
131    return AccessLogMessageType.FORWARD;
132  }
133
134
135
136  /**
137   * {@inheritDoc}
138   */
139  @Override()
140  @Nullable()
141  public final String getTargetHost()
142  {
143    return forwardHelper.getTargetHost();
144  }
145
146
147
148  /**
149   * {@inheritDoc}
150   */
151  @Override()
152  @Nullable()
153  public final Integer getTargetPort()
154  {
155    return forwardHelper.getTargetPort();
156  }
157
158
159
160  /**
161   * {@inheritDoc}
162   */
163  @Override()
164  @Nullable()
165  public final String getTargetProtocol()
166  {
167    return forwardHelper.getTargetProtocol();
168  }
169}