Package org.yamcs.security

Class AbstractHttpRequestAuthModule

java.lang.Object

org.yamcs.security.AbstractHttpRequestAuthModule

All Implemented Interfaces:

AuthModule

Direct Known Subclasses:

ApiKeyAuthModule, IPAddressAuthModule, RemoteUserAuthModule

public abstract class AbstractHttpRequestAuthModule
extends Object
implements AuthModule

Base class for an AuthModule that identifies users based on an incoming HTTP request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractHttpRequestAuthModule.HttpRequestToken	Data holder for passing an HttpRequest to a login call.

Constructor Summary

Constructors

Constructor	Description
AbstractHttpRequestAuthModule()

Method Summary

Modifier and Type	Method	Description
abstract AuthenticationInfo	getAuthenticationInfo(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest request)
AuthenticationInfo	getAuthenticationInfo(AuthenticationToken token)	Identify the subject based on the given information.
abstract boolean	handles(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest request)	Returns true if this AuthModule is capable of handling the given HTTP request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.security.AuthModule

authenticationSucceeded, getAuthorizationInfo, getSpec, init, verifyValidity

Constructor Details

AbstractHttpRequestAuthModule

public AbstractHttpRequestAuthModule()

Method Details

handles

public abstract boolean handles(io.netty.channel.ChannelHandlerContext ctx,
 io.netty.handler.codec.http.HttpRequest request)

Returns true if this AuthModule is capable of handling the given HTTP request.

getAuthenticationInfo

public AuthenticationInfo getAuthenticationInfo(AuthenticationToken token)
                                         throws AuthenticationException

Description copied from interface: AuthModule

Identify the subject based on the given information.

Specified by:

getAuthenticationInfo in interface AuthModule

Returns:

an info object containing the principal of the subject, or null if the login failed

Throws:

AuthenticationException

getAuthenticationInfo

public abstract AuthenticationInfo getAuthenticationInfo(io.netty.channel.ChannelHandlerContext ctx,
 io.netty.handler.codec.http.HttpRequest request)
                                                  throws AuthenticationException

Throws:

AuthenticationException