Package com.sun.identity.authentication.spi

Class HttpCallback

java.lang.Object

com.sun.identity.authentication.spi.HttpCallback

All Implemented Interfaces:

Serializable, Callback

@Supported
public final class HttpCallback
extends Object
implements Callback, Serializable

HttpCallback class implements Callback and is used by the authentication module with HTTP protocol based handshaking negotiation.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpCallback.Builder	Builder object for the HttpCallback.

Constructor Summary

Constructors

Constructor	Description
HttpCallback(String authorizationHeader, String negotiationHeader, String errorCode)	Creates a HttpCallback object.
HttpCallback(String authRHeader, String negoName, String negoValue, int errorCode)	Creates a HttpCallback object.

Method Summary

Modifier and Type	Method	Description
static HttpCallback.Builder	builder()	Returns a new HttpCallback.Builder object to use for construction of a HttpCallback.
String	getAuthorization()	Returns the authorization string.
String	getAuthorizationHeader()	Returns the authorization header string.
int	getNegotiationCode()	Returns the negotiation error code.
String	getNegotiationHeaderName()	Returns the negotiation header name.
String	getNegotiationHeaderValue()	Returns the negotiation header value.
boolean	isForHTTPBasic()	Returns true if the callback is for HTTPBasic.
boolean	isForWindowsDesktopSSO()	Returns true if the callback is for WindowsDesktopSSO.
void	setAuthorization(String authorization)	Set the authorization string to a HttpCallback object.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpCallback

@Supported
public HttpCallback(String authorizationHeader,
 String negotiationHeader,
 String errorCode)

Creates a HttpCallback object.

Parameters:

authorizationHeader - Header name for the authorization string.

negotiationHeader - Negotiation header string.

errorCode - Error code set in the header for negotiation.

HttpCallback

@Supported
public HttpCallback(String authRHeader,
 String negoName,
 String negoValue,
 int errorCode)

Creates a HttpCallback object. The negotiation header is constructed using the negotiation name and value in the format negoName:negoValue.

Parameters:

authRHeader - Header name for the authorization string.

negoName - Negotiation name in the negotiation header.

negoValue - Negotiation value in the negotiation header.

errorCode - Error code set in the header for negotiation.

Method Details

getAuthorizationHeader

@Supported
public String getAuthorizationHeader()

Returns the authorization header string.

Returns:

the authorization header string.

getNegotiationHeaderName

@Supported
public String getNegotiationHeaderName()

Returns the negotiation header name.

Returns:

the negotiation header name.

getNegotiationHeaderValue

@Supported
public String getNegotiationHeaderValue()

Returns the negotiation header value.

Returns:

the negotiation header value.

getNegotiationCode

@Supported
public int getNegotiationCode()

Returns the negotiation error code.

Returns:

the negotiation error code.

getAuthorization

@Supported
public String getAuthorization()

Returns the authorization string.

Returns:

the authorization string.

setAuthorization

@Supported
public void setAuthorization(String authorization)

Set the authorization string to a HttpCallback object.

Parameters:

authorization - The value of the Authorization header.

isForHTTPBasic

@Supported
public boolean isForHTTPBasic()

Returns true if the callback is for HTTPBasic.

isForWindowsDesktopSSO

@Supported
public boolean isForWindowsDesktopSSO()

Returns true if the callback is for WindowsDesktopSSO.

builder

@Supported
public static HttpCallback.Builder builder()

Returns a new HttpCallback.Builder object to use for construction of a HttpCallback.

Returns:

a new HttpCallback.Builder object.