org.freedesktop.dbus.connections.config.SaslConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbus-java-osgi Show documentation

Improved version of the DBus-Java library provided by freedesktop.org (https://dbus.freedesktop.org/doc/dbus-java/). This is the OSGi compliant bundle of all required libraries in one bundle.

There is a newer version: 5.1.1

Show newest version

package org.freedesktop.dbus.connections.config;

import org.freedesktop.dbus.connections.SASL;
import org.freedesktop.dbus.connections.SASL.SaslMode;

import java.util.OptionalLong;

/**
 * Bean contains configuration for SASL authentication.
 *
 * @author hypfvieh
 *
 * @since 4.2.0 - 2022-07-22
 */
public class SaslConfig {
    private SaslMode     mode;
    private int          authMode;
    private String       guid;
    private OptionalLong saslUid;

    private boolean      strictCookiePermissions;
    private boolean      fileDescriptorSupport;

    SaslConfig() {
        mode = SASL.SaslMode.CLIENT;
        authMode = SASL.AUTH_NONE;
        saslUid = OptionalLong.empty();
    }

    public SaslMode getMode() {
        return mode;
    }

    public void setMode(SaslMode _mode) {
        mode = _mode;
    }

    public int getAuthMode() {
        return authMode;
    }

    public void setAuthMode(int _types) {
        authMode = _types;
    }

    public String getGuid() {
        return guid;
    }

    public void setGuid(String _guid) {
        guid = _guid;
    }

    public OptionalLong getSaslUid() {
        return saslUid;
    }

    public void setSaslUid(OptionalLong _saslUid) {
        saslUid = _saslUid;
    }

    /**
     * Whether the permissions of the cookie files (used for DBUS_COOKIE_SHA1) should be checked.

     * Cookie permission check will only be used on Linux/Unix like OSes.
     *
     * @return boolean
     * @since v4.2.2 - 2023-02-03
     */
    public boolean isStrictCookiePermissions() {
        return strictCookiePermissions;
    }

    /**
     * Enable/disable checking of file permissions of the cookie files (used for DBUS_COOKIE_SHA1).

     * Cookie permission check will only be used on Linux/Unix like OSes.
     *
     * @since v4.2.2 - 2023-02-03
     */
    public void setStrictCookiePermissions(boolean _strictCookiePermissions) {
        strictCookiePermissions = _strictCookiePermissions;
    }

    /**
     * Whether file descriptor passing is allowed.
     *
     * @return boolean
     * @since v4.2.2 - 2023-02-03
     */
    public boolean isFileDescriptorSupport() {
        return fileDescriptorSupport;
    }

    /**
     * Enable/disable support of file descriptor passing.
     *
     * @since v4.2.2 - 2023-02-03
     */
    public void setFileDescriptorSupport(boolean _fileDescriptorSupport) {
        fileDescriptorSupport = _fileDescriptorSupport;
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + " [mode=" + mode + ", authMode=" + authMode
            + ", guid=" + guid + ", saslUid=" + saslUid
            + ", strictCookiePermissions=" + strictCookiePermissions
            + ", fileDescriptorSupport="
            + fileDescriptorSupport + "]";
    }

}