com.sun.identity.authentication.server

Class AuthXMLResponse

java.lang.Object

com.sun.identity.authentication.server.AuthXMLResponse

public class AuthXMLResponse
extends Object

AuthXMLResponse constructs the response XML string to return to the client.

Constructor Summary

Constructors

Constructor and Description
AuthXMLResponse(int requestType) Creates AuthXMLResponse object

Method Summary

Modifier and Type	Method and Description
String	createXMLErrorString() Returns error XML string
String	getXMLForQueryInfo() Returns XML for query information.
void	setAuthContext(AuthContextLocal authContext) Sets the authentication context.
void	setAuthIdentifier(String authIdentifier) Sets the authentication identifier.
void	setAuthXMLRequest(AuthXMLRequest authXMLReq)
void	setErrorCode(String errorCode) Sets the error code.
void	setErrorMessage(String msg) Sets Error Message.
void	setErrorTemplate(String template) Sets Template.
void	setFailureURL(String failureURL) Sets the failure URL.
void	setIsException(boolean isException) Sets if exception was thrown.
void	setLoginStatus(AuthContext.Status loginStatus) Sets the login status.
void	setModuleNames(Set moduleNames) Sets the module names.
void	setOldSession(InternalSession aOldSession) Sets previous authentication context.
void	setRemoteRequest(javax.servlet.http.HttpServletRequest remoteReq) Sets the remote request on the XML response
void	setRemoteResponse(javax.servlet.http.HttpServletResponse remoteRes) Sets the remote response on the XML response
void	setReqdCallbacks(Callback[] reqdCallbacks) Sets the callbacks sent by module.
void	setSSOToken() Sets SSOToken
void	setValidSessionNoUpgrade(boolean aValidSessionNoUpgrade) Sets the attribute for valid session and no session upgrade in request.
String	toXMLString() Returns XML for the response based on the requested client information.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthXMLResponse

public AuthXMLResponse(int requestType)

Creates AuthXMLResponse object

Parameters:

requestType - id of request type

Method Detail

setErrorCode

public void setErrorCode(String errorCode)

Sets the error code.

Parameters:

errorCode - Error Code.

setErrorMessage

public void setErrorMessage(String msg)

Sets Error Message.

Parameters:

msg - Error Message.

setErrorTemplate

public void setErrorTemplate(String template)

Sets Template.

Parameters:

template - Template.

setFailureURL

public void setFailureURL(String failureURL)

Sets the failure URL.

Parameters:

failureURL - Failure URL.

setLoginStatus

public void setLoginStatus(AuthContext.Status loginStatus)

Sets the login status.

Parameters:

loginStatus - Login Status.

setReqdCallbacks

public void setReqdCallbacks(Callback[] reqdCallbacks)

Sets the callbacks sent by module.

Parameters:

reqdCallbacks - Array of Request Callbacks.

setRemoteRequest

public void setRemoteRequest(javax.servlet.http.HttpServletRequest remoteReq)

Sets the remote request on the XML response

Parameters:

remoteReq - The Http Servlet Request to be set

setRemoteResponse

public void setRemoteResponse(javax.servlet.http.HttpServletResponse remoteRes)

Sets the remote response on the XML response

Parameters:

remoteRes - The Http Servlet Response to be set

createXMLErrorString

public String createXMLErrorString()

Returns error XML string

Returns:

error XML string

toXMLString

public String toXMLString()

Returns XML for the response based on the requested client information.

Returns:

XML for the response based on the requested client information.

setAuthContext

public void setAuthContext(AuthContextLocal authContext)

Sets the authentication context.

Parameters:

authContext - Authentication Context.

setIsException

public void setIsException(boolean isException)

Sets if exception was thrown.

Parameters:

isException - true if exception was thrown.

setAuthIdentifier

public void setAuthIdentifier(String authIdentifier)

Sets the authentication identifier.

Parameters:

authIdentifier - Authentication identifier.

setModuleNames

public void setModuleNames(Set moduleNames)

Sets the module names.

Parameters:

moduleNames - Module Names.

getXMLForQueryInfo

public String getXMLForQueryInfo()

Returns XML for query information.

Returns:

XML for query information.

setSSOToken

public void setSSOToken()

Sets SSOToken

setOldSession

public void setOldSession(InternalSession aOldSession)

Sets previous authentication context.

Parameters:

aOldSession - previous Internal Session

setValidSessionNoUpgrade

public void setValidSessionNoUpgrade(boolean aValidSessionNoUpgrade)

Sets the attribute for valid session and no session upgrade in request.

Parameters:

aValidSessionNoUpgrade - Session is valid no upgrade needed

setAuthXMLRequest

public void setAuthXMLRequest(AuthXMLRequest authXMLReq)