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 Description AuthXMLResponse(int requestType)CreatesAuthXMLResponseobject
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringcreateXMLErrorString()Returns error XML stringStringgetXMLForQueryInfo()Returns XML for query information.voidsetAuthContext(AuthContextLocal authContext)Sets the authentication context.voidsetAuthIdentifier(String authIdentifier)Sets the authentication identifier.voidsetAuthXMLRequest(AuthXMLRequest authXMLReq)voidsetErrorCode(String errorCode)Sets the error code.voidsetErrorMessage(String msg)Sets Error Message.voidsetErrorTemplate(String template)Sets Template.voidsetFailureURL(String failureURL)Sets the failure URL.voidsetIsException(boolean isException)Sets if exception was thrown.voidsetLoginStatus(AuthContext.Status loginStatus)Sets the login status.voidsetModuleNames(Set moduleNames)Sets the module names.voidsetOldSession(InternalSession aOldSession)Sets previous authentication context.voidsetRemoteRequest(jakarta.servlet.http.HttpServletRequest remoteReq)Sets the remote request on the XML responsevoidsetRemoteResponse(jakarta.servlet.http.HttpServletResponse remoteRes)Sets the remote response on the XML responsevoidsetReqdCallbacks(Callback[] reqdCallbacks)Sets the callbacks sent by module.voidsetSSOToken()SetsSSOTokenvoidsetValidSessionNoUpgrade(boolean aValidSessionNoUpgrade)Sets the attribute for valid session and no session upgrade in request.StringtoXMLString()Returns XML for the response based on the requested client information.
-
-
-
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(jakarta.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(jakarta.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-trueif 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()
SetsSSOToken
-
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)
-
-