Module org.apache.jena.arq

Package org.apache.jena.http.auth

Class AuthHeader

java.lang.Object

org.apache.jena.http.auth.AuthHeader

public class AuthHeader
extends Object

Parser for authentication header strings for both challenge and credentials.

• This parser is scheme-specific. e.g. digest credentials can not be token68.
• This parser does not check auth-params names.
• The auth-params map has lower case keys.

Covers:

• RFC 7617 - was RFC 7617 - basic authentication
• RFC 7616 - was RFC 617 - digest authentication
• RFC 6750 - Bearer authentication
• "Unknown"

Method Summary

Modifier and Type	Method	Description
static AuthHeader	bearerToken(String tokenString)	Create an AuthHeader for bearer with a token value.
String	getAuthArgs()	Get the string after the auth scheme as written in the authentication header value.
Map<String,String>	getAuthParams()	Any auth scheme value that has a=b auth-params, else null.
AuthScheme	getAuthScheme()	Get the AuthScheme.
String	getAuthSchemeName()	Get the auth scheme as written in the authentication header value.
String	getBasicUserPassword()	Return user-password (still base64 encoded) or null (if not basic auth)
String	getBearerToken()
String	getUnknown()	The rest of the line for "unknown"
boolean	isBasicAuth()	Is this basic auth?
boolean	isBearerAuth()	Is this Bearer auth?
boolean	isDigestAuth()	Is this Digest auth? The digest auth-params are available from getAuthParams()
boolean	isUnknownAuth()	Is this some unkown scheme? (not basic, digest or bearer).
static AuthHeader	parseAuth(String string)	Create an AuthHeader by parsing an "Authorization" header.
static AuthHeader	parseChallenge(String string)	Create an AuthHeader by parsing a "WWW-Authenticate" header.

Methods inherited from class java.lang.Object

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

Method Details

parseAuth

public static AuthHeader parseAuth(String string)

Create an AuthHeader by parsing an "Authorization" header.

parseChallenge

public static AuthHeader parseChallenge(String string)

Create an AuthHeader by parsing a "WWW-Authenticate" header.

bearerToken

public static AuthHeader bearerToken(String tokenString)

Create an AuthHeader for bearer with a token value.

getAuthScheme

public AuthScheme getAuthScheme()

Get the AuthScheme.

getAuthSchemeName

public String getAuthSchemeName()

Get the auth scheme as written in the authentication header value.

getAuthArgs

public String getAuthArgs()

Get the string after the auth scheme as written in the authentication header value.

getAuthParams

public Map<String,String> getAuthParams()

Any auth scheme value that has a=b auth-params, else null.

isBasicAuth

public boolean isBasicAuth()

Is this basic auth?

getBasicUserPassword

public String getBasicUserPassword()

Return user-password (still base64 encoded) or null (if not basic auth)

isDigestAuth

public boolean isDigestAuth()

Is this Digest auth? The digest auth-params are available from getAuthParams()

isBearerAuth

public boolean isBearerAuth()

Is this Bearer auth?

getBearerToken

public String getBearerToken()

isUnknownAuth

public boolean isUnknownAuth()

Is this some unkown scheme? (not basic, digest or bearer). The rest of the line is available from getUnknown().

getUnknown

public String getUnknown()

The rest of the line for "unknown"