org.gnome.soup.AuthDomainBasicAuthCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of soup Show documentation
Java language bindings for Soup, generated with Java-GI
The newest version!
// Java-GI - Java language bindings for GObject-Introspection-based libraries
// Copyright (C) 2022-2024 Jan-Willem Harmannij
//
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, see .
//
// This file has been generated with Java-GI.
// Do not edit this file directly!
// Visit  for more information.
//
package org.gnome.soup;

import io.github.jwharm.javagi.gobject.InstanceCache;
import io.github.jwharm.javagi.interop.Interop;
import java.lang.FunctionalInterface;
import java.lang.String;
import java.lang.foreign.Arena;
import java.lang.foreign.FunctionDescriptor;
import java.lang.foreign.Linker;
import java.lang.foreign.MemorySegment;
import java.lang.foreign.ValueLayout;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import javax.annotation.processing.Generated;

/**
 * Functional interface declaration of the {@code AuthDomainBasicAuthCallback} callback.
 */
@FunctionalInterface
@Generated("io.github.jwharm.JavaGI")
public interface AuthDomainBasicAuthCallback {
    /**
     * Callback used by {@code SoupAuthDomainBasic} for authentication purposes.
     * 
     * The application should verify that {@code username} and {@code password} and valid
     * and return {@code true} or {@code false}.
     * 
     * If you are maintaining your own password database (rather than
     * using the password to authenticate against some other system like
     * PAM or a remote server), you should make sure you know what you are
     * doing. In particular, don't store cleartext passwords, or
     * easily-computed hashes of cleartext passwords, even if you don't
     * care that much about the security of your server, because users
     * will frequently use the same password for multiple sites, and so
     * compromising any site with a cleartext (or easily-cracked) password
     * database may give attackers access to other more-interesting sites
     * as well.
     */
    boolean run(AuthDomainBasic domain, ServerMessage msg, String username, String password);

    /**
     * The {@code upcall} method is called from native code. The parameters
     * are marshaled and {@link #run} is executed.
     */
    default int upcall(MemorySegment domain, MemorySegment msg, MemorySegment username,
            MemorySegment password, MemorySegment userData) {
        Arena _arena = Arena.ofAuto();
        var _result = run((AuthDomainBasic) InstanceCache.getForType(domain, AuthDomainBasic::new, false), (ServerMessage) InstanceCache.getForType(msg, ServerMessage::new, false), Interop.getStringFrom(username, false), Interop.getStringFrom(password, false));
        return _result ? 1 : 0;
    }

    /**
     * Creates a native function pointer to the {@link #upcall} method.
     *
     * @return the native function pointer
     */
    default MemorySegment toCallback(Arena arena) {
        FunctionDescriptor _fdesc = FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS,
                ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.ADDRESS);
        MethodHandle _handle = Interop.upcallHandle(MethodHandles.lookup(), AuthDomainBasicAuthCallback.class, _fdesc);
        return Linker.nativeLinker().upcallStub(_handle.bindTo(this), _fdesc, arena);
    }
}