com.spt.development.audit.spring.boot.autoconfigure.AuditSpringProperties Maven / Gradle / Ivy

Go to download
package com.spt.development.audit.spring.boot.autoconfigure;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * Configuration properties for
 * spt-development/spt-development-audit-spring.
 */
@ConfigurationProperties(prefix = "spt.audit")
public class AuditSpringProperties {
    private final Jms jms;

    /**
     * Creates an object to encapsulate the spt.audit properties.
     *
     * @param jms object encapsulating the spt.audit properties related to
     *            {@link com.spt.development.audit.spring.JmsAuditEventWriter}.
     */
    public AuditSpringProperties(final Jms jms) {
        this.jms = jms;
    }

    /**
     * An object encasulating the spt.audit properties related to
     * {@link com.spt.development.audit.spring.JmsAuditEventWriter}.
     *
     * @return the JMS audit event writer properties.
     */
    public Jms getJms() {
        return jms;
    }

    /**
     * Configuration properties for
     * spt-development/spt-development-audit-spring.
     * relating to {@link com.spt.development.audit.spring.JmsAuditEventWriter}.
     */
    public static class Jms {
        private final String destination;

        /**
         * Creates an object to encapsulate the spt.audit.jms properties.
         *
         * @param destination the name of the JMS destination (queue/topic) to write audit event messages to.
         */
        public Jms(final String destination) {
            this.destination = destination;
        }

        /**
         * The name of the JMS destination (queue/topic) that audit event messages will be written to.
         *
         * @return the audit event JMS destination name.
         */
        public String getDestination() {
            return destination;
        }
    }
}