io.numaproj.numaflow.info.ServerInfoAccessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of numaflow-java Show documentation

SDK to implement Numaflow Source or User Defined Functions or Sinks in Java.

There is a newer version: 0.9.0

package io.numaproj.numaflow.info;

public interface ServerInfoAccessor {
    String DEFAULT_SERVER_INFO_FILE_PATH = "/var/run/numaflow/server-info";

    String INFO_EOF = "U+005C__END__";

    /**
     * Get current runtime numaflow-java SDK version.
     */
    String getSDKVersion();

    /**
     * Delete filePath if it exists.
     * Write serverInfo to filePath in Json format.
     * Append {@link ServerInfoAccessor#INFO_EOF} as a new line to indicate end of file.
     *
     * @param serverInfo server information POJO
     * @param filePath file path to write to
     *
     * @throws Exception any exceptions are thrown to the caller.
     */
    void write(ServerInfo serverInfo, String filePath) throws Exception;

    /**
     * Read from filePath to retrieve server information POJO.
     * This API is only used for unit tests.
     *
     * @param filePath file path to read from
     *
     * @return server information POJO
     *
     * @throws Exception any exceptions are thrown to the caller.
     */
    ServerInfo read(String filePath) throws Exception;
}