io.inversion.action.security

Class AuthScheme

java.lang.Object

io.inversion.action.security.AuthScheme

Direct Known Subclasses:

ApiKeyScheme, HttpAuthScheme

public abstract class AuthScheme
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthScheme.AuthSchemeType

Constructor Summary

Constructors

Constructor and Description
AuthScheme()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.String	getName()
java.util.List<Param>	getParams()
AuthScheme.AuthSchemeType	getType()
abstract User	getUser(Request req, Response res)
AuthScheme	withDescription(java.lang.String description)
AuthScheme	withName(java.lang.String name)
AuthScheme	withParam(Param param)
AuthScheme	withParams(java.util.List<Param> params)
AuthScheme	withType(AuthScheme.AuthSchemeType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthScheme

public AuthScheme()

Method Detail

getUser

public abstract User getUser(Request req,
                             Response res)
                      throws ApiException

Throws:

ApiException

getName

public java.lang.String getName()

withName

public AuthScheme withName(java.lang.String name)

getDescription

public java.lang.String getDescription()

withDescription

public AuthScheme withDescription(java.lang.String description)

getType

public AuthScheme.AuthSchemeType getType()

withType

public AuthScheme withType(AuthScheme.AuthSchemeType type)

getParams

public java.util.List<Param> getParams()

withParams

public AuthScheme withParams(java.util.List<Param> params)

withParam

public AuthScheme withParam(Param param)