Index (Apache Hadoop Auth 0.23.11 API)

A C D E G H I K N O P S T U V W

A

ANONYMOUS - Static variable in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Constant that identifies an anonymous request.
ANONYMOUS_ALLOWED - Static variable in class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler: Constant for the configuration property that indicates if anonymous users are allowed.
AUTH_COOKIE - Static variable in class org.apache.hadoop.security.authentication.client.AuthenticatedURL: Name of the HTTP cookie used for the authentication token between the client and the server.
AUTH_TOKEN_VALIDITY - Static variable in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Constant for the configuration property that indicates the validity of the generated token.
AUTH_TYPE - Static variable in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Constant for the property that specifies the authentication handler to use.
authenticate(URL, AuthenticatedURL.Token) - Method in interface org.apache.hadoop.security.authentication.client.Authenticator: Authenticates against a URL and returns a AuthenticatedURL.Token to be used by subsequent requests.
authenticate(URL, AuthenticatedURL.Token) - Method in class org.apache.hadoop.security.authentication.client.KerberosAuthenticator: Performs SPNEGO authentication against the specified URL.
authenticate(URL, AuthenticatedURL.Token) - Method in class org.apache.hadoop.security.authentication.client.PseudoAuthenticator: Performs simple authentication against the specified URL.
authenticate(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler: Performs an authentication step for the given HTTP client request.
authenticate(HttpServletRequest, HttpServletResponse) - Method in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: It enforces the the Kerberos SPNEGO authentication sequence returning an AuthenticationToken only after the Kerberos SPNEGO sequence has completed successfully.
authenticate(HttpServletRequest, HttpServletResponse) - Method in class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler: Authenticates an HTTP client request.
AuthenticatedURL - Class in org.apache.hadoop.security.authentication.client: The AuthenticatedURL class enables the use of the JDK URL class against HTTP endpoints protected with the AuthenticationFilter.
AuthenticatedURL() - Constructor for class org.apache.hadoop.security.authentication.client.AuthenticatedURL: Creates an AuthenticatedURL.
AuthenticatedURL(Authenticator) - Constructor for class org.apache.hadoop.security.authentication.client.AuthenticatedURL: Creates an AuthenticatedURL.
AuthenticatedURL.Token - Class in org.apache.hadoop.security.authentication.client: Client side authentication token.
AuthenticatedURL.Token() - Constructor for class org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token: Creates a token.
AuthenticatedURL.Token(String) - Constructor for class org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token: Creates a token using an existing string representation of the token.
AuthenticationException - Exception in org.apache.hadoop.security.authentication.client: Exception thrown when an authentication error occurrs.
AuthenticationException(Throwable) - Constructor for exception org.apache.hadoop.security.authentication.client.AuthenticationException: Creates an AuthenticationException.
AuthenticationException(String) - Constructor for exception org.apache.hadoop.security.authentication.client.AuthenticationException: Creates an AuthenticationException.
AuthenticationException(String, Throwable) - Constructor for exception org.apache.hadoop.security.authentication.client.AuthenticationException: Creates an AuthenticationException.
AuthenticationFilter - Class in org.apache.hadoop.security.authentication.server: The AuthenticationFilter enables protecting web application resources with different (pluggable) authentication mechanisms.
AuthenticationFilter() - Constructor for class org.apache.hadoop.security.authentication.server.AuthenticationFilter
AuthenticationHandler - Interface in org.apache.hadoop.security.authentication.server: Interface for server authentication mechanisms.
AuthenticationToken - Class in org.apache.hadoop.security.authentication.server: The AuthenticationToken contains information about an authenticated HTTP client and doubles as the Principal to be returned by authenticated HttpServletRequests
The token can be serialized/deserialized to and from a string as it is sent and received in HTTP client responses and requests as a HTTP cookie (this is done by the AuthenticationFilter).
AuthenticationToken(String, String, String) - Constructor for class org.apache.hadoop.security.authentication.server.AuthenticationToken: Creates an authentication token.
Authenticator - Interface in org.apache.hadoop.security.authentication.client: Interface for client authentication mechanisms.
AUTHORIZATION - Static variable in class org.apache.hadoop.security.authentication.client.KerberosAuthenticator: HTTP header used by the SPNEGO client endpoint during an authentication sequence.

C

computeSignature(String) - Method in class org.apache.hadoop.security.authentication.util.Signer: Returns then signature of a string.
CONFIG_PREFIX - Static variable in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Constant for the property that specifies the configuration prefix.
COOKIE_DOMAIN - Static variable in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Constant for the configuration property that indicates the domain to use in the HTTP cookie.
COOKIE_PATH - Static variable in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Constant for the configuration property that indicates the path to use in the HTTP cookie.
createCookie(String) - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Creates the Hadoop authentiation HTTP cookie.

D

destroy() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Destroys the filter.
destroy() - Method in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler: Destroys the authentication handler instance.
destroy() - Method in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Releases any resources initialized by the authentication handler.
destroy() - Method in class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler: Releases any resources initialized by the authentication handler.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: If the request has a valid authentication token it allows the request to continue to the target resource, otherwise it triggers an authentication sequence using the configured AuthenticationHandler.

E

equals(Object) - Method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token: Return if two token instances are equal.
extractToken(HttpURLConnection, AuthenticatedURL.Token) - Static method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL: Helper method that extracts an authentication token received from a connection.

G

getAcceptAnonymous() - Method in class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler: Returns if the handler is configured to support anonymous users.
getAuthenticationHandler() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Returns the authentication handler being used.
getConfiguration(String, FilterConfig) - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Returns the filtered configuration (only properties starting with the specified prefix).
getCookieDomain() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Returns the cookie domain to use for the HTTP cookie.
getCookiePath() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Returns the cookie path to use for the HTTP cookie.
getDefaultAuthenticator() - Static method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL: Returns the default Authenticator class to use when an AuthenticatedURL instance is created without specifying an authenticator.
getDefaultRealm() - Method in class org.apache.hadoop.security.authentication.util.KerberosName: Get the configured default realm.
getDefaultRealm() - Static method in class org.apache.hadoop.security.authentication.util.KerberosUtil
getExpires() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Returns the expiration time of the token.
getFallBackAuthenticator() - Method in class org.apache.hadoop.security.authentication.client.KerberosAuthenticator: If the specified URL does not support SPNEGO authentication, a fallback Authenticator will be used.
getHostName() - Method in class org.apache.hadoop.security.authentication.util.KerberosName: Get the second component of the name.
getKeytab() - Method in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Returns the keytab used by the authentication handler.
getKrb5LoginModuleName() - Static method in class org.apache.hadoop.security.authentication.util.KerberosUtil
getName() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Returns the principal name (this method name comes from the JDK Principal interface).
getOidInstance(String) - Static method in class org.apache.hadoop.security.authentication.util.KerberosUtil
getPrincipal() - Method in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Returns the Kerberos principal used by the authentication handler.
getRealm() - Method in class org.apache.hadoop.security.authentication.util.KerberosName: Get the realm of the name.
getRequestURL(HttpServletRequest) - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Returns the full URL of the request including the query string.
getServiceName() - Method in class org.apache.hadoop.security.authentication.util.KerberosName: Get the first component of the name.
getServicePrincipal(String, String) - Static method in class org.apache.hadoop.security.authentication.util.KerberosUtil: Create Kerberos principal for a given service and hostname.
getShortName() - Method in class org.apache.hadoop.security.authentication.util.KerberosName: Get the translation of the principal name into an operating system user name.
getToken(HttpServletRequest) - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Returns the AuthenticationToken for the request.
getType() - Method in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler: Returns the authentication type of the authentication handler.
getType() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Returns the authentication mechanism of the token.
getType() - Method in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Returns the authentication type of the authentication handler, 'kerberos'.
getType() - Method in class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler: Returns the authentication type of the authentication handler, 'simple'.
getUserName() - Method in class org.apache.hadoop.security.authentication.client.PseudoAuthenticator: Returns the current user name.
getUserName() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Returns the user name.
getValidity() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Returns the validity time of the generated tokens.

H

hashCode() - Method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token: Return the hashcode for the token.
hasRulesBeenSet() - Static method in class org.apache.hadoop.security.authentication.util.KerberosName: Indicates if the name rules have been set.

I

init(FilterConfig) - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Initializes the authentication filter.
init(Properties) - Method in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler: Initializes the authentication handler instance.
init(Properties) - Method in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Initializes the authentication handler instance.
init(Properties) - Method in class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler: Initializes the authentication handler instance.
injectToken(HttpURLConnection, AuthenticatedURL.Token) - Static method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL: Helper method that injects an authentication token to send with a connection.
isExpired() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Returns if the token has expired.
isRandomSecret() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Returns if a random secret is being used.
isSet() - Method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token: Returns if a token from the server has been set.

K

KerberosAuthenticationHandler - Class in org.apache.hadoop.security.authentication.server: The KerberosAuthenticationHandler implements the Kerberos SPNEGO authentication mechanism for HTTP.
KerberosAuthenticationHandler() - Constructor for class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler
KerberosAuthenticator - Class in org.apache.hadoop.security.authentication.client: The KerberosAuthenticator implements the Kerberos SPNEGO authentication sequence.
KerberosAuthenticator() - Constructor for class org.apache.hadoop.security.authentication.client.KerberosAuthenticator
KerberosName - Class in org.apache.hadoop.security.authentication.util: This class implements parsing and handling of Kerberos principal names.
KerberosName(String) - Constructor for class org.apache.hadoop.security.authentication.util.KerberosName: Create a name from the full Kerberos principal name.
KerberosName.BadFormatString - Exception in org.apache.hadoop.security.authentication.util
KerberosName.NoMatchingRule - Exception in org.apache.hadoop.security.authentication.util
KerberosUtil - Class in org.apache.hadoop.security.authentication.util
KerberosUtil() - Constructor for class org.apache.hadoop.security.authentication.util.KerberosUtil
KEYTAB - Static variable in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Constant for the configuration property that indicates the keytab file path.

N

NAME_RULES - Static variable in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Constant for the configuration property that indicates the Kerberos name rules for the Kerberos principals.
NEGOTIATE - Static variable in class org.apache.hadoop.security.authentication.client.KerberosAuthenticator: HTTP header prefix used by the SPNEGO client/server endpoints during an authentication sequence.

O

openConnection(URL, AuthenticatedURL.Token) - Method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL: Returns an authenticated HttpURLConnection.
org.apache.hadoop.security.authentication.client - package org.apache.hadoop.security.authentication.client
org.apache.hadoop.security.authentication.server - package org.apache.hadoop.security.authentication.server
org.apache.hadoop.security.authentication.util - package org.apache.hadoop.security.authentication.util

P

parse(String) - Static method in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Parses a string into an authentication token.
PRINCIPAL - Static variable in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Constant for the configuration property that indicates the kerberos principal.
PseudoAuthenticationHandler - Class in org.apache.hadoop.security.authentication.server: The PseudoAuthenticationHandler provides a pseudo authentication mechanism that accepts the user name specified as a query string parameter.
PseudoAuthenticationHandler() - Constructor for class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler
PseudoAuthenticator - Class in org.apache.hadoop.security.authentication.client: The PseudoAuthenticator implementation provides an authentication equivalent to Hadoop's Simple authentication, it trusts the value of the 'user.name' Java System property.
PseudoAuthenticator() - Constructor for class org.apache.hadoop.security.authentication.client.PseudoAuthenticator

S

setDefaultAuthenticator(Class<? extends Authenticator>) - Static method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL: Sets the default Authenticator class to use when an AuthenticatedURL instance is created without specifying an authenticator.
setExpires(long) - Method in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Sets the expiration of the token.
setRules(String) - Static method in class org.apache.hadoop.security.authentication.util.KerberosName: Set the rules.
sign(String) - Method in class org.apache.hadoop.security.authentication.util.Signer: Returns a signed string.
SIGNATURE_SECRET - Static variable in class org.apache.hadoop.security.authentication.server.AuthenticationFilter: Constant for the property that specifies the secret to use for signing the HTTP Cookies.
Signer - Class in org.apache.hadoop.security.authentication.util: Signs strings and verifies signed strings using a SHA digest.
Signer(byte[]) - Constructor for class org.apache.hadoop.security.authentication.util.Signer: Creates a Signer instance using the specified secret.
SignerException - Exception in org.apache.hadoop.security.authentication.util: Exception thrown by Signer when a string signature is invalid.
SignerException(String) - Constructor for exception org.apache.hadoop.security.authentication.util.SignerException: Creates an exception instance.

T

toString() - Method in class org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token: Returns the string representation of the token.
toString() - Method in class org.apache.hadoop.security.authentication.server.AuthenticationToken: Returns the string representation of the token.
toString() - Method in class org.apache.hadoop.security.authentication.util.KerberosName: Put the name back together from the parts.
TYPE - Static variable in class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler: Constant that identifies the authentication mechanism.
TYPE - Static variable in class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler: Constant that identifies the authentication mechanism.

U

USER_NAME - Static variable in class org.apache.hadoop.security.authentication.client.PseudoAuthenticator: Name of the additional parameter that carries the 'user.name' value.

V

verifyAndExtract(String) - Method in class org.apache.hadoop.security.authentication.util.Signer: Verifies a signed string and extracts the original string.

W

WWW_AUTHENTICATE - Static variable in class org.apache.hadoop.security.authentication.client.KerberosAuthenticator: HTTP header used by the SPNEGO server endpoint during an authentication sequence.

A C D E G H I K N O P S T U V W