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