ktor-server-core/io.ktor.server.http.content

Package-level declarations

Types

CompressedFileType

enum CompressedFileType : Enum<CompressedFileType>

Supported pre compressed file types and associated extensions

HttpStatusCodeContent

class HttpStatusCodeContent(value: HttpStatusCode) : OutgoingContent.NoContent

Represents a simple status code response with no content

JarFileContent

class JarFileContent(val jarFile: File, val resourcePath: String, val contentType: ContentType) : OutgoingContent.ReadChannelContent

Represents an OutgoingContent for a resource inside a Jar file

LocalFileContent

class LocalFileContent(val file: File, val contentType: ContentType = ContentType.defaultForFile(file)) : OutgoingContent.ReadChannelContent

OutgoingContent representing a local file with a specified contentType, expires date and caching

SPAConfig

class SPAConfig(var defaultPage: String = "index.html", var applicationRoute: String = "/", var filesPath: String = "", var useResources: Boolean = false, ignoredFiles: MutableList<(String) -> Boolean> = mutableListOf())

Configuration for the Route.singlePageApplication plugin.

Functions

angular

fun SPAConfig.angular(filesPath: String)

Creates an application configuration for the Angular project. Resources will be shared from the filesPath directory. The root file is index.html

backbone

fun SPAConfig.backbone(filesPath: String)

Creates an application configuration for the Backbone project. Resources will be shared from the filesPath directory. The root file is index.html

CachingOptions

fun CachingOptions(cacheControl: CacheControl? = null, expires: ZonedDateTime): CachingOptions

Creates CachingOptions instance with ZonedDateTime expiration time

default

fun Route.default(localPath: File)

fun Route.default(localPath: String)

Specifies localPath as a default file to serve when folder is requested

defaultResource

fun Route.defaultResource(resource: String, resourcePackage: String? = null)

Specifies resource as a default resources to serve when folder is requested

ember

fun SPAConfig.ember(filesPath: String)

Creates an application configuration for the Ember project. Resources will be shared from the filesPath directory. The root file is index.html

file

fun Route.file(remotePath: String, localPath: File)

fun Route.file(remotePath: String, localPath: String = remotePath)

Sets up routing to serve localPath file as remotePath

files

fun Route.files(folder: File)

fun Route.files(folder: String)

Sets up routing to serve all files from folder

ignoreFiles

fun SPAConfig.ignoreFiles(block: (path: String) -> Boolean)

Registers a block in ignoredFiles returns true if path should be ignored.

LastModifiedVersion

fun LastModifiedVersion(lastModified: FileTime): LastModifiedVersion

Construct LastModifiedVersion version from a FileTime instance

fun LastModifiedVersion(lastModified: ZonedDateTime): LastModifiedVersion

Construct LastModifiedVersion version from a ZonedDateTime instance

fun LastModifiedVersion(lastModified: Long): LastModifiedVersion

Construct LastModifiedVersion version from a Long instance

LocalFileContent

fun LocalFileContent(baseDir: File, relativePath: String, contentType: ContentType = ContentType.defaultForFilePath(relativePath)): LocalFileContent

fun LocalFileContent(baseDir: Path, relativePath: Path, contentType: ContentType = ContentType.defaultForFile(relativePath)): LocalFileContent

Creates an instance of LocalFileContent for a file designated by relativePath in a baseDir

preCompressed

fun Route.preCompressed(vararg types: CompressedFileType = CompressedFileType.values(), configure: Route.() -> Unit)

Support pre-compressed files in the file system only (not just any classpath resource)

react

fun SPAConfig.react(filesPath: String)

Creates an application configuration for the React project. Resources will be shared from the filesPath directory. The root file is index.html

resolveResource

fun ApplicationCall.resolveResource(path: String, resourcePackage: String? = null, classLoader: ClassLoader = application.environment.classLoader, mimeResolve: (String) -> ContentType = { ContentType.defaultForFileExtension(it) }): OutgoingContent?

resource

fun Route.resource(remotePath: String, resource: String = remotePath, resourcePackage: String? = null)

Sets up routing to serve resource as remotePath in resourcePackage

resourceClasspathResource

fun resourceClasspathResource(url: URL, path: String, mimeResolve: (String) -> ContentType): OutgoingContent?

Attempt to find a local file or a file inside of zip. This is not required but very good to have to improve performance and unnecessary java.io.InputStream creation.

resources