io.knotx.server.configuration

Class AuthHandlerOptions

java.lang.Object

io.knotx.server.configuration.AuthHandlerOptions

public class AuthHandlerOptions
extends java.lang.Object

Handler definition that contains AuthHandlerFactory name and JSON configuration. During KnotxServerVerticle deployment all implementations of AuthHandlerFactory are loaded from the classpath and based on AuthHandlerFactory.getName() are initiated.

Constructor Summary

Constructors

Constructor and Description
AuthHandlerOptions(io.vertx.core.json.JsonObject json) Create settings from JSON

Method Summary

Modifier and Type	Method and Description
io.vertx.core.json.JsonObject	getConfig()
java.lang.String	getFactory()
java.lang.String	getSchema()
AuthHandlerOptions	setConfig(io.vertx.core.json.JsonObject config) Sets Handler configuration.
AuthHandlerOptions	setFactory(java.lang.String factory) Sets AuthHandlerFactory name
AuthHandlerOptions	setSchema(java.lang.String schema) Sets security schema name
io.vertx.core.json.JsonObject	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthHandlerOptions

public AuthHandlerOptions(io.vertx.core.json.JsonObject json)

Create settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

getSchema

public java.lang.String getSchema()

Returns:

security schema name

setSchema

public AuthHandlerOptions setSchema(java.lang.String schema)

Sets security schema name

Parameters:

schema - security schema name

Returns:

reference to this, so the API can be used fluently

getFactory

public java.lang.String getFactory()

Returns:

AuthHandlerFactory name

setFactory

public AuthHandlerOptions setFactory(java.lang.String factory)

Sets AuthHandlerFactory name

Parameters:

factory - handler factory name

Returns:

reference to this, so the API can be used fluently

getConfig

public io.vertx.core.json.JsonObject getConfig()

Returns:

JSON configuration used during AuthHandlerFactory.create(Vertx, JsonObject) initialization

setConfig

public AuthHandlerOptions setConfig(io.vertx.core.json.JsonObject config)

Sets Handler configuration.

Parameters:

config - handler JSON configuration

Returns:

reference to this, so the API can be used fluently

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object