| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.sun.identity.liberty.ws.interaction.InteractionManager
This class provides the interface and implementation for supporting 
  resource owner interaction.  WSC and WSP would
  collaborate with the singleton object instance of this class to provide
  and use resource owner interaction.
| Field Summary | |
| static java.lang.String | IDPName of URL query parameter to be used by WSCto includeproviderIDofIDP, that was used to
 authenticate user. | 
| static java.lang.String | INTERACTION_NAMESPACEName space URI of interaction service | 
| static java.lang.String | REQUEST_IDName of suggested URL query parameter to be used by WSCto include an ID to refer to request message that led to user agent
 redirect. | 
| static java.lang.String | RESEND_MESSAGEName of URL query parameter to be used by WSPto include 
 an ID to indicate that user agent is redirected back toWSCfromWSP | 
| static java.lang.String | RETURN_TO_URLName of URL query parameter to be used by WSCto includereturnToURL, while redirecting user agent toWSP. | 
| Constructor Summary | |
| InteractionManager() | |
| Method Summary | |
| static InteractionManager | getInstance()Gets singleton object instance of InteractionManager | 
|  com.sun.identity.liberty.ws.interaction.jaxb.InteractionResponseElement | getInteractionResponseElement(Message requestMessage)Gets interaction response that was gathered from resource owner by InteractionManager | 
|  Message | handleInteraction(Message requestMessage,
                  com.sun.identity.liberty.ws.interaction.jaxb.InquiryElement inquiryElement,
                  java.lang.String language)Handles resource owner interactions on behalf of WSP. | 
|  Message | resendRequest(java.lang.String returnToURL,
              javax.servlet.http.HttpServletRequest httpRequest,
              javax.servlet.http.HttpServletResponse httpResponse)Resends a previously cached SOAP request message to WSP. | 
|  Message | resendRequest(java.lang.String returnToURL,
              javax.servlet.http.HttpServletRequest httpRequest,
              javax.servlet.http.HttpServletResponse httpResponse,
              Message requestMessage)Resends a SOAP request message to WSP. | 
|  Message | sendRequest(Message requestMessage,
            java.lang.String connectTo,
            java.lang.String certAlias,
            java.lang.String soapAction,
            java.lang.String returnToURL,
            javax.servlet.http.HttpServletRequest httpRequest,
            javax.servlet.http.HttpServletResponse httpResponse)Sends SOAP request to WSP. | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
public static final java.lang.String RETURN_TO_URL
WSC to include
 returnToURL, while redirecting user agent to
 WSP.public static final java.lang.String REQUEST_ID
WSC
 to include an ID to refer to request message that led to user agent
 redirect.public static final java.lang.String IDP
WSC to include 
 providerID of IDP, that was used to
 authenticate user.public static final java.lang.String RESEND_MESSAGE
WSP to include 
 an ID to indicate that user agent is redirected back to
 WSC from WSPpublic static final java.lang.String INTERACTION_NAMESPACE
| Constructor Detail | 
public InteractionManager()
| Method Detail | 
public static InteractionManager getInstance()
InteractionManagerInteractionManager
public Message sendRequest(Message requestMessage,
                           java.lang.String connectTo,
                           java.lang.String certAlias,
                           java.lang.String soapAction,
                           java.lang.String returnToURL,
                           javax.servlet.http.HttpServletRequest httpRequest,
                           javax.servlet.http.HttpServletResponse httpResponse)
                    throws InteractionException,
                           InteractionRedirectException,
                           SOAPBindingException,
                           SOAPFaultException
WSP.  
 This would be invoked at WSC side.requestMessage - request message.connectTo - SOAP URL to which to send the SOAP requestcertAlias - SOAP Client Certificate AliassoapAction - SOAP Action AttributereturnToURL - URL to which to redirect user agent after
                   WSP - resource owner interactionshttpRequest - HTTP request object of current user agent requesthttpResponse - HTTP response object of current user agent requestWSP.InteractionException - for generic interaction errorInteractionRedirectException - if user agent is redirected to 
                     WSP for resource owner interactionsSOAPBindingException - for generic SOAP binding errorsSOAPFaultException - if the response message has SOAP fault
public Message resendRequest(java.lang.String returnToURL,
                             javax.servlet.http.HttpServletRequest httpRequest,
                             javax.servlet.http.HttpServletResponse httpResponse)
                      throws InteractionRedirectException,
                             InteractionException,
                             SOAPBindingException,
                             SOAPFaultException
WSP.
 This would be invoked at WSC side. Message ID for the cached
 message should be provided as value of REQUEST_ID query
 parameter in httpRequest.returnToURL - URL to which to redirect user agent after
        WSP - resource owner interactionshttpRequest - HTTP request object of current user agent requesthttpResponse - HTTP response object of current user agent requestWSP.InteractionException - for generic interaction errorInteractionRedirectException - if user agent is redirected to 
         WSP for resource owner interactionsSOAPBindingException - if there are generic SOAP errorsSOAPFaultException - if the response message has SOAP faultREQUEST_ID
public Message resendRequest(java.lang.String returnToURL,
                             javax.servlet.http.HttpServletRequest httpRequest,
                             javax.servlet.http.HttpServletResponse httpResponse,
                             Message requestMessage)
                      throws InteractionRedirectException,
                             InteractionException,
                             SOAPBindingException,
                             SOAPFaultException
WSP.
 This would be invoked at WSC side.returnToURL - URL to which to redirect user agent after
                    WSP - resource owner interactionshttpRequest - HTTP request object of current user agent requesthttpResponse - HTTP response object of current user agent requestrequestMessage - SOAP message to be resent.WSP.InteractionException - for generic interaction errorInteractionRedirectException - if user agent is redirected to 
                     WSP for resource owner interactionsSOAPBindingException - for generic SOAP errorsSOAPFaultException - if the response message has SOAP fault
public Message handleInteraction(Message requestMessage,
                                 com.sun.identity.liberty.ws.interaction.jaxb.InquiryElement inquiryElement,
                                 java.lang.String language)
                          throws InteractionException,
                                 InteractionSOAPFaultException,
                                 SOAPFaultException
WSP.
 This is invoked at WSP side.requestMessage - SOAP request that requires resource
             owner interactionsinquiryElement - query that WSP wants to pose to
        resource ownerlanguage - language in which the query page needs to be renderedInteractionResponse,
         gathered by InteractionManagerInteractionException - for generic interaction errorInteractionSOAPFaultException - if a SOAP fault
         has to be returned  to WSCSOAPFaultException - if the response message has SOAP fault
public com.sun.identity.liberty.ws.interaction.jaxb.InteractionResponseElement getInteractionResponseElement(Message requestMessage)
                                                                                                      throws InteractionException
InteractionManagerrequestMessage - request message.InteractionManager.InteractionException - for interaction error| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||