log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java - logging-log4j2 - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements. See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache license, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
 package org.apache.logging.log4j.message;

 import java.util.Map;

 import org.apache.logging.log4j.util.EnglishEnums;

 /**
  * Represents a Message that conforms to an RFC 5424 StructuredData element along with the syslog message.
  *
  * @see <a href="https://tools.ietf.org/html/rfc5424">RFC 5424</a>
  */
 public class StructuredDataMessage extends MapMessage {

     private static final long serialVersionUID = 1703221292892071920L;
     private static final int MAX_LENGTH = 32;
     private static final int HASHVAL = 31;

     private StructuredDataId id;

     private String message;

     private String type;

     /**
      * Supported formats.
      */
     public enum Format {
         /** The map should be formatted as XML. */
         XML,
         /** Full message format includes the type and message. */
         FULL
     }

     /**
      * Constructor based on a String id.
      * @param id The String id.
      * @param msg The message.
      * @param type The message type.
      */
     public StructuredDataMessage(final String id, final String msg, final String type) {
         this.id = new StructuredDataId(id, null, null);
         this.message = msg;
         this.type = type;
     }
     /**
      * Constructor based on a String id.
      * @param id The String id.
      * @param msg The message.
      * @param type The message type.
      * @param data The StructuredData map.
      */
     public StructuredDataMessage(final String id, final String msg, final String type,
                                  final Map<String, String> data) {
         super(data);
         this.id = new StructuredDataId(id, null, null);
         this.message = msg;
         this.type = type;
     }

     /**
      * Constructor based on a StructuredDataId.
      * @param id The StructuredDataId.
      * @param msg The message.
      * @param type The message type.
      */
     public StructuredDataMessage(final StructuredDataId id, final String msg, final String type) {
         this.id = id;
         this.message = msg;
         this.type = type;
     }

     /**
      * Constructor based on a StructuredDataId.
      * @param id The StructuredDataId.
      * @param msg The message.
      * @param type The message type.
      * @param data The StructuredData map.
      */
     public StructuredDataMessage(final StructuredDataId id, final String msg, final String type,
                                  final Map<String, String> data) {
         super(data);
         this.id = id;
         this.message = msg;
         this.type = type;
     }


     /**
      * Constructor based on a StructuredDataMessage.
      * @param msg The StructuredDataMessage.
      * @param map The StructuredData map.
      */
     private StructuredDataMessage(final StructuredDataMessage msg, final Map<String, String> map) {
         super(map);
         this.id = msg.id;
         this.message = msg.message;
         this.type = msg.type;
     }


     /**
      * Basic constructor.
      */
     protected StructuredDataMessage() {

     }

     /**
      * Returns the supported formats.
      * @return An array of the supported format names.
      */
     @Override
     public String[] getFormats() {
         final String[] formats = new String[Format.values().length];
         int i = 0;
         for (final Format format : Format.values()) {
             formats[i++] = format.name();
         }
         return formats;
     }

     /**
      * Returns the id.
      * @return the StructuredDataId.
      */
     public StructuredDataId getId() {
         return id;
     }

     /**
      * Sets the id from a String.
      * @param id The String id.
      */
     protected void setId(final String id) {
         this.id = new StructuredDataId(id, null, null);
     }

     /**
      * Sets the id.
      * @param id The StructuredDataId.
      */
     protected void setId(final StructuredDataId id) {
         this.id = id;
     }

     /**
      * Sets the type.
      * @return the type.
      */
     public String getType() {
         return type;
     }

     protected void setType(final String type) {
         if (type.length() > MAX_LENGTH) {
             throw new IllegalArgumentException("structured data type exceeds maximum length of 32 characters: " + type);
         }
         this.type = type;
     }

     /**
      * Returns the message.
      * @return the message.
      */
     @Override
     public String getFormat() {
         return message;
     }

     protected void setMessageFormat(final String msg) {
         this.message = msg;
     }


     @Override
     protected void validate(final String key, final String value) {
         validateKey(key);
     }

     private void validateKey(final String key) {
         if (key.length() > MAX_LENGTH) {
             throw new IllegalArgumentException("Structured data keys are limited to 32 characters. key: " + key);
         }
         final char[] chars = key.toCharArray();
         for (final char c : chars) {
             if (c < '!' || c > '~' || c == '=' || c == ']' || c == '"') {
                 throw new IllegalArgumentException("Structured data keys must contain printable US ASCII characters" +
                         "and may not contain a space, =, ], or \"");
             }
         }
     }

     /**
      * Formats the structured data as described in RFC 5424.
      *
      * @return The formatted String.
      */
     @Override
     public String asString() {
         return asString(Format.FULL, null);
     }

     /**
      * Formats the structured data as described in RFC 5424.
      *
      * @param format The format identifier. Ignored in this implementation.
      * @return The formatted String.
      */

     @Override
     public String asString(final String format) {
         try {
             return asString(EnglishEnums.valueOf(Format.class, format), null);
         } catch (final IllegalArgumentException ex) {
             return asString();
         }
     }

     /**
      * Formats the structured data as described in RFC 5424.
      *
      * @param format           "full" will include the type and message. null will return only the STRUCTURED-DATA as
      *                         described in RFC 5424
      * @param structuredDataId The SD-ID as described in RFC 5424. If null the value in the StructuredData
      *                         will be used.
      * @return The formatted String.
      */
     public final String asString(final Format format, final StructuredDataId structuredDataId) {
         final StringBuilder sb = new StringBuilder();
         final boolean full = Format.FULL.equals(format);
         if (full) {
             final String type = getType();
             if (type == null) {
                 return sb.toString();
             }
             sb.append(getType()).append(" ");
         }
         StructuredDataId id = getId();
         if (id != null) {
             id = id.makeId(structuredDataId);
         } else {
             id = structuredDataId;
         }
         if (id == null || id.getName() == null) {
             return sb.toString();
         }
         sb.append("[");
         sb.append(id);
         sb.append(" ");
         appendMap(sb);
         sb.append("]");
         if (full) {
             final String msg = getFormat();
             if (msg != null) {
                 sb.append(" ").append(msg);
             }
         }
         return sb.toString();
     }

     /**
      * Formats the message and return it.
      * @return the formatted message.
      */
     @Override
     public String getFormattedMessage() {
         return asString(Format.FULL, null);
     }

     /**
      * Formats the message according the the specified format.
      * @param formats An array of Strings that provide extra information about how to format the message.
      * StructuredDataMessage accepts only a format of "FULL" which will cause the event type to be
      * prepended and the event message to be appended. Specifying any other value will cause only the
      * StructuredData to be included. The default is "FULL".
      *
      * @return the formatted message.
      */
     @Override
     public String getFormattedMessage(final String[] formats) {
         if (formats != null && formats.length > 0) {
             for (final String format : formats) {
                 if (Format.XML.name().equalsIgnoreCase(format)) {
                     return asXML();
                 } else if (Format.FULL.name().equalsIgnoreCase(format)) {
                     return asString(Format.FULL, null);
                 }
             }
             return asString(null, null);
         }
         return asString(Format.FULL, null);
     }

     private String asXML() {
         final StringBuilder sb = new StringBuilder();
         final StructuredDataId id = getId();
         if (id == null || id.getName() == null || type == null) {
             return sb.toString();
         }
         sb.append("<StructuredData>\n");
         sb.append("<type>").append(type).append("</type>\n");
         sb.append("<id>").append(id).append("</id>\n");
         super.asXML(sb);
         sb.append("</StructuredData>\n");
         return sb.toString();
     }

     @Override
     public String toString() {
         return asString(null, null);
     }


     @Override
     public MapMessage newInstance(final Map<String, String> map) {
         return new StructuredDataMessage(this, map);
     }

     @Override
     public boolean equals(final Object o) {
         if (this == o) {
             return true;
         }
         if (o == null || getClass() != o.getClass()) {
             return false;
         }

         final StructuredDataMessage that = (StructuredDataMessage) o;

         if (!super.equals(o)) {
             return false;
         }
         if (type != null ? !type.equals(that.type) : that.type != null) {
             return false;
         }
         if (id != null ? !id.equals(that.id) : that.id != null) {
             return false;
         }
         if (message != null ? !message.equals(that.message) : that.message != null) {
             return false;
         }

         return true;
     }

     @Override
     public int hashCode() {
         int result = super.hashCode();
         result = HASHVAL * result + (type != null ? type.hashCode() : 0);
         result = HASHVAL * result + (id != null ? id.hashCode() : 0);
         result = HASHVAL * result + (message != null ? message.hashCode() : 0);
         return result;
     }
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. See the NOTICE file distributed with
	* this work for additional information regarding copyright ownership.
	* The ASF licenses this file to You under the Apache license, Version 2.0
	* (the "License"); you may not use this file except in compliance with
	* the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the license for the specific language governing permissions and
	* limitations under the license.
	*/
	package org.apache.logging.log4j.message;

	import java.util.Map;

	import org.apache.logging.log4j.util.EnglishEnums;

	/**
	* Represents a Message that conforms to an RFC 5424 StructuredData element along with the syslog message.
	*
	* @see <a href="https://tools.ietf.org/html/rfc5424">RFC 5424</a>
	*/
	public class StructuredDataMessage extends MapMessage {

	private static final long serialVersionUID = 1703221292892071920L;
	private static final int MAX_LENGTH = 32;
	private static final int HASHVAL = 31;

	private StructuredDataId id;

	private String message;

	private String type;

	/**
	* Supported formats.
	*/
	public enum Format {
	/** The map should be formatted as XML. */
	XML,
	/** Full message format includes the type and message. */
	FULL
	}

	/**
	* Constructor based on a String id.
	* @param id The String id.
	* @param msg The message.
	* @param type The message type.
	*/
	public StructuredDataMessage(final String id, final String msg, final String type) {
	this.id = new StructuredDataId(id, null, null);
	this.message = msg;
	this.type = type;
	}
	/**
	* Constructor based on a String id.
	* @param id The String id.
	* @param msg The message.
	* @param type The message type.
	* @param data The StructuredData map.
	*/
	public StructuredDataMessage(final String id, final String msg, final String type,
	final Map<String, String> data) {
	super(data);
	this.id = new StructuredDataId(id, null, null);
	this.message = msg;
	this.type = type;
	}

	/**
	* Constructor based on a StructuredDataId.
	* @param id The StructuredDataId.
	* @param msg The message.
	* @param type The message type.
	*/
	public StructuredDataMessage(final StructuredDataId id, final String msg, final String type) {
	this.id = id;
	this.message = msg;
	this.type = type;
	}

	/**
	* Constructor based on a StructuredDataId.
	* @param id The StructuredDataId.
	* @param msg The message.
	* @param type The message type.
	* @param data The StructuredData map.
	*/
	public StructuredDataMessage(final StructuredDataId id, final String msg, final String type,
	final Map<String, String> data) {
	super(data);
	this.id = id;
	this.message = msg;
	this.type = type;
	}


	/**
	* Constructor based on a StructuredDataMessage.
	* @param msg The StructuredDataMessage.
	* @param map The StructuredData map.
	*/
	private StructuredDataMessage(final StructuredDataMessage msg, final Map<String, String> map) {
	super(map);
	this.id = msg.id;
	this.message = msg.message;
	this.type = msg.type;
	}


	/**
	* Basic constructor.
	*/
	protected StructuredDataMessage() {

	}

	/**
	* Returns the supported formats.
	* @return An array of the supported format names.
	*/
	@Override
	public String[] getFormats() {
	final String[] formats = new String[Format.values().length];
	int i = 0;
	for (final Format format : Format.values()) {
	formats[i++] = format.name();
	}
	return formats;
	}

	/**
	* Returns the id.
	* @return the StructuredDataId.
	*/
	public StructuredDataId getId() {
	return id;
	}

	/**
	* Sets the id from a String.
	* @param id The String id.
	*/
	protected void setId(final String id) {
	this.id = new StructuredDataId(id, null, null);
	}

	/**
	* Sets the id.
	* @param id The StructuredDataId.
	*/
	protected void setId(final StructuredDataId id) {
	this.id = id;
	}

	/**
	* Sets the type.
	* @return the type.
	*/
	public String getType() {
	return type;
	}

	protected void setType(final String type) {
	if (type.length() > MAX_LENGTH) {
	throw new IllegalArgumentException("structured data type exceeds maximum length of 32 characters: " + type);
	}
	this.type = type;
	}

	/**
	* Returns the message.
	* @return the message.
	*/
	@Override
	public String getFormat() {
	return message;
	}

	protected void setMessageFormat(final String msg) {
	this.message = msg;
	}


	@Override
	protected void validate(final String key, final String value) {
	validateKey(key);
	}

	private void validateKey(final String key) {
	if (key.length() > MAX_LENGTH) {
	throw new IllegalArgumentException("Structured data keys are limited to 32 characters. key: " + key);
	}
	final char[] chars = key.toCharArray();
	for (final char c : chars) {
	if (c < '!' \|\| c > '~' \|\| c == '=' \|\| c == ']' \|\| c == '"') {
	throw new IllegalArgumentException("Structured data keys must contain printable US ASCII characters" +
	"and may not contain a space, =, ], or \"");
	}
	}
	}

	/**
	* Formats the structured data as described in RFC 5424.
	*
	* @return The formatted String.
	*/
	@Override
	public String asString() {
	return asString(Format.FULL, null);
	}

	/**
	* Formats the structured data as described in RFC 5424.
	*
	* @param format The format identifier. Ignored in this implementation.
	* @return The formatted String.
	*/

	@Override
	public String asString(final String format) {
	try {
	return asString(EnglishEnums.valueOf(Format.class, format), null);
	} catch (final IllegalArgumentException ex) {
	return asString();
	}
	}

	/**
	* Formats the structured data as described in RFC 5424.
	*
	* @param format "full" will include the type and message. null will return only the STRUCTURED-DATA as
	* described in RFC 5424
	* @param structuredDataId The SD-ID as described in RFC 5424. If null the value in the StructuredData
	* will be used.
	* @return The formatted String.
	*/
	public final String asString(final Format format, final StructuredDataId structuredDataId) {
	final StringBuilder sb = new StringBuilder();
	final boolean full = Format.FULL.equals(format);
	if (full) {
	final String type = getType();
	if (type == null) {
	return sb.toString();
	}
	sb.append(getType()).append(" ");
	}
	StructuredDataId id = getId();
	if (id != null) {
	id = id.makeId(structuredDataId);
	} else {
	id = structuredDataId;
	}
	if (id == null \|\| id.getName() == null) {
	return sb.toString();
	}
	sb.append("[");
	sb.append(id);
	sb.append(" ");
	appendMap(sb);
	sb.append("]");
	if (full) {
	final String msg = getFormat();
	if (msg != null) {
	sb.append(" ").append(msg);
	}
	}
	return sb.toString();
	}

	/**
	* Formats the message and return it.
	* @return the formatted message.
	*/
	@Override
	public String getFormattedMessage() {
	return asString(Format.FULL, null);
	}

	/**
	* Formats the message according the the specified format.
	* @param formats An array of Strings that provide extra information about how to format the message.
	* StructuredDataMessage accepts only a format of "FULL" which will cause the event type to be
	* prepended and the event message to be appended. Specifying any other value will cause only the
	* StructuredData to be included. The default is "FULL".
	*
	* @return the formatted message.
	*/
	@Override
	public String getFormattedMessage(final String[] formats) {
	if (formats != null && formats.length > 0) {
	for (final String format : formats) {
	if (Format.XML.name().equalsIgnoreCase(format)) {
	return asXML();
	} else if (Format.FULL.name().equalsIgnoreCase(format)) {
	return asString(Format.FULL, null);
	}
	}
	return asString(null, null);
	}
	return asString(Format.FULL, null);
	}

	private String asXML() {
	final StringBuilder sb = new StringBuilder();
	final StructuredDataId id = getId();
	if (id == null \|\| id.getName() == null \|\| type == null) {
	return sb.toString();
	}
	sb.append("<StructuredData>\n");
	sb.append("<type>").append(type).append("</type>\n");
	sb.append("<id>").append(id).append("</id>\n");
	super.asXML(sb);
	sb.append("</StructuredData>\n");
	return sb.toString();
	}

	@Override
	public String toString() {
	return asString(null, null);
	}


	@Override
	public MapMessage newInstance(final Map<String, String> map) {
	return new StructuredDataMessage(this, map);
	}

	@Override
	public boolean equals(final Object o) {
	if (this == o) {
	return true;
	}
	if (o == null \|\| getClass() != o.getClass()) {
	return false;
	}

	final StructuredDataMessage that = (StructuredDataMessage) o;

	if (!super.equals(o)) {
	return false;
	}
	if (type != null ? !type.equals(that.type) : that.type != null) {
	return false;
	}
	if (id != null ? !id.equals(that.id) : that.id != null) {
	return false;
	}
	if (message != null ? !message.equals(that.message) : that.message != null) {
	return false;
	}

	return true;
	}

	@Override
	public int hashCode() {
	int result = super.hashCode();
	result = HASHVAL * result + (type != null ? type.hashCode() : 0);
	result = HASHVAL * result + (id != null ? id.hashCode() : 0);
	result = HASHVAL * result + (message != null ? message.hashCode() : 0);
	return result;
	}
	}