Package org.nuclos.api.context

Interface AuthenticationContext

All Superinterfaces:
LogContext
public interface AuthenticationContext extends LogContext
AuthenticationContext represents the context used in an AuthenticationRule.authenticate(AuthenticationContext).

It contains information that can be used to authenticate a request.

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.ws.rs.core.HttpHeaders
    getHttpHeaders()
    Returns an injectable interface that provides access to HTTP header information.
    String
    getRemoteAddr()
    Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
    String
    getRemoteHost()
    Returns the fully qualified name of the client or the last proxy that sent the request.
    String
    getRemoteUser()
    Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
    String
    getSessionId()
    Returns a string containing the unique identifier assigned to this session.
    javax.ws.rs.core.UriInfo
    getUriInfo()
    Returns an injectable interface that provides access to application and request URI information.

    Methods inherited from interface org.nuclos.api.context.LogContext

    log, logError, logWarn

  • Method Details

    • getHttpHeaders

      javax.ws.rs.core.HttpHeaders getHttpHeaders()
      Returns an injectable interface that provides access to HTTP header information.
      Returns:
      all http headers from the request
      See Also:
      • HttpHeaders

    • getUriInfo

      javax.ws.rs.core.UriInfo getUriInfo()
      Returns an injectable interface that provides access to application and request URI information. Relative URIs are relative to the base URI of the application.
      Returns:
      the URI from the request
      See Also:
      • UriInfo.getBaseUri()

    • getSessionId

      String getSessionId()
      Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.
      Returns:
      a string specifying the identifier assigned to this session
      See Also:
      • HttpSession.getId()

    • getRemoteAddr

      String getRemoteAddr()
      Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
      Returns:
      a String containing the IP address of the client that sent the request
      See Also:
      • ServletRequest.getRemoteAddr()

    • getRemoteHost

      String getRemoteHost()
      Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.
      Returns:
      a String containing the fully qualified name of the client
      See Also:
      • ServletRequest.getRemoteHost()

    • getRemoteUser

      String getRemoteUser()
      Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.
      Returns:
      a String specifying the login of the user making this request, or null if the user login is not known
      See Also:
      • HttpServletRequest.getRemoteUser()