ws.osiris.core

Class StaticRoute<T extends ComponentsProvider>

Route

ws.osiris.core.StaticRoute<T>

public class StaticRoute<T extends ComponentsProvider>
extends Route

Describes an endpoint in a REST API that serves static files.

It contains

• The HTTP method it accepts, must be GET, HEAD or OPTIONS

• The path to the endpoint, for example /foo/bar

• The authorisation needed to invoke the endpoint

Nested Class Summary

Nested classes/interfaces inherited from class ws.osiris.core.Route

Route.Companion

Field Summary

Fields inherited from class ws.osiris.core.Route

Companion

Constructor Summary

Constructors

Constructor and Description
StaticRoute(java.lang.String path, java.lang.String indexFile, Auth auth) Describes an endpoint in a REST API that serves static files.

Method Summary

Modifier and Type	Method and Description
java.lang.String	component1()
java.lang.String	component2()
Auth	component3()
StaticRoute<T>	copy(java.lang.String path, java.lang.String indexFile, Auth auth) Describes an endpoint in a REST API that serves static files.
boolean	equals(java.lang.Object p)
Auth	getAuth()
java.lang.String	getIndexFile()
java.lang.String	getPath()
int	hashCode()
java.lang.String	toString()

Methods inherited from class ws.osiris.core.Route

getAuth, getPath

Constructor Detail

StaticRoute

public StaticRoute(java.lang.String path,
                   java.lang.String indexFile,
                   Auth auth)

Describes an endpoint in a REST API that serves static files.

It contains

• The HTTP method it accepts, must be GET, HEAD or OPTIONS

• The path to the endpoint, for example /foo/bar

• The authorisation needed to invoke the endpoint

Method Detail

getPath

public java.lang.String getPath()

getIndexFile

public java.lang.String getIndexFile()

getAuth

public Auth getAuth()

component1

public java.lang.String component1()

component2

public java.lang.String component2()

component3

public Auth component3()

copy

public StaticRoute<T> copy(java.lang.String path,
                           java.lang.String indexFile,
                           Auth auth)

Describes an endpoint in a REST API that serves static files.

It contains

• The HTTP method it accepts, must be GET, HEAD or OPTIONS

• The path to the endpoint, for example /foo/bar

• The authorisation needed to invoke the endpoint

toString

public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object p)