com.atlassian.connect.spring.AddonUninstalledEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atlassian-connect-spring-boot-api Show documentation

Provides the API of Atlassian Connect for Spring Boot

The newest version!

package com.atlassian.connect.spring;

import org.springframework.context.ApplicationEvent;

/**
 * A Spring application event
 * fired when the add-on has been successfully uninstalled from a host.
 *
 * To listen to this event, use the {@link org.springframework.context.event.EventListener} annotation:
 * 
 @EventListener
 * public void addonUninstalled(AddonUninstalledEvent event) {
 *     ...
 * }
 *
 * NOTE: This event is fired asynchronously and cannot affect the HTTP response returned to the
 * Atlassian host.
 *
 * @since 1.0.0
 */
public class AddonUninstalledEvent extends ApplicationEvent {

    /**
     * The host for which this event occurred.
     */
    private final AtlassianHost host;

    /**
     * Creates a new event.
     *
     * @param source the object on which the event initially occurred (never {@code null})
     * @param host   the host for which the event occurred
     */
    public AddonUninstalledEvent(Object source, AtlassianHost host) {
        super(source);
        this.host = host;
    }

    /**
     * Returns the host for which the event occurred.
     *
     * @return the Atlassian host
     */
    public AtlassianHost getHost() {
        return host;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return String.format("AddonUninstalledEvent{host=%s}", host);
    }
}