bundles/org.eclipse.swt.browser.chromium/common/org/eclipse/swt/internal/chromium/lib/cef_request_handler_t.java

/********************************************************************************
 * Copyright (c) 2020 Equo
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *   Guillermo Zunino, Equo - initial implementation
 ********************************************************************************/
package org.eclipse.swt.internal.chromium.lib;

import org.eclipse.swt.internal.*;

///
/// Implement this structure to handle events related to browser requests. The
/// functions of this structure will be called on the thread indicated.
///
public class cef_request_handler_t {
	///
	/// Base structure.
	///
	public cef_base_ref_counted_t base;
	///
	/// Called on the UI thread before browser navigation. Return true (1) to
	/// cancel the navigation or false (0) to allow the navigation to proceed. The
	/// |request| object cannot be modified in this callback.
	/// cef_load_handler_t::OnLoadingStateChange will be called twice in all cases.
	/// If the navigation is allowed cef_load_handler_t::OnLoadStart and
	/// cef_load_handler_t::OnLoadEnd will be called. If the navigation is canceled
	/// cef_load_handler_t::OnLoadError will be called with an |errorCode| value of
	/// ERR_ABORTED.
	///
	/** @field cast=(void*) */
	public long on_before_browse;
	///
	/// Called on the UI thread before OnBeforeBrowse in certain limited cases
	/// where navigating a new or different browser might be desirable. This
	/// includes user-initiated navigation that might open in a special way (e.g.
	/// links clicked via middle-click or ctrl + left-click) and certain types of
	/// cross-origin navigation initiated from the renderer process (e.g.
	/// navigating the top-level frame to/from a file URL). The |browser| and
	/// |frame| values represent the source of the navigation. The
	/// |target_disposition| value indicates where the user intended to navigate
	/// the browser based on standard Chromium behaviors (e.g. current tab, new
	/// tab, etc). The |user_gesture| value will be true (1) if the browser
	/// navigated via explicit user gesture (e.g. clicking a link) or false (0) if
	/// it navigated automatically (e.g. via the DomContentLoaded event). Return
	/// true (1) to cancel the navigation or false (0) to allow the navigation to
	/// proceed in the source browser's top-level frame.
	///
	/** @field cast=(void*) */
	public long on_open_urlfrom_tab;
	///
	/// Called on the IO thread before a resource request is loaded. The |request|
	/// object may be modified. Return RV_CONTINUE to continue the request
	/// immediately. Return RV_CONTINUE_ASYNC and call cef_request_tCallback::
	/// cont() at a later time to continue or cancel the request asynchronously.
	/// Return RV_CANCEL to cancel the request immediately.
	///
	///
	/** @field cast=(void*) */
	public long on_before_resource_load;
	///
	/// Called on the IO thread before a resource is loaded. To allow the resource
	/// to load normally return NULL. To specify a handler for the resource return
	/// a cef_resource_handler_t object. The |request| object should not be
	/// modified in this callback.
	///
	/** @field cast=(void*) */
	public long get_resource_handler;
	///
	/// Called on the IO thread when a resource load is redirected. The |request|
	/// parameter will contain the old URL and other request-related information.
	/// The |response| parameter will contain the response that resulted in the
	/// redirect. The |new_url| parameter will contain the new URL and can be
	/// changed if desired. The |request| object cannot be modified in this
	/// callback.
	///
	/** @field cast=(void*) */
	public long on_resource_redirect;
	///
	/// Called on the IO thread when a resource response is received. To allow the
	/// resource to load normally return false (0). To redirect or retry the
	/// resource modify |request| (url, headers or post body) and return true (1).
	/// The |response| object cannot be modified in this callback.
	///
	/** @field cast=(void*) */
	public long on_resource_response;
	///
	/// Called on the IO thread to optionally filter resource response content.
	/// |request| and |response| represent the request and response respectively
	/// and cannot be modified in this callback.
	///
	/** @field cast=(void*) */
	public long get_resource_response_filter;
	///
	/// Called on the IO thread when a resource load has completed. |request| and
	/// |response| represent the request and response respectively and cannot be
	/// modified in this callback. |status| indicates the load completion status.
	/// |received_content_length| is the number of response bytes actually read.
	///
	/** @field cast=(void*) */
	public long on_resource_load_complete;
	///
	/// Called on the IO thread when the browser needs credentials from the user.
	/// |isProxy| indicates whether the host is a proxy server. |host| contains the
	/// hostname and |port| contains the port number. |realm| is the realm of the
	/// challenge and may be NULL. |scheme| is the authentication scheme used, such
	/// as "basic" or "digest", and will be NULL if the source of the request is an
	/// FTP server. Return true (1) to continue the request and call
	/// cef_auth_callback_t::cont() either in this function or at a later time when
	/// the authentication information is available. Return false (0) to cancel the
	/// request immediately.
	///
	/** @field cast=(void*) */
	public long get_auth_credentials;
	///
	/// Called on the IO thread when JavaScript requests a specific storage quota
	/// size via the webkitStorageInfo.requestQuota function. |origin_url| is the
	/// origin of the page making the request. |new_size| is the requested quota
	/// size in bytes. Return true (1) to continue the request and call
	/// cef_request_tCallback::cont() either in this function or at a later time to
	/// grant or deny the request. Return false (0) to cancel the request
	/// immediately.
	///
	/** @field cast=(void*) */
	public long on_quota_request;
	///
	/// Called on the UI thread to handle requests for URLs with an unknown
	/// protocol component. Set |allow_os_execution| to true (1) to attempt
	/// execution via the registered OS protocol handler, if any. SECURITY WARNING:
	/// YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR
	/// OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.
	///
	/** @field cast=(void*) */
	public long on_protocol_execution;
	///
	/// Called on the UI thread to handle requests for URLs with an invalid SSL
	/// certificate. Return true (1) and call cef_request_tCallback::cont() either
	/// in this function or at a later time to continue or cancel the request.
	/// Return false (0) to cancel the request immediately. If
	/// CefSettings.ignore_certificate_errors is set all invalid certificates will
	/// be accepted without calling this function.
	///
	/** @field cast=(void*) */
	public long on_certificate_error;
	///
	/// Called on the UI thread when a client certificate is being requested for
	/// authentication. Return false (0) to use the default behavior and
	/// automatically select the first certificate available. Return true (1) and
	/// call cef_select_client_certificate_callback_t::Select either in this
	/// function or at a later time to select a certificate. Do not call Select or
	/// call it with NULL to continue without using any certificate. |isProxy|
	/// indicates whether the host is an HTTPS proxy or the origin server. |host|
	/// and |port| contains the hostname and port of the SSL server. |certificates|
	/// is the list of certificates to choose from; this list has already been
	/// pruned by Chromium so that it only contains certificates from issuers that
	/// the server trusts.
	///
	/** @field cast=(void*) */
	public long on_select_client_certificate;
	///
	/// Called on the browser process UI thread when a plugin has crashed.
	/// |plugin_path| is the path of the plugin that crashed.
	///
	/** @field cast=(void*) */
	public long on_plugin_crashed;
	///
	/// Called on the browser process UI thread when the render view associated
	/// with |browser| is ready to receive/handle IPC messages in the render
	/// process.
	///
	/** @field cast=(void*) */
	public long on_render_view_ready;
	///
	/// Called on the browser process UI thread when the render process terminates
	/// unexpectedly. |status| indicates how the process terminated.
	///
	/** @field cast=(void*) */
	public long on_render_process_terminated;

	/** @field flags=no_gen */
	public long ptr;
	/** @field flags=no_gen */
	public Callback on_before_browse_cb;
	/** @field flags=no_gen */
	public Callback get_auth_credentials_cb;

	public static final int sizeof = ChromiumLib.cef_request_handler_t_sizeof();
}