Package io.inversion.action.security

Class AuthScheme

java.lang.Object

io.inversion.action.security.AuthScheme

Direct Known Subclasses:

ApiKeyScheme, HttpAuthScheme

public abstract class AuthScheme
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AuthScheme.AuthSchemeType

Constructor Summary

Constructors

Constructor	Description
AuthScheme()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getName()
List<Param>	getParams()
AuthScheme.AuthSchemeType	getType()
abstract User	getUser(Request req, Response res)
AuthScheme	withDescription(String description)
AuthScheme	withName(String name)
AuthScheme	withParam(Param param)
AuthScheme	withParams(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 Details

AuthScheme

public AuthScheme()

Method Details

getUser

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

Throws:

ApiException

getName

public String getName()

withName

public AuthScheme withName(String name)

getDescription

public String getDescription()

withDescription

public AuthScheme withDescription(String description)

getType

public AuthScheme.AuthSchemeType getType()

withType

public AuthScheme withType(AuthScheme.AuthSchemeType type)

getParams

public List<Param> getParams()

withParams

public AuthScheme withParams(List<Param> params)

withParam

public AuthScheme withParam(Param param)