AuthXMLRequest (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.authentication.server.AuthXMLRequest

public class AuthXMLRequest
extends Object

The AuthXMLRequest represents the AuthRequest XML document. The table shows the Request and the possible Responses for each Request:

 Request                 Response
 ----------------------------------------------------------------------
 NewAuthContext          LoginStatus or Exception
 QueryInformation        QueryResult or Exception
 Login                   GetRequirements or LoginStatus or Exception
 SubmitRequirements      GetRequirements or LoginStatus or Exception
 Logout                  LoginStatus or Exception
 Abort                   LoginStatus or Exception

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`Abort` Constant of Authentication request for abort
`static int`	`Login` Constant of Authentication request for login
`static int`	`LoginIndex` Constant of Authentication request for login index
`static int`	`LoginPrincipal` Constant of Authentication request for login principal
`static int`	`LoginSubject` Constant of Authentication request for login subject
`static int`	`Logout` Constant of Authentication request for logout
`static int`	`NewAuthContext` Constant of Authentication request for new AuthContext
`static int`	`QueryInformation` Constant of Authentication request for query information
`static int`	`SubmitRequirements` Constant of Authentication request for submit auth requirements

Constructor Summary

Constructors
Constructor and Description

AuthXMLRequest()

Constructors
Constructor and Description
`AuthXMLRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAppSSOTokenID()` Returns the Application SSO Token id as set by `setAppSSOTokenID`
`AuthContextLocal`	`getAuthContext()` Returns the authentication context for this request.
`String`	`getAuthIdentifier()` Returns the authentication Identifier - session ID
`javax.servlet.http.HttpServletRequest`	`getClientRequest()` Gets the client request
`javax.servlet.http.HttpServletResponse`	`getClientResponse()` Gets the client response
`List`	`getEnvironment()` Returns the environment setting for the request.
`String`	`getForceAuth()` Returns the force auth flag.
`String`	`getHostName()` Returns the host name.
`javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()` Returns the servlet request.
`String`	`getIndexName()` Returns the index name.
`AuthContext.IndexType`	`getIndexType()` Returns the index type.
`String`	`getLocale()` Returns the locale.
`String`	`getOrgName()` Returns the organization name.
`String`	`getParams()` Returns the request parameters.
`char[]`	`getPassword()` Returns the password.
`Principal`	`getPrincipal()` Returns the principal.
`int`	`getRequestType()` Returns the request type.
`Subject`	`getSubject()` Returns the subject.
`Callback[]`	`getSubmittedCallbacks()` Returns the callbacks set by client.
`boolean`	`getValidSessionNoUpgrade()` Returns the attribute for valid session and no session upgrade in request.
`static AuthXMLRequest`	`parseXML(String xml, javax.servlet.http.HttpServletRequest req)` This method is used primarily at the server side to reconstruct a `AuthXMLRequest` object based on the XML document received from client.
`void`	`setAppSSOTokenID(String appSSOTokenID)` Sets the Application SSO Token id as received in PLL request
`void`	`setAuthContext(AuthContextLocal authContext)` Sets the authentication context for this request.
`void`	`setAuthIdentifier(String authIdentifier)` Sets the `authIdentifier` - session ID
`void`	`setClientRequest(javax.servlet.http.HttpServletRequest request)` Sets the client request
`void`	`setClientResponse(javax.servlet.http.HttpServletResponse response)` Sets the client response
`void`	`setEnvironment(List env)` Sets the environment for the request.
`void`	`setForceAuth(String aForceAuth)` Sets the Force Auth attribute.
`void`	`setHostName(String hostName)` Sets the host name.
`void`	`setHttpServletRequest(javax.servlet.http.HttpServletRequest servletRequest)` Sets the servlet request.
`void`	`setIndexName(String indexName)` Sets the index name.
`void`	`setIndexType(String strIndexType)` Sets the index Type.
`void`	`setLocale(String locale)` Sets the locale
`void`	`setOrgName(String orgName)` Sets the organization name.
`void`	`setParams(String params)` Sets the request parameters.
`void`	`setPassword(String password)` Sets the password.
`void`	`setPrincipal(String className, String principalValue)` sets the principal for the class
`void`	`setRequestInformation(String requestInfo)` Sets the `requestinfo` - `moduleInstances`.
`void`	`setRequestType(int i)` Sets the request type.
`void`	`setRequestVersion(String version)` Sets the request version.
`void`	`setSubject(Subject subject)` Sets the subject.
`void`	`setSubmittedCallbacks(Callback[] submittedCallbacks)` Sets the submitted callbacks.
`void`	`setValidSessionNoUpgrade(boolean aValidSessionNoUpgrade)` Sets the attribute for valid session and no session upgrade in request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NewAuthContext
```
public static final int NewAuthContext
```
    Constant of Authentication request for new AuthContext
    
    See Also:
    
    Constant Field Values
  - Login
```
public static final int Login
```
    Constant of Authentication request for login
    
    See Also:
    
    Constant Field Values
  - SubmitRequirements
```
public static final int SubmitRequirements
```
    Constant of Authentication request for submit auth requirements
    
    See Also:
    
    Constant Field Values
  - QueryInformation
```
public static final int QueryInformation
```
    Constant of Authentication request for query information
    
    See Also:
    
    Constant Field Values
  - Logout
```
public static final int Logout
```
    Constant of Authentication request for logout
    
    See Also:
    
    Constant Field Values
  - Abort
```
public static final int Abort
```
    Constant of Authentication request for abort
    
    See Also:
    
    Constant Field Values
  - LoginIndex
```
public static final int LoginIndex
```
    Constant of Authentication request for login index
    
    See Also:
    
    Constant Field Values
  - LoginPrincipal
```
public static final int LoginPrincipal
```
    Constant of Authentication request for login principal
    
    See Also:
    
    Constant Field Values
  - LoginSubject
```
public static final int LoginSubject
```
    Constant of Authentication request for login subject
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AuthXMLRequest
```
public AuthXMLRequest()
```
- Method Detail
  - parseXML
```
public static AuthXMLRequest parseXML(String xml,
                                      javax.servlet.http.HttpServletRequest req)
                               throws AuthException
```
    This method is used primarily at the server side to reconstruct a AuthXMLRequest object based on the XML document received from client. The DTD of this XML document is described above.
    
    Parameters:
    
    xml - The AuthXMLRequest XML.
    
    req - HTTP Servlet Request.
    
    Returns:
    
    AuthXMLRequest if xml parsed without problem.
    
    Throws:
    
    AuthException - if xml parsed with problem.
  - setRequestType
```
public void setRequestType(int i)
```
    Sets the request type.
    
    Parameters:
    
    i - Request type.
  - setRequestVersion
```
public void setRequestVersion(String version)
```
    Sets the request version.
    
    Parameters:
    
    version - Version.
  - setAuthIdentifier
```
public void setAuthIdentifier(String authIdentifier)
```
    Sets the authIdentifier - session ID
    
    Parameters:
    
    authIdentifier -
  - setAppSSOTokenID
```
public void setAppSSOTokenID(String appSSOTokenID)
```
    Sets the Application SSO Token id as received in PLL request
    
    Parameters:
    
    appSSOTokenID - Application SSOToken Id.
  - setOrgName
```
public void setOrgName(String orgName)
```
    Sets the organization name.
    
    Parameters:
    
    orgName - Organization Name.
  - setHostName
```
public void setHostName(String hostName)
```
    Sets the host name.
    
    Parameters:
    
    hostName - Host Name.
  - setForceAuth
```
public void setForceAuth(String aForceAuth)
```
    Sets the Force Auth attribute.
    
    Parameters:
    
    aForceAuth - Force Auth flag.
  - 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.
  - setRequestInformation
```
public void setRequestInformation(String requestInfo)
```
    Sets the requestinfo - moduleInstances.
    
    Parameters:
    
    requestInfo - Request Information.
  - setIndexType
```
public void setIndexType(String strIndexType)
```
    Sets the index Type.
    
    Parameters:
    
    strIndexType -
  - setLocale
```
public void setLocale(String locale)
```
    Sets the locale
    
    Parameters:
    
    locale - locale setting.
  - setIndexName
```
public void setIndexName(String indexName)
```
    Sets the index name.
    
    Parameters:
    
    indexName - Index Name.
  - setPrincipal
```
public void setPrincipal(String className,
                         String principalValue)
```
    sets the principal for the class
    
    Parameters:
    
    className - will have the principal.
    
    principalValue - will be set for the class.
  - setPassword
```
public void setPassword(String password)
```
    Sets the password.
    
    Parameters:
    
    password - Password.
  - setSubmittedCallbacks
```
public void setSubmittedCallbacks(Callback[] submittedCallbacks)
```
    Sets the submitted callbacks.
    
    Parameters:
    
    submittedCallbacks - Submitted callbacks.
  - setClientRequest
```
public void setClientRequest(javax.servlet.http.HttpServletRequest request)
```
    Sets the client request
    
    Parameters:
    
    request - The client Http Servlet Request
  - setClientResponse
```
public void setClientResponse(javax.servlet.http.HttpServletResponse response)
```
    Sets the client response
    
    Parameters:
    
    response - The client Http Servlet Response
  - getClientRequest
```
public javax.servlet.http.HttpServletRequest getClientRequest()
```
    Gets the client request
    
    Returns:
    
    The client Http Servlet Request
  - getClientResponse
```
public javax.servlet.http.HttpServletResponse getClientResponse()
```
    Gets the client response
    
    Returns:
    
    The client Http Servlet Response
  - getRequestType
```
public int getRequestType()
```
    Returns the request type.
    
    Returns:
    
    the request type.
  - getOrgName
```
public String getOrgName()
```
    Returns the organization name.
    
    Returns:
    
    the organization name.
  - getHostName
```
public String getHostName()
```
    Returns the host name.
    
    Returns:
    
    the host name.
  - getForceAuth
```
public String getForceAuth()
```
    Returns the force auth flag.
    
    Returns:
    
    the force auth flag.
  - getValidSessionNoUpgrade
```
public boolean getValidSessionNoUpgrade()
```
    Returns the attribute for valid session and no session upgrade in request.
    
    Returns:
    
    aValidSessionNoUpgrade.
  - getAuthIdentifier
```
public String getAuthIdentifier()
```
    Returns the authentication Identifier - session ID
    
    Returns:
    
    authentication identifier.
  - getAppSSOTokenID
```
public String getAppSSOTokenID()
```
    Returns the Application SSO Token id as set by setAppSSOTokenID
    
    Returns:
    
    Application SSO Token id
  - getSubmittedCallbacks
```
public Callback[] getSubmittedCallbacks()
```
    Returns the callbacks set by client.
    
    Returns:
    
    the callbacks set by client.
  - getIndexType
```
public AuthContext.IndexType getIndexType()
```
    Returns the index type.
    
    Returns:
    
    the index type.
  - getLocale
```
public String getLocale()
```
    Returns the locale.
    
    Returns:
    
    the locale.
  - getIndexName
```
public String getIndexName()
```
    Returns the index name.
    
    Returns:
    
    the index name.
  - getPrincipal
```
public Principal getPrincipal()
```
    Returns the principal.
    
    Returns:
    
    the principal.
  - getPassword
```
public char[] getPassword()
```
    Returns the password.
    
    Returns:
    
    the password.
  - getSubject
```
public Subject getSubject()
```
    Returns the subject.
    
    Returns:
    
    the subject.
  - setAuthContext
```
public void setAuthContext(AuthContextLocal authContext)
```
    Sets the authentication context for this request.
    
    Parameters:
    
    authContext - Authentication context for this request.
  - getAuthContext
```
public AuthContextLocal getAuthContext()
```
    Returns the authentication context for this request.
    
    Returns:
    
    the authentication context for this request.
  - setSubject
```
public void setSubject(Subject subject)
```
    Sets the subject.
    
    Parameters:
    
    subject - Subject.
  - setHttpServletRequest
```
public void setHttpServletRequest(javax.servlet.http.HttpServletRequest servletRequest)
```
    Sets the servlet request.
    
    Parameters:
    
    servletRequest - Servlet request.
  - getHttpServletRequest
```
public javax.servlet.http.HttpServletRequest getHttpServletRequest()
```
    Returns the servlet request.
    
    Returns:
    
    the servlet request.
  - setParams
```
public void setParams(String params)
```
    Sets the request parameters.
    
    Parameters:
    
    params - will be set for the request.
  - getParams
```
public String getParams()
```
    Returns the request parameters.
    
    Returns:
    
    the request parameters.
  - setEnvironment
```
public void setEnvironment(List env)
```
    Sets the environment for the request.
    
    Parameters:
    
    env - environment to be set for the request.
  - getEnvironment
```
public List getEnvironment()
```
    Returns the environment setting for the request.
    
    Returns:
    
    the environment setting for the request.

Class AuthXMLRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NewAuthContext

Login

SubmitRequirements

QueryInformation

Logout

Abort

LoginIndex

LoginPrincipal

LoginSubject

Constructor Detail

AuthXMLRequest

Method Detail

parseXML

setRequestType

setRequestVersion

setAuthIdentifier

setAppSSOTokenID

setOrgName

setHostName

setForceAuth

setValidSessionNoUpgrade

setRequestInformation

setIndexType

setLocale

setIndexName

setPrincipal

setPassword

setSubmittedCallbacks

setClientRequest

setClientResponse

getClientRequest

getClientResponse

getRequestType

getOrgName

getHostName

getForceAuth

getValidSessionNoUpgrade

getAuthIdentifier

getAppSSOTokenID

getSubmittedCallbacks

getIndexType

getLocale

getIndexName

getPrincipal

getPassword

getSubject

setAuthContext

getAuthContext

setSubject

setHttpServletRequest

getHttpServletRequest

setParams

getParams

setEnvironment

getEnvironment