org.openliberty.xmltooling.ps.request

Class AddKnownEntityRequest

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.openliberty.xmltooling.ps.request.RequestAbstractType

org.openliberty.xmltooling.ps.request.AddKnownEntityRequest

All Implemented Interfaces:

BasePeopleServiceRequest, org.opensaml.core.xml.AttributeExtensibleXMLObject, org.opensaml.core.xml.XMLObject

public class AddKnownEntityRequest
extends RequestAbstractType

If a WSC knows an identifier for a user at some identity provider, it can provide this to the PS provider in an <AddKnownEntityRequest> message. This known identifier can act as a bootstrap for the establishment of the necessary federations. For instance, if the inviting user provides an email address for the invited user, this address may allow the identity provider for that user to be ascertained, thereby obviating the need to ask the user for this information.

A WSC indicates to the PS provider that it wishes a known user Object to be created by sending an <AddKnownEntityRequest> message. The Object being created MUST be a urn:liberty:ps:entity Object. The <AddKnownEntityRequest> message carries the known identifier for the relevant user within.

As for the <AddKnownEntity> message, the presence of a <Subscription> element indicates to the PS provider that the WSC desires that the PS provider return to it (when later possible) an identity token for the invited user within a <Notification> element in a <Notify> message - this possible after a federation has been established between the PS provider and the appropriate IDP. If no <Subscription> element is present, the WSC is indicating that the PS provider need not return an identity token through this mechanism.

     <!-- Declaration of AddKnownEntityRequest element -->
     <xs:element name="AddKnownEntityRequest" type="AddKnownEntityRequestType"/>
     <!-- Definition of AddKnownEntityRequestType -->
     <xs:complexType name="AddKnownEntityRequestType">
         <xs:complexContent>
             <xs:extension base="RequestAbstractType">
                 <xs:sequence>
                     <xs:element ref="Object"/>
                     <xs:element ref="sec:Token"/>
                     <xs:element ref="CreatePSObject" minOccurs="0"/>
                     <xs:element ref="Subscription" minOccurs="0"/>
                     <xs:element ref="sec:TokenPolicy" minOccurs="0"/>
                 </xs:sequence>
             </xs:extension>
         </xs:complexContent>
     </xs:complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddKnownEntityRequest.Builder Static Builder
static class	AddKnownEntityRequest.Marshaller Static Marshaller
static class	AddKnownEntityRequest.Unmarshaller Static Unmarshaller

Field Summary

Fields

Modifier and Type	Field and Description
private CreatePSObject	createPSObject
static String	LOCAL_NAME
private PSObject	object
private Subscription	subscription
private Token	token
private TokenPolicy	tokenPolicy

Constructor Summary

Constructors

Modifier	Constructor and Description
	AddKnownEntityRequest(PSObject entity, Token token)
protected	AddKnownEntityRequest(String namespaceURI, String elementLocalName, String namespacePrefix)

Method Summary

Methods

Modifier and Type	Method and Description
CreatePSObject	getCreatePSObject()
PSObject	getObject()
List<org.opensaml.core.xml.XMLObject>	getOrderedChildren()
Subscription	getSubscription()
Token	getToken()
TokenPolicy	getTokenPolicy()
void	setCreatePSObject(CreatePSObject createPSObject)
void	setObject(PSObject object)
void	setSubscription(Subscription subscription)
void	setToken(Token token)
void	setTokenPolicy(TokenPolicy tokenPolicy)

Methods inherited from class org.openliberty.xmltooling.ps.request.RequestAbstractType

actionURI, getUnknownAttributes, responseClass, type

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

object

private PSObject object

token

private Token token

createPSObject

private CreatePSObject createPSObject

subscription

private Subscription subscription

tokenPolicy

private TokenPolicy tokenPolicy

Constructor Detail

AddKnownEntityRequest

public AddKnownEntityRequest(PSObject entity,
                     Token token)

AddKnownEntityRequest

protected AddKnownEntityRequest(String namespaceURI,
                     String elementLocalName,
                     String namespacePrefix)

Method Detail

getCreatePSObject

public CreatePSObject getCreatePSObject()

setCreatePSObject

public void setCreatePSObject(CreatePSObject createPSObject)

getObject

public PSObject getObject()

setObject

public void setObject(PSObject object)

getToken

public Token getToken()

setToken

public void setToken(Token token)

getSubscription

public Subscription getSubscription()

setSubscription

public void setSubscription(Subscription subscription)

getTokenPolicy

public TokenPolicy getTokenPolicy()

setTokenPolicy

public void setTokenPolicy(TokenPolicy tokenPolicy)

getOrderedChildren

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