Uses of Class
org.rapidcontext.core.storage.Path

Packages that use Path
Package
Description
Provides the server applications and launchers.
Provides top-level application data transforms and security.
Provides the built-in server procedures.
Provides the application web request handlers.
Provides the procedure and interceptor API:s.
Provides the storage, storable object and metadata API:s.
Provides the storage data types & server-side object initialization.
  • Uses of Path in org.rapidcontext.app

    Fields in org.rapidcontext.app declared as Path
    Modifier and Type
    Field
    Description
    static final Path
    ServletApplication.DOC_PATH
    The documentation storage path.
    static final Path
    ApplicationContext.PATH_CONFIG
    The path to the global configuration.
    static final Path
    ApplicationContext.PATH_PLATFORM
    The path to the platform information.
  • Uses of Path in org.rapidcontext.app.model

    Fields in org.rapidcontext.app.model declared as Path
    Modifier and Type
    Field
    Description
    static final Path
    AppStorage.SESSION_CURRENT
    The current session path.
    static final Path
    AppStorage.USER_CURRENT
    The current user path.
    Methods in org.rapidcontext.app.model with parameters of type Path
    Modifier and Type
    Method
    Description
    static boolean
    ApiUtil.delete(Storage storage, Path path)
    Deletes a storage object or path.
    boolean
    AppStorage.isAccessible(Path path)
    Checks if a storage path is valid for read access.
    static Stream<Object>
    ApiUtil.load(Storage storage, Path path, String perm, Dict opts)
    Load objects from storage and serializes the results.
    AppStorage.load(Path path)
    Loads an object from the specified location.
    ApiUtil.lookup(Storage storage, Path path, String perm, Dict opts)
    Search for object metadata in storage.
    AppStorage.lookup(Path path)
    Searches for an object at the specified location and returns metadata about the object if found.
    static Object
    ApiUtil.serialize(Path path, Object obj, Dict opts, boolean limitedTypes)
    Returns a serialized representation of an object.
    static boolean
    ApiUtil.store(Storage storage, Path path, Object data)
    Writes a data object to the storage.
    static boolean
    ApiUtil.update(Storage storage, Path src, Path dst, Dict patch)
    Updates and/or moves an existing data object in the storage.
  • Uses of Path in org.rapidcontext.app.proc

    Fields in org.rapidcontext.app.proc declared as Path
    Modifier and Type
    Field
    Description
    static final Path
    AppListProcedure.PATH_APP
    The app object storage path.
    Methods in org.rapidcontext.app.proc with parameters of type Path
    Modifier and Type
    Method
    Description
    static boolean
    StorageCopyProcedure.copy(Path src, Path dst, boolean update, String ext)
    Copies a storage path (index or object) to a new destination.
    static boolean
    StorageCopyProcedure.copyObject(Path src, Path dst, boolean update, String ext)
    Copies a single storage object to a new destination.
  • Uses of Path in org.rapidcontext.app.web

    Methods in org.rapidcontext.app.web that return Path
    Modifier and Type
    Method
    Description
    FileWebService.path()
    Returns the base storage path for file lookups.
    Methods in org.rapidcontext.app.web that return types with arguments of type Path
    Modifier and Type
    Method
    Description
    protected Stream<Path>
    FileWebService.lookupPaths(Path filePath, boolean exact)
    Returns an ordered stream of file lookup paths.
    Methods in org.rapidcontext.app.web with parameters of type Path
    Modifier and Type
    Method
    Description
    protected Stream<Path>
    FileWebService.lookupPaths(Path filePath, boolean exact)
    Returns an ordered stream of file lookup paths.
    protected void
    FileWebService.processFile(Request request, Path filePath, boolean exact)
    Processes a storage file retrieval request (if possible).
    protected static String[]
    AppWebService.resources(String type, Path base)
    Finds binary files of a specified type from the storage.
  • Uses of Path in org.rapidcontext.core.proc

    Fields in org.rapidcontext.core.proc declared as Path
    Modifier and Type
    Field
    Description
    static final Path
    Library.PATH_PROC
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use org.rapidcontext.core.type.Procedure.PATH instead.
    Methods in org.rapidcontext.core.proc that return Path
    Modifier and Type
    Method
    Description
    CallStack.top(int offset)
    Returns the most recent caller from the stack.
  • Uses of Path in org.rapidcontext.core.storage

    Fields in org.rapidcontext.core.storage declared as Path
    Modifier and Type
    Field
    Description
    static final Path
    RootStorage.PATH_FILES
    The storage path for public web files.
    static final Path
    RootStorage.PATH_LIB
    The storage path to the JAR library files.
    static final Path
    RootStorage.PATH_STORAGE
    The storage path for mounted storages.
    static final Path
    The storage information path.
    static final Path
    Path.ROOT
    A root path constant.
    Fields in org.rapidcontext.core.storage with type parameters of type Path
    Modifier and Type
    Field
    Description
    protected HashMap<Path,Object>
    ZipStorage.entries
    The ZIP entries and index map.
    protected HashMap<Path,Path>
    ZipStorage.paths
    The ZIP storage paths (identity) map.
    protected HashMap<Path,Path>
    ZipStorage.paths
    The ZIP storage paths (identity) map.
    Methods in org.rapidcontext.core.storage that return Path
    Modifier and Type
    Method
    Description
    Path.child(String name, boolean isIndex)
    Creates a new path to a child index or object.
    static Path
    Path.from(String path)
    Creates a new path from a string representation (similar to a file system path).
    protected Path
    Storage.localPath(Path path)
    Returns a local storage path by removing an optional base storage path.
    protected Path
    ZipStorage.locatePath(Path path)
    Searches for an existing path in the ZIP file.
    Returns the mount overlay path.
    static Path
    Storage.objectPath(Path path)
    Returns a normalized path by removing any supported data format file extension (if found).
    Path.parent()
    Creates a new path to the parent index.
    Metadata.path()
    Returns the absolute object path.
    StorableObject.path()
    Returns the (recommended) object storage path.
    Storage.path()
    Returns the storage mount path.
    Path.removePrefix(Path prefix)
    Creates a new path with the specified prefix removed.
    static Path
    Path.resolve(Path parent, String path)
    Resolves a path starting at a parent path.
    static Path
    Path.resolve(Path parent, Path path)
    Resolves a path starting at a parent path.
    static Path
    Storage.serializedPath(Path path, String mimeType)
    Returns a serialized path by adding a supported data format file extension.
    Path.sibling(String name)
    Creates a new path to a sibling index or object.
    Methods in org.rapidcontext.core.storage that return types with arguments of type Path
    Modifier and Type
    Method
    Description
    Index.paths(Path basePath, boolean hidden)
    Returns a stream of paths corresponding to all indices and objects in this index.
    Query.paths()
    Returns the stream of matching object paths.
    Methods in org.rapidcontext.core.storage with parameters of type Path
    Modifier and Type
    Method
    Description
    static boolean
    RootStorage.isBinaryPath(Path path)
    Checks if a path corresponds to a known binary file path.
    static boolean
    RootStorage.isObjectPath(Path path)
    Checks if a path corresponds to a non-root and non-binary path.
    DirStorage.load(Path path)
    Loads an object from the specified location.
    MemoryStorage.load(Path path)
    Loads an object from the specified location.
    RootStorage.load(Path path)
    Loads an object from the specified location.
    abstract Object
    Storage.load(Path path)
    Loads an object from the specified location.
    <T> T
    Storage.load(Path path, Class<T> clazz)
    Loads an object from the specified location.
    ZipStorage.load(Path path)
    Loads an object from the specified location.
    protected Path
    Storage.localPath(Path path)
    Returns a local storage path by removing an optional base storage path.
    protected Path
    ZipStorage.locatePath(Path path)
    Searches for an existing path in the ZIP file.
    DirStorage.lookup(Path path)
    Searches for an object at the specified location and returns metadata about the object if found.
    MemoryStorage.lookup(Path path)
    Searches for an object at the specified location and returns metadata about the object if found.
    RootStorage.lookup(Path path)
    Searches for an object at the specified location and returns metadata about the object if found.
    abstract Metadata
    Storage.lookup(Path path)
    Searches for an object at the specified location and returns metadata about the object if found.
    ZipStorage.lookup(Path path)
    Searches for an object at the specified location and returns metadata about the object if found.
    void
    RootStorage.mount(Storage storage, Path path)
    Mounts a storage to a unique path.
    RootStorage.mounts(Path path)
    Returns a stream of all mounted storages found under a path.
    static Path
    Storage.objectPath(Path path)
    Returns a normalized path by removing any supported data format file extension (if found).
    Index.paths(Path basePath, boolean hidden)
    Returns a stream of paths corresponding to all indices and objects in this index.
    Storage.query(Path base)
    Returns a new storage query for this storage.
    void
    RootStorage.remount(Path path, boolean readWrite, Path cache, Path overlay, int prio)
    Remounts an already mounted storage to enable/disable read-write, caching and root overlay options.
    void
    DirStorage.remove(Path path)
    Removes an object or an index at the specified location.
    void
    MemoryStorage.remove(Path path)
    Removes an object or an index at the specified location.
    void
    RootStorage.remove(Path path)
    Removes an object or an index at the specified location.
    abstract void
    Storage.remove(Path path)
    Removes an object or an index at the specified location.
    void
    ZipStorage.remove(Path path)
    Removes an object or an index at the specified location.
    Path.removePrefix(Path prefix)
    Creates a new path with the specified prefix removed.
    static Path
    Path.resolve(Path parent, String path)
    Resolves a path starting at a parent path.
    static Path
    Path.resolve(Path parent, Path path)
    Resolves a path starting at a parent path.
    static Path
    Storage.serializedPath(Path path, String mimeType)
    Returns a serialized path by adding a supported data format file extension.
    void
    Storage.setMountInfo(Path path, boolean readWrite, Path overlay, int prio)
    Updates the mount information for this storage.
    boolean
    Path.startsWith(Path path)
    Checks if this path starts with the specified path.
    void
    DirStorage.store(Path path, Object data)
    Stores an object at the specified location.
    void
    MemoryStorage.store(Path path, Object data)
    Stores an object at the specified location.
    void
    RootStorage.store(Path path, Object data)
    Stores an object at the specified location.
    abstract void
    Storage.store(Path path, Object data)
    Stores an object at the specified location.
    void
    ZipStorage.store(Path path, Object data)
    Stores an object at the specified location.
    void
    RootStorage.unmount(Path path)
    Unmounts a storage from the specified path.
    Method parameters in org.rapidcontext.core.storage with type arguments of type Path
    Modifier and Type
    Method
    Description
    Query.filter(Predicate<Path> predicate)
    Adds a path predicate filter to all results.
    Constructors in org.rapidcontext.core.storage with parameters of type Path
    Modifier
    Constructor
    Description
     
    Metadata(Class<?> clazz, Path path, Path storagePath, Date modified)
    Creates a new metadata container.
     
    Metadata(Path path, Metadata meta)
    Creates a new metadata container with modified path information.
     
    Query(Storage storage, Path base)
    Creates a new query for the specified storage.
  • Uses of Path in org.rapidcontext.core.type

    Fields in org.rapidcontext.core.type declared as Path
    Modifier and Type
    Field
    Description
    static final Path
    Connection.PATH
    The connection object storage path.
    static final Path
    Environment.PATH
    The environment object storage path.
    static final Path
    Metrics.PATH
    The metrics object storage path.
    static final Path
    Plugin.PATH
    The plug-in object storage path.
    static final Path
    Procedure.PATH
    The procedure object storage path.
    static final Path
    Role.PATH
    The role object storage path.
    static final Path
    Session.PATH
    The session object storage path.
    static final Path
    Type.PATH
    The connection object storage path.
    static final Path
    User.PATH
    The user object storage path.
    static final Path
    WebService.PATH
    The web service object storage path.
    static final Path
    Plugin.PATH_CACHE
    The storage path to mounted plug-in caches.
    static final Path
    The storage path to mounted plug-in storages.
    Methods in org.rapidcontext.core.type that return Path
    Modifier and Type
    Method
    Description
    static Path
    Plugin.cachePath(String pluginId)
    Returns the plug-in cache path for a specified plug-in id.
    static Path
    Plugin.configPath(String pluginId)
    Returns the object path for a plug-in configuration object.
    static Path
    Plugin.instancePath(String pluginId)
    Returns the object path for a loaded and initialized plug-in.
    static Path
    Plugin.storagePath(String pluginId)
    Returns the plug-in storage path for a specified plug-in id.