Modifier and Type	Class and Description
private static record	CAYWResource.LibraryPathAccessPromptResult

Field Summary

Modifier and Type	Field and Description
private static volatile boolean	allowAllLibraryPaths
private static final Pattern	ALLOWED_COMMAND
private static final Set<Path>	BLOCKED_LIBRARY_PATHS
private static final String	CAYW_CONTENT_SECURITY_POLICY
private static final String	CHOCOLATEBIB_PATH
private static final String	CONTENT_SECURITY_POLICY
private FormatterService	formatterService
private static boolean	initialized
private static final String	INVALID_LIBRARY_PATH_ERROR
private static final Logger	LOGGER
private static final String	NO_SNIFF
private CliPreferences	preferences
private SrvStateManager	srvStateManager
private static final Set<Path>	TRUSTED_LIBRARY_PATHS
private static final String	X_CONTENT_TYPE_OPTIONS

Access	Constructor and Description
public	CAYWResource()

Method Summary

Modifier and Type	Method and Description
private CAYWEntry	createCAYWEntry(BibEntry entry)
private List<CAYWEntry>	filterEntries(List<CAYWEntry> entries, String searchText, InMemoryLibrarySearcher searcher) Filter strategy: Empty input → return everything. Valid Search.g4 expression → grammar-based filter via `InMemoryLibrarySearcher`. Invalid expression (e.g. user is mid-typing `author=`) → fall back to a plain substring match across the CAYW labels so the list stays useful as the user types.
private BibDatabaseContext	getBibDatabaseContext(CAYWQueryParams queryParams)
private @Nullable InputStream	getChocolateBibAsStream() Returns: a stream to the `Chocolate.bib` file in the classpath (is null only if the file was moved or there are issues with the classpath)
public Response	getCitation(CAYWQueryParams queryParams)
private BibDatabaseContext	getDatabaseContextFromStream(InputStream inputStream)
private InputStream	getDatabaseStreamFromPath(Path path)
private InputStream	getLatestDatabaseStream()
private List<Path>	getServedLibraryPaths()
private synchronized void	initializeGUI()
private boolean	isLibraryPathAccessAllowed(Path requestedLibraryPath)
private boolean	isServedLibraryPath(Path requestedLibraryPath)
private boolean	matchesSubstring(CAYWEntry entry, String searchText)
private Path	normalizeLibraryPath(String libraryPath)
private List<CAYWEntry>	openSearchGui(List<CAYWEntry> entries, BibDatabaseContext databaseContext)
private boolean	promptForLibraryPathAccess(Path requestedLibraryPath)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowAllLibraryPaths	back to summary
private static volatile boolean allowAllLibraryPaths

ALLOWED_COMMAND	back to summary
private static final Pattern ALLOWED_COMMAND

BLOCKED_LIBRARY_PATHS	back to summary
private static final Set<Path> BLOCKED_LIBRARY_PATHS

CAYW_CONTENT_SECURITY_POLICY	back to summary
private static final String CAYW_CONTENT_SECURITY_POLICY

CHOCOLATEBIB_PATH	back to summary
private static final String CHOCOLATEBIB_PATH

CONTENT_SECURITY_POLICY	back to summary
private static final String CONTENT_SECURITY_POLICY

formatterService	back to summary
private FormatterService formatterService Annotations @Inject

initialized	back to summary
private static boolean initialized

INVALID_LIBRARY_PATH_ERROR	back to summary
private static final String INVALID_LIBRARY_PATH_ERROR

LOGGER	back to summary
private static final Logger LOGGER

NO_SNIFF	back to summary
private static final String NO_SNIFF

preferences	back to summary
private CliPreferences preferences Annotations @Inject

srvStateManager	back to summary
private SrvStateManager srvStateManager Annotations @Inject

TRUSTED_LIBRARY_PATHS	back to summary
private static final Set<Path> TRUSTED_LIBRARY_PATHS

X_CONTENT_TYPE_OPTIONS	back to summary
private static final String X_CONTENT_TYPE_OPTIONS

CAYWResource	back to summary
public CAYWResource()

Method Detail

createCAYWEntry	back to summary
private CAYWEntry createCAYWEntry(BibEntry entry)

filterEntries back to summary

filterEntries	back to summary
private List<CAYWEntry> filterEntries(List<CAYWEntry> entries, String searchText, InMemoryLibrarySearcher searcher) Filter strategy: Empty input → return everything. Valid Search.g4 expression → grammar-based filter via `InMemoryLibrarySearcher`. Invalid expression (e.g. user is mid-typing `author=`) → fall back to a plain substring match across the CAYW labels so the list stays useful as the user types.

private List<CAYWEntry> filterEntries(List<CAYWEntry> entries, String searchText, InMemoryLibrarySearcher searcher)

Filter strategy:

Empty input → return everything.
Valid Search.g4 expression → grammar-based filter via InMemoryLibrarySearcher.
Invalid expression (e.g. user is mid-typing author=) → fall back to a plain substring match across the CAYW labels so the list stays useful as the user types.

getBibDatabaseContext	back to summary
private BibDatabaseContext getBibDatabaseContext(CAYWQueryParams queryParams) throws IOException

getChocolateBibAsStream	back to summary
private @Nullable InputStream getChocolateBibAsStream() Returns:@Nullable InputStream a stream to the `Chocolate.bib` file in the classpath (is null only if the file was moved or there are issues with the classpath)

getCitation	back to summary
public Response getCitation(CAYWQueryParams queryParams) throws IOException, ExecutionException, InterruptedException Annotations @GET @Produces:text/plain, application/json

getDatabaseContextFromStream	back to summary
private BibDatabaseContext getDatabaseContextFromStream(InputStream inputStream) throws IOException

getDatabaseStreamFromPath	back to summary
private InputStream getDatabaseStreamFromPath(Path path) throws IOException

getLatestDatabaseStream	back to summary
private InputStream getLatestDatabaseStream() throws IOException

getServedLibraryPaths	back to summary
private List<Path> getServedLibraryPaths()

initializeGUI	back to summary
private synchronized void initializeGUI()

isLibraryPathAccessAllowed	back to summary
private boolean isLibraryPathAccessAllowed(Path requestedLibraryPath)

isServedLibraryPath	back to summary
private boolean isServedLibraryPath(Path requestedLibraryPath)

matchesSubstring	back to summary
private boolean matchesSubstring(CAYWEntry entry, String searchText)

normalizeLibraryPath	back to summary
private Path normalizeLibraryPath(String libraryPath)

openSearchGui	back to summary
private List<CAYWEntry> openSearchGui(List<CAYWEntry> entries, BibDatabaseContext databaseContext) throws InterruptedException, ExecutionException

promptForLibraryPathAccess	back to summary
private boolean promptForLibraryPathAccess(Path requestedLibraryPath)

org.jabref.http.server.cayw back to summary

private final Record CAYWResource.LibraryPathAccessPromptResult

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.http.server.cayw.CAYWResource.LibraryPathAccessPromptResult

Record Components

selectedButton:ButtonType
dontAskAgain:boolean

Field Summary

Modifier and Type	Field and Description
private final boolean	dontAskAgain Record Component accessed by dontAskAgain().
private final ButtonType	selectedButton Record Component accessed by selectedButton().

Constructor Summary

Access	Constructor and Description
private	LibraryPathAccessPromptResult(ButtonType selectedButton, boolean dontAskAgain)

Method Summary

Modifier and Type	Method and Description
public boolean	dontAskAgain() Record Component getter of dontAskAgain.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public ButtonType	selectedButton() Record Component getter of selectedButton.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

dontAskAgain	back to summary
private final boolean dontAskAgain Record Component accessed by dontAskAgain().

selectedButton	back to summary
private final ButtonType selectedButton Record Component accessed by selectedButton().

Constructor Detail

LibraryPathAccessPromptResult	back to summary
private LibraryPathAccessPromptResult(ButtonType selectedButton, boolean dontAskAgain)

Method Detail

dontAskAgain	back to summary
public boolean dontAskAgain() Record Component getter of dontAskAgain.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

selectedButton	back to summary
public ButtonType selectedButton() Record Component getter of selectedButton.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class CAYWResource

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record CAYWResource.LibraryPathAccessPromptResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail