fish.payara.notification.xmpp.XmppNotifierConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 *
 * Copyright (c) 2016 Payara Foundation and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/master/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package fish.payara.notification.xmpp;

import fish.payara.nucleus.notification.configuration.NotifierConfiguration;
import fish.payara.nucleus.notification.configuration.NotifierConfigurationType;
import fish.payara.nucleus.notification.configuration.NotifierType;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.Configured;

import java.beans.PropertyVetoException;

/**
 * Configuration class with the aim to configure XMPP notification specific parameters.
 * This configuration is only being used by notification services.
 *
 * @author mertcaliskan
 */
@Configured
@NotifierConfigurationType(type = NotifierType.XMPP)
public interface XmppNotifierConfiguration extends NotifierConfiguration {

    @Attribute(required = true)
    String getHost();
    void host(String host) throws PropertyVetoException;

    @Attribute(dataType = Integer.class, defaultValue = "5222")
    String getPort();
    void port(String port) throws PropertyVetoException;

    @Attribute(required = true)
    String getServiceName();
    void serviceName(String serviceName) throws PropertyVetoException;

    @Attribute()
    String getUsername();
    void username(String username) throws PropertyVetoException;

    @Attribute()
    String getPassword();
    void password(String password) throws PropertyVetoException;

    @Attribute(defaultValue = "false")
    String getSecurityDisabled();
    void securityDisabled(String securityDisabled) throws PropertyVetoException;

    @Attribute(required = true)
    String getRoomId();
    void roomId(String roomId) throws PropertyVetoException;}