Package org.apache.solr.security

Class HttpServletAuthorizationContext

java.lang.Object

org.apache.solr.security.AuthorizationContext

org.apache.solr.security.HttpServletAuthorizationContext

public abstract class HttpServletAuthorizationContext
extends AuthorizationContext

An AuthorizationContext implementation that delegates many methods to an underlying HttpServletRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.security.AuthorizationContext

AuthorizationContext.CollectionRequest, AuthorizationContext.RequestType

Constructor Summary

Constructors

Constructor	Description
HttpServletAuthorizationContext(jakarta.servlet.http.HttpServletRequest servletRequest)

Method Summary

Modifier and Type	Method	Description
abstract List<AuthorizationContext.CollectionRequest>	getCollectionRequests()
abstract Object	getHandler()
Enumeration<String>	getHeaderNames()
String	getHttpHeader(String s)
String	getHttpMethod()
abstract org.apache.solr.common.params.SolrParams	getParams()
String	getRemoteAddr()
String	getRemoteHost()
abstract AuthorizationContext.RequestType	getRequestType()
String	getResource()
String	getUserName()	This method returns the name of the authenticated user for the current request.
Principal	getUserPrincipal()	This method returns the Principal corresponding to the authenticated user for the current request.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpServletAuthorizationContext

public HttpServletAuthorizationContext(jakarta.servlet.http.HttpServletRequest servletRequest)

Method Details

getParams

public abstract org.apache.solr.common.params.SolrParams getParams()

Specified by:

getParams in class AuthorizationContext

getCollectionRequests

public abstract List<AuthorizationContext.CollectionRequest> getCollectionRequests()

Specified by:

getCollectionRequests in class AuthorizationContext

getRequestType

public abstract AuthorizationContext.RequestType getRequestType()

Specified by:

getRequestType in class AuthorizationContext

getHandler

public abstract Object getHandler()

Specified by:

getHandler in class AuthorizationContext

getResource

public String getResource()

Specified by:

getResource in class AuthorizationContext

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in class AuthorizationContext

getUserPrincipal

public Principal getUserPrincipal()

Description copied from class: AuthorizationContext

This method returns the Principal corresponding to the authenticated user for the current request. The value returned by Principal.getName() depends on the authentication mechanism used. For example for the user "foo" with BASIC authentication the result would be "foo". The AuthorizationContext.getUserName() method may be preferred to extract the identity of the authenticated user instead of this method.

Specified by:

getUserPrincipal in class AuthorizationContext

Returns:

user principal in case of an authenticated request null in case of unauthenticated request

getUserName

public String getUserName()

Description copied from class: AuthorizationContext

This method returns the name of the authenticated user for the current request. The return value of this method is agnostic of the underlying authentication mechanism used.

Specified by:

getUserName in class AuthorizationContext

Returns:

username in case of an authenticated user null in case of unauthenticated request

getHttpHeader

public String getHttpHeader(String s)

Specified by:

getHttpHeader in class AuthorizationContext

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in class AuthorizationContext

getHttpMethod

public String getHttpMethod()

Specified by:

getHttpMethod in class AuthorizationContext

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in class AuthorizationContext