/*
    * 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.core.appender.mom;
  
  import java.io.Serializable;
  import java.util.concurrent.TimeUnit;
  
  import javax.jms.JMSException;
  import javax.jms.Message;
  import javax.jms.MessageProducer;
  
  import org.apache.logging.log4j.core.Appender;
  import org.apache.logging.log4j.core.Filter;
  import org.apache.logging.log4j.core.Layout;
  import org.apache.logging.log4j.core.LogEvent;
  import org.apache.logging.log4j.core.appender.AbstractAppender;
  import org.apache.logging.log4j.core.appender.AppenderLoggingException;
  import org.apache.logging.log4j.core.config.Node;
  import org.apache.logging.log4j.core.config.plugins.Plugin;
  import org.apache.logging.log4j.core.config.plugins.PluginAliases;
  import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
  import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
  import org.apache.logging.log4j.core.config.plugins.PluginElement;
  import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;
  import org.apache.logging.log4j.core.layout.SerializedLayout;
  import org.apache.logging.log4j.core.net.JndiManager;
  
  /**
   * Generic JMS Appender plugin for both queues and topics. This Appender replaces the previous split ones. However,
   * configurations set up for the 2.0 version of the JMS appenders will still work.
   */
  @Plugin(name = "JMS", category = Node.CATEGORY, elementType = Appender.ELEMENT_TYPE, printObject = true)
  @PluginAliases({"JMSQueue", "JMSTopic"})
  public class JmsAppender extends AbstractAppender {
  
      private final JmsManager manager;
      private final MessageProducer producer;
  
      protected JmsAppender(final String name, final Filter filter, final Layout<? extends Serializable> layout,
                          final boolean ignoreExceptions, final JmsManager manager)
          throws JMSException {
          super(name, filter, layout, ignoreExceptions);
          this.manager = manager;
          this.producer = this.manager.createMessageProducer();
      }
  
      @Override
      public void append(final LogEvent event) {
          try {
              final Message message = this.manager.createMessage(getLayout().toSerializable(event));
              message.setJMSTimestamp(event.getTimeMillis());
              this.producer.send(message);
          } catch (final JMSException e) {
              throw new AppenderLoggingException(e);
          }
      }
  
      @Override
      public boolean stop(final long timeout, final TimeUnit timeUnit) {
          setStopping();
          boolean stopped = super.stop(timeout, timeUnit, false);
          stopped &= this.manager.stop(timeout, timeUnit);
          setStopped();
          return stopped;
      }
  
      @PluginBuilderFactory
      public static Builder newBuilder() {
          return new Builder();
      }
  
      public static class Builder implements org.apache.logging.log4j.core.util.Builder<JmsAppender> {
  
          @PluginBuilderAttribute
          @Required(message = "A name for the JmsAppender must be specified")
          private String name;
  
          @PluginBuilderAttribute
          private String factoryName;
  
          @PluginBuilderAttribute
          private String providerUrl;
  
          @PluginBuilderAttribute
         private String urlPkgPrefixes;
 
         @PluginBuilderAttribute
         private String securityPrincipalName;
 
         @PluginBuilderAttribute(sensitive = true)
         private String securityCredentials;
 
         @PluginBuilderAttribute
         @Required(message = "A javax.jms.ConnectionFactory JNDI name must be specified")
         private String factoryBindingName;
 
         @PluginBuilderAttribute
         @PluginAliases({"queueBindingName", "topicBindingName"})
         @Required(message = "A javax.jms.Destination JNDI name must be specified")
         private String destinationBindingName;
 
         @PluginBuilderAttribute
         private String username;
 
         @PluginBuilderAttribute(sensitive = true)
         private String password;
 
         @PluginElement("Layout")
         private Layout<? extends Serializable> layout = SerializedLayout.createLayout();
 
         @PluginElement("Filter")
         private Filter filter;
 
         @PluginBuilderAttribute
         private boolean ignoreExceptions = true;
 
         private Builder() {
         }
 
         public Builder setName(final String name) {
             this.name = name;
             return this;
         }
 
         public Builder setFactoryName(final String factoryName) {
             this.factoryName = factoryName;
             return this;
         }
 
         public Builder setProviderUrl(final String providerUrl) {
             this.providerUrl = providerUrl;
             return this;
         }
 
         public Builder setUrlPkgPrefixes(final String urlPkgPrefixes) {
             this.urlPkgPrefixes = urlPkgPrefixes;
             return this;
         }
 
         public Builder setSecurityPrincipalName(final String securityPrincipalName) {
             this.securityPrincipalName = securityPrincipalName;
             return this;
         }
 
         public Builder setSecurityCredentials(final String securityCredentials) {
             this.securityCredentials = securityCredentials;
             return this;
         }
 
         public Builder setFactoryBindingName(final String factoryBindingName) {
             this.factoryBindingName = factoryBindingName;
             return this;
         }
 
         public Builder setDestinationBindingName(final String destinationBindingName) {
             this.destinationBindingName = destinationBindingName;
             return this;
         }
 
         public Builder setUsername(final String username) {
             this.username = username;
             return this;
         }
 
         public Builder setPassword(final String password) {
             this.password = password;
             return this;
         }
 
         public Builder setLayout(final Layout<? extends Serializable> layout) {
             this.layout = layout;
             return this;
         }
 
         public Builder setFilter(final Filter filter) {
             this.filter = filter;
             return this;
         }
 
         public Builder setIgnoreExceptions(final boolean ignoreExceptions) {
             this.ignoreExceptions = ignoreExceptions;
             return this;
         }
 
         @Override
         public JmsAppender build() {
             final JndiManager jndiManager = JndiManager.getJndiManager(factoryName, providerUrl, urlPkgPrefixes,
                 securityPrincipalName, securityCredentials, null);
             final JmsManager jmsManager = JmsManager.getJmsManager(name, jndiManager, factoryBindingName,
                 destinationBindingName, username, password);
             try {
                 return new JmsAppender(name, filter, layout, ignoreExceptions, jmsManager);
             } catch (final JMSException e) {
                 LOGGER.error("Error creating JmsAppender [{}].", name, e);
                 return null;
             }
         }
     }
 
 }