Package org.opensaml.saml.saml2.core

Interface ArtifactResponse

All Superinterfaces:

SAMLObject, SignableSAMLObject, SignableXMLObject, StatusResponseType, XMLObject

All Known Implementing Classes:

ArtifactResponseImpl

public interface ArtifactResponse
extends StatusResponseType

SAML 2.0 Core ArtifactResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ELEMENT_LOCAL_NAME	Element local name.
static final QName	DEFAULT_ELEMENT_NAME	Default element name.
static final String	TYPE_LOCAL_NAME	Local name of the XSI type.
static final QName	TYPE_NAME	QName of the XSI type.

Fields inherited from interface org.opensaml.saml.saml2.core.StatusResponseType

CONSENT_ATTRIB_NAME, DESTINATION_ATTRIB_NAME, EXPLICIT_CONSENT, ID_ATTRIB_NAME, IMPLICIT_CONSENT, IN_RESPONSE_TO_ATTRIB_NAME, INAPPLICABLE_CONSENT, ISSUE_INSTANT_ATTRIB_NAME, ISSUE_INSTANT_ATTRIB_QNAME, OBTAINED_CONSENT, PRIOR_CONSENT, UNAVAILABLE_CONSENT, UNSPECIFIED_CONSENT, VERSION_ATTRIB_NAME

Method Summary

Modifier and Type	Method	Description
SAMLObject	getMessage()	Gets the protocol message from the artifact response.
void	setMessage(SAMLObject message)	Sets the protocol message from the artifact response.

Methods inherited from interface org.opensaml.saml.common.SignableSAMLObject

getSignatureReferenceID

Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject

getSignature, isSigned, setSignature

Methods inherited from interface org.opensaml.saml.saml2.core.StatusResponseType

getConsent, getDestination, getExtensions, getID, getInResponseTo, getIssueInstant, getIssuer, getStatus, getVersion, setConsent, setDestination, setExtensions, setID, setInResponseTo, setIssueInstant, setIssuer, setStatus, setVersion

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

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

Field Details

DEFAULT_ELEMENT_LOCAL_NAME

@Nonnull
@NotEmpty
static final String DEFAULT_ELEMENT_LOCAL_NAME

Element local name.

See Also:

• Constant Field Values

DEFAULT_ELEMENT_NAME

@Nonnull
static final QName DEFAULT_ELEMENT_NAME

Default element name.

TYPE_LOCAL_NAME

@Nonnull
@NotEmpty
static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

• Constant Field Values

TYPE_NAME

@Nonnull
static final QName TYPE_NAME

QName of the XSI type.

Method Details

getMessage

@Nullable
SAMLObject getMessage()

Gets the protocol message from the artifact response.

Returns:

protocol message from the artifact response

setMessage

void setMessage(@Nullable
 SAMLObject message)

Sets the protocol message from the artifact response.

Parameters:

message - protocol message from the artifact response