Package ghidra.framework.protocol.ghidra

Class GhidraURLQuery

java.lang.Object

ghidra.framework.protocol.ghidra.GhidraURLQuery

public class GhidraURLQuery
extends Object

GhidraURLQuery performs remote Ghidra repository and read-only local project queries for processing either a DomainFile or DomainFolder that a Ghidra URL may reference.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GhidraURLQuery.LinkFileControl	GhidraURLQuery.LinkFileControl setting control how link-files will be followed.

Method Summary

Modifier and Type	Method	Description
static void	queryRepositoryUrl(URL ghidraUrl, boolean readOnly, GhidraURLResultHandler resultHandler, GhidraURLQuery.LinkFileControl linkFileControl, TaskMonitor monitor)	Perform query using specified GhidraURL and process result.
static void	queryUrl(URL ghidraUrl, Class<? extends DomainObject> contentClass, GhidraURLResultHandler resultHandler, GhidraURLQuery.LinkFileControl linkFileControl, TaskMonitor monitor)	Perform read-only query using specified GhidraURL and process result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

queryUrl

public static void queryUrl(URL ghidraUrl,
 Class<? extends DomainObject> contentClass,
 GhidraURLResultHandler resultHandler,
 GhidraURLQuery.LinkFileControl linkFileControl,
 TaskMonitor monitor)
                     throws IOException,
CancelledException

Perform read-only query using specified GhidraURL and process result. Both local project and remote repository URLs are supported. This method is intended to be invoked from within a Task or for headless operations.

Parameters:

ghidraUrl - local or remote Ghidra URL

contentClass - expected content class or null. If a folder is expected NullFolderDomainObject class should be specified.

resultHandler - query result handler

linkFileControl - controls how or if link files will be followed

monitor - task monitor

Throws:

IOException - if an IO error occurs which was re-thrown by resultHandler

CancelledException - if task is cancelled

queryRepositoryUrl

public static void queryRepositoryUrl(URL ghidraUrl,
 boolean readOnly,
 GhidraURLResultHandler resultHandler,
 GhidraURLQuery.LinkFileControl linkFileControl,
 TaskMonitor monitor)
                               throws IOException,
CancelledException

Perform query using specified GhidraURL and process result. Both local project and remote repository URLs are supported. This method is intended to be invoked from within a Task or for headless operations.

Parameters:

ghidraUrl - local or remote folder-level Ghidra URL

readOnly - allows update/commit (false) or read-only (true) access.

resultHandler - query result handler

linkFileControl - controls how or if link files will be followed

monitor - task monitor

Throws:

IOException - if an IO error occurs which was re-thrown by resultHandler

CancelledException - if task is cancelled