com.unboundid.directory.sdk.http.types
Interface AuthenticationRequest

All Known Implementing Classes:

UsernamePasswordAuthenticationRequest

@NotExtensible
public interface AuthenticationRequest

Represents a HTTP authentication request.

Method Summary

java.lang.Object	getCredentials() The credentials that prove the principal is correct.
javax.servlet.http.HttpServletRequest	getHttpServletRequest() The HttpServletRequest that initiated the authentication request.
java.lang.Object	getPrincipal() The identity of the principal being authenticated.

Method Detail

getPrincipal

java.lang.Object getPrincipal()

The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username.

Returns:

the Principal being authenticated

getCredentials

java.lang.Object getCredentials()

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the calling code.

Returns:

the credentials that prove the identity of the Principal

getHttpServletRequest

javax.servlet.http.HttpServletRequest getHttpServletRequest()

The HttpServletRequest that initiated the authentication request.

Returns:

The HttpServletRequest that initiated the authentication request, or null if not available.