org.openliberty.xmltooling.soapbinding
Class Consent

java.lang.Object
  extended by org.opensaml.xml.AbstractXMLObject
      extended by org.opensaml.xml.signature.AbstractSignableXMLObject
          extended by org.openliberty.xmltooling.soapbinding.Consent
All Implemented Interfaces:
org.opensaml.xml.AttributeExtensibleXMLObject, org.opensaml.xml.signature.SignableXMLObject, org.opensaml.xml.XMLObject

public class Consent
extends org.opensaml.xml.signature.AbstractSignableXMLObject
implements org.opensaml.xml.AttributeExtensibleXMLObject

This header block is used to explicitly claim that the Principal consented to the present interaction.

   <xs:complexType name="ConsentType">
     <xs:attribute name="uri" type="xs:anyURI" use="required"/>
     <xs:attribute name="timestamp" type="xs:dateTime" use="optional"/>
     <xs:anyAttribute namespace="##other" processContents="lax"/>
   </xs:complexType>
 
   <xs:element name="Consent" type="ConsentType"/>
 

Author:
asa

Nested Class Summary
static class Consent.Builder
          Internal Builder
static class Consent.Marshaller
          Internal Marshaller
static class Consent.Unmarshaller
          Internal Unmarshaller
 
Field Summary
static java.lang.String ATT_TIMESTAMP
           
static java.lang.String ATT_URI
           
static java.lang.String LOCAL_NAME
           
static java.lang.String PRINCIPAL_CONSENT_OBTAINED_URI
           
private  org.joda.time.DateTime timestamp
          For denoting the time at which the sender obtained Principal consent with the POC.
private  org.opensaml.xml.util.AttributeMap unknownAttributes
           
private  java.lang.String uri
          A URI indicating that the PrincipalŐs consent was obtained.
 
Constructor Summary
Consent()
           
Consent(java.lang.String namespaceURI, java.lang.String elementLocalName, java.lang.String namespacePrefix)
           
 
Method Summary
 java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()
           
 org.joda.time.DateTime getTimestamp()
           
 org.opensaml.xml.util.AttributeMap getUnknownAttributes()
           
 java.lang.String getUri()
           
 void setTimestamp(org.joda.time.DateTime timestamp)
           
 void setUri(java.lang.String uri)
           
 
Methods inherited from class org.opensaml.xml.signature.AbstractSignableXMLObject
getSignature, isSigned, setSignature
 
Methods inherited from class org.opensaml.xml.AbstractXMLObject
addNamespace, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, prepareForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, 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.xml.XMLObject
addNamespace, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
 

Field Detail

LOCAL_NAME

public static final java.lang.String LOCAL_NAME
See Also:
Constant Field Values

PRINCIPAL_CONSENT_OBTAINED_URI

public static final java.lang.String PRINCIPAL_CONSENT_OBTAINED_URI
See Also:
Constant Field Values

uri

private java.lang.String uri
A URI indicating that the PrincipalŐs consent was obtained.

Optionally, the URI MAY identify a particular Consent Agreement Statement defining the specific nature of the consent obtained.

This specification defines one well-known URI Liberty implementors and deployers MAY use to indicate positive Principal consent was obtained with respect to whatever ID-* interaction is underway or being initiated. This URI is known as the "Principal Consent Obtained" URI (PCO). The value of this URI is: urn:liberty:consent:obtained

This URI does not correspond to any particular Consent Agreement Statement. Rather, it simply states that consent was obtained. The full meaning and implication of this will need to be derived from the execution context.


timestamp

private org.joda.time.DateTime timestamp
For denoting the time at which the sender obtained Principal consent with the POC.


unknownAttributes

private org.opensaml.xml.util.AttributeMap unknownAttributes

ATT_URI

public static final java.lang.String ATT_URI
See Also:
Constant Field Values

ATT_TIMESTAMP

public static final java.lang.String ATT_TIMESTAMP
See Also:
Constant Field Values
Constructor Detail

Consent

public Consent()

Consent

public Consent(java.lang.String namespaceURI,
               java.lang.String elementLocalName,
               java.lang.String namespacePrefix)
Method Detail

getTimestamp

public org.joda.time.DateTime getTimestamp()

setTimestamp

public void setTimestamp(org.joda.time.DateTime timestamp)

getUri

public java.lang.String getUri()

setUri

public void setUri(java.lang.String uri)

getUnknownAttributes

public org.opensaml.xml.util.AttributeMap getUnknownAttributes()
Specified by:
getUnknownAttributes in interface org.opensaml.xml.AttributeExtensibleXMLObject

getOrderedChildren

public java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()
Specified by:
getOrderedChildren in interface org.opensaml.xml.XMLObject