org.openliberty.xmltooling.sasl

Class SASLRequest

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.AbstractSignableXMLObject

org.openliberty.xmltooling.sasl.SASLRequest

All Implemented Interfaces:

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

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

Field Summary

Fields

Modifier and Type	Field and Description
private String	advisoryAuthnID The advisoryAuthnID may be used to advise the server what authentication identity will be asserted by the client via the selected SASL mechanism; i.e., it is a "hint." The advisoryAuthnID provides a means for server implementations to optimize their behavior on a per authentication identity basis.
static String	ADVISORYAUTHNID_ATTRIB_NAME Name for the attribute which defines the advisoryAuthnID.
private String	authzID The authzID, also known as user identifier or username or Principal, that the client wishes to establish as the "authorization identity" per [RFC4422].
static String	AUTHZID_ATTRIB_NAME Name for the attribute which defines the authzID.
private Data	data base64Binary data
static String	DEFAULT_ELEMENT_LOCAL_NAME
static QName	DEFAULT_ELEMENT_NAME Default element name.
private Extensions	extensions Extensions child elements (see org.opensaml.saml2.core.impl.RequestAbstractTypeImpl)
private String	mechanism Used to convey a list of one-or-more client-supported SASL mechanism names to the server, or to signal the server if the client wishes to abort the exchange.
static String	MECHANISM_ATTRIB_NAME Name for the attribute which defines the mechanism.
private org.opensaml.core.xml.util.AttributeMap	otherAttributes
private org.opensaml.saml.saml2.core.RequestedAuthnContext	requestedAuthnContext

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getAdvisoryAuthnID()
String	getAuthzID()
Data	getData()
Extensions	getExtensions()
String	getMechanism()
List<org.opensaml.core.xml.XMLObject>	getOrderedChildren()
org.opensaml.saml.saml2.core.RequestedAuthnContext	getRequestedAuthnContext()
org.opensaml.core.xml.util.AttributeMap	getUnknownAttributes()
void	setAdvisoryAuthnID(String advisoryAuthnID)
void	setAuthzID(String authzID)
void	setData(Data data)
void	setExtensions(Extensions newExtensions)
void	setMechanism(String mechanism)
void	setRequestedAuthnContext(org.opensaml.saml.saml2.core.RequestedAuthnContext requestedAuthnContext)

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

DEFAULT_ELEMENT_LOCAL_NAME

public static String DEFAULT_ELEMENT_LOCAL_NAME

DEFAULT_ELEMENT_NAME

public static final QName DEFAULT_ELEMENT_NAME

Default element name.

MECHANISM_ATTRIB_NAME

public static final String MECHANISM_ATTRIB_NAME

Name for the attribute which defines the mechanism.

See Also:

Constant Field Values

AUTHZID_ATTRIB_NAME

public static final String AUTHZID_ATTRIB_NAME

Name for the attribute which defines the authzID.

See Also:

Constant Field Values

ADVISORYAUTHNID_ATTRIB_NAME

public static final String ADVISORYAUTHNID_ATTRIB_NAME

Name for the attribute which defines the advisoryAuthnID.

See Also:

Constant Field Values

mechanism

private String mechanism

Used to convey a list of one-or-more client-supported SASL mechanism names to the server, or to signal the server if the client wishes to abort the exchange. It is included on all messages sent by the client. [Required]

authzID

private String authzID

The authzID, also known as user identifier or username or Principal, that the client wishes to establish as the "authorization identity" per [RFC4422]. [Optional]

advisoryAuthnID

private String advisoryAuthnID

The advisoryAuthnID may be used to advise the server what authentication identity will be asserted by the client via the selected SASL mechanism; i.e., it is a "hint." The advisoryAuthnID provides a means for server implementations to optimize their behavior on a per authentication identity basis. E.g. if a client requests to execute a certain SASL mechanism on behalf of some given authentication identity (represented by advisoryAuthnID) and authorization identity (represented by authzID) pair, the server can decide whether to proceed without having to execute the SASL mechanism (execution of which might involve more than a single round-trip). Server implementations that make use of the optional advisoryAuthnID attribute SHOULD be capable of processing initial messages that do not include the advisoryAuthnID attribute. [Optional]

otherAttributes

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

data

private Data data

base64Binary data

requestedAuthnContext

private org.opensaml.saml.saml2.core.RequestedAuthnContext requestedAuthnContext

extensions

private Extensions extensions

Extensions child elements (see org.opensaml.saml2.core.impl.RequestAbstractTypeImpl)

Constructor Detail

SASLRequest

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

Parameters:

namespaceURI -

elementLocalName -

namespacePrefix -

Method Detail

getAdvisoryAuthnID

public String getAdvisoryAuthnID()

Returns:

the advisoryAuthnID

setAdvisoryAuthnID

public void setAdvisoryAuthnID(String advisoryAuthnID)

Parameters:

advisoryAuthnID - the advisoryAuthnID to set

getAuthzID

public String getAuthzID()

Returns:

the authzID

setAuthzID

public void setAuthzID(String authzID)

Parameters:

authzID - the authzID to set

getData

public Data getData()

Returns:

the data

setData

public void setData(Data data)

Parameters:

data - the data to set

getMechanism

public String getMechanism()

Returns:

the mechanism

setMechanism

public void setMechanism(String mechanism)

Parameters:

mechanism - the mechanism to set

getRequestedAuthnContext

public org.opensaml.saml.saml2.core.RequestedAuthnContext getRequestedAuthnContext()

Returns:

the requestedAuthnContext

setRequestedAuthnContext

public void setRequestedAuthnContext(org.opensaml.saml.saml2.core.RequestedAuthnContext requestedAuthnContext)

Parameters:

requestedAuthnContext - the requestedAuthnContext to set

getExtensions

public Extensions getExtensions()

setExtensions

public void setExtensions(Extensions newExtensions)

getUnknownAttributes

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

Specified by:

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

getOrderedChildren

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

Specified by:

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