org.openliberty.xmltooling.soapbinding

Class UserInteraction

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.AbstractSignableXMLObject

org.openliberty.xmltooling.soapbinding.UserInteraction

All Implemented Interfaces:

org.opensaml.core.xml.AttributeExtensibleXMLObject, org.opensaml.core.xml.XMLObject, org.opensaml.xmlsec.signature.SignableXMLObject

public class UserInteraction
extends org.opensaml.xmlsec.signature.AbstractSignableXMLObject
implements org.opensaml.core.xml.AttributeExtensibleXMLObject

A WSC that interacts with a user (typically through a web-site offered by the WSC) may need to indicate its readiness to redirect the user agent of the user, or its readiness to pose questions to the user on behalf of other parties (such as WSPs). The <UserInteraction> header block provides a means by which a WSC can indicate its preferences and capabilities for interactions with requesting principals and, additionally, a SOAP fault message and HTTP redirect profile that enables the WSC and WSP to cooperate in redirecting the requesting principal to the WSP and, after browser interaction, back to the WSC.

   <xs:complexType name="UserInteractionHeaderType">
       <xs:sequence>
           <xs:element name="InteractionService" type="wsa:EndpointReferenceType" minOccurs="0" maxOccurs="unbounded"/>
       </xs:sequence>
       <xs:attribute name="interact" type="xs:string" use="optional" default="interactIfNeeded"/>
       <xs:attribute name="language" type="xs:NMTOKENS" use="optional"/>
       <xs:attribute name="redirect" type="xs:boolean" use="optional" default="0"/>
       <xs:attribute name="maxInteractTime" type="xs:integer" use="optional"/>
       <xs:anyAttribute namespace="##other" processContents="lax"/>
   </xs:complexType>
 
   <xs:element name="UserInteraction" type="UserInteractionHeaderType"/>   
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserInteraction.Builder Static Internal Builder
static class	UserInteraction.Interact Implementors may choose to define additional values to indicate finer grained control over the user interactions.
static class	UserInteraction.Marshaller Marshall attributes into the DOM
static class	UserInteraction.Unmarshaller Internal class that handles unmarshalling from the DOM

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_INTERACT
static String	ATT_LANGUAGE
static String	ATT_MAX_INTERACT_TIME
static String	ATT_REDIRECT
private String	interact Indicates any preference that the sender has about interactions between the receiver and the requesting principal.
private org.opensaml.core.xml.util.XMLObjectChildrenList<InteractionService>	interactionServices If present, this element MUST describe an interaction service hosted by the sender.
private String	language This attribute indicates languages that the user is likely able to process.
static String	LOCAL_NAME
private Integer	maxInteractTime This is used to indicate the maximum time in seconds that the sender regards as reasonable for any possible interaction.
private Boolean	redirect An optional attribute to indicate that the sender supports the <RedirectRequest> element that a WSP may include in a message to the WSC.
private org.opensaml.core.xml.util.AttributeMap	unknownAttributes

Constructor Summary

Constructors

Constructor and Description
UserInteraction()
UserInteraction(String namespaceURI, String elementLocalName, String namespacePrefix)

Method Summary

Methods

Modifier and Type	Method and Description
String	getInteract()
org.opensaml.core.xml.util.XMLObjectChildrenList<InteractionService>	getInteractionServices()
String	getLanguage()
Integer	getMaxInteractTime()
List<org.opensaml.core.xml.XMLObject>	getOrderedChildren()
Boolean	getRedirect()
org.opensaml.core.xml.util.AttributeMap	getUnknownAttributes()
void	setInteract(String interact)
void	setLanguage(String language)
void	setMaxInteractTime(Integer maxInteractTime)
void	setRedirect(Boolean redirect)

Methods inherited from class org.opensaml.xmlsec.signature.AbstractSignableXMLObject

getSignature, isSigned, setSignature

Methods inherited from class org.opensaml.core.xml.AbstractXMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

LOCAL_NAME

public static final String LOCAL_NAME

See Also:

Constant Field Values

interactionServices

private org.opensaml.core.xml.util.XMLObjectChildrenList<InteractionService> interactionServices

If present, this element MUST describe an interaction service hosted by the sender. This indicates that the sender can process messages defined for the interaction service [LibertyInteract], posing questions from the recipient of the message to the Principal.

interact

private String interact

Indicates any preference that the sender has about interactions between the receiver and the requesting principal. The value is a string, for which we define the values in UserInteraction.Interact

language

private String language

This attribute indicates languages that the user is likely able to process. The value of this attribute is a space separated list of language identification tags ([RFC3066]). The WSC can obtain this information from the HTTP ([RFC2616]) Accept-Language header, or by other means, for example from a personal profile service.

redirect

private Boolean redirect

An optional attribute to indicate that the sender supports the <RedirectRequest> element that a WSP may include in a message to the WSC. The value is true or false. When absent the default behavior will be as if false.

maxInteractTime

private Integer maxInteractTime

This is used to indicate the maximum time in seconds that the sender regards as reasonable for any possible interaction. The receiver is not expected to start any interaction if it has reason to assume that such an interaction is likely to take more time. In case an interaction is started and does seem to take longer the receiver is expected to respond with a message that contains a InteractionTimeout status code to the sender.

unknownAttributes

private org.opensaml.core.xml.util.AttributeMap unknownAttributes

ATT_INTERACT

public static final String ATT_INTERACT

See Also:

Constant Field Values

ATT_LANGUAGE

public static final String ATT_LANGUAGE

See Also:

Constant Field Values

ATT_REDIRECT

public static final String ATT_REDIRECT

See Also:

Constant Field Values

ATT_MAX_INTERACT_TIME

public static final String ATT_MAX_INTERACT_TIME

See Also:

Constant Field Values

Constructor Detail

UserInteraction

public UserInteraction()

UserInteraction

public UserInteraction(String namespaceURI,
               String elementLocalName,
               String namespacePrefix)

Method Detail

getInteract

public String getInteract()

setInteract

public void setInteract(String interact)

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

getRedirect

public Boolean getRedirect()

setRedirect

public void setRedirect(Boolean redirect)

getMaxInteractTime

public Integer getMaxInteractTime()

setMaxInteractTime

public void setMaxInteractTime(Integer maxInteractTime)

getInteractionServices

public org.opensaml.core.xml.util.XMLObjectChildrenList<InteractionService> getInteractionServices()

getOrderedChildren

public List<org.opensaml.core.xml.XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface org.opensaml.core.xml.XMLObject

getUnknownAttributes

public org.opensaml.core.xml.util.AttributeMap getUnknownAttributes()

Specified by:

getUnknownAttributes in interface org.opensaml.core.xml.AttributeExtensibleXMLObject