001/* 002 * Copyright 2009-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2009-2020 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) 2015-2020 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; 037 038 039 040import com.unboundid.util.NotMutable; 041import com.unboundid.util.ThreadSafety; 042import com.unboundid.util.ThreadSafetyLevel; 043 044 045 046/** 047 * This class provides a data structure that holds information about a log 048 * message that may appear in the Directory Server access log about an add 049 * request forwarded to a backend server. 050 * <BR> 051 * <BLOCKQUOTE> 052 * <B>NOTE:</B> This class, and other classes within the 053 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 054 * supported for use against Ping Identity, UnboundID, and 055 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 056 * for proprietary functionality or for external specifications that are not 057 * considered stable or mature enough to be guaranteed to work in an 058 * interoperable way with other types of LDAP servers. 059 * </BLOCKQUOTE> 060 */ 061@NotMutable() 062@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 063public final class AddForwardAccessLogMessage 064 extends AddRequestAccessLogMessage 065{ 066 /** 067 * The serial version UID for this serializable class. 068 */ 069 private static final long serialVersionUID = 5311495513879603972L; 070 071 072 073 // The port of the backend server to which the request has been forwarded. 074 private final Integer targetPort; 075 076 // The address of the backend server to which the request has been forwarded. 077 private final String targetHost; 078 079 // The protocol used to forward the request to the backend server. 080 private final String targetProtocol; 081 082 083 084 /** 085 * Creates a new add forward access log message from the provided message 086 * string. 087 * 088 * @param s The string to be parsed as an add forward access log message. 089 * 090 * @throws LogException If the provided string cannot be parsed as a valid 091 * log message. 092 */ 093 public AddForwardAccessLogMessage(final String s) 094 throws LogException 095 { 096 this(new LogMessage(s)); 097 } 098 099 100 101 /** 102 * Creates a new add forward access log message from the provided log message. 103 * 104 * @param m The log message to be parsed as an add forward access log 105 * message. 106 */ 107 public AddForwardAccessLogMessage(final LogMessage m) 108 { 109 super(m); 110 111 targetHost = getNamedValue("targetHost"); 112 targetPort = getNamedValueAsInteger("targetPort"); 113 targetProtocol = getNamedValue("targetProtocol"); 114 } 115 116 117 118 /** 119 * Retrieves the address of the backend server to which the request has been 120 * forwarded. 121 * 122 * @return The address of the backend server to which the request has been 123 * forwarded, or {@code null} if it is not included in the log 124 * message. 125 */ 126 public String getTargetHost() 127 { 128 return targetHost; 129 } 130 131 132 133 /** 134 * Retrieves the port of the backend server to which the request has been 135 * forwarded. 136 * 137 * @return The port of the backend server to which the request has been 138 * forwarded, or {@code null} if it is not included in the log 139 * message. 140 */ 141 public Integer getTargetPort() 142 { 143 return targetPort; 144 } 145 146 147 148 /** 149 * Retrieves the protocol used to forward the request to the backend server. 150 * 151 * @return The protocol used to forward the request to the backend server, or 152 * {@code null} if it is not included in the log message. 153 */ 154 public String getTargetProtocol() 155 { 156 return targetProtocol; 157 } 158 159 160 161 /** 162 * {@inheritDoc} 163 */ 164 @Override() 165 public AccessLogMessageType getMessageType() 166 { 167 return AccessLogMessageType.FORWARD; 168 } 169}