Package com.sun.identity.saml2.protocol.impl

Class ArtifactResolveImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.RequestAbstractImpl

com.sun.identity.saml2.protocol.impl.ArtifactResolveImpl

All Implemented Interfaces:

ArtifactResolve, RequestAbstract

public class ArtifactResolveImpl
extends RequestAbstractImpl
implements ArtifactResolve

This is an implementation of interface ArtifactResolve. The ArtifactResolve message is used to request that a SAML protocol message be returned in an ArtifactResponse message by specifying an artifact that represents the SAML protocol message. It has the complex type ArtifactResolveType.

 <complexType name="ArtifactResolveType">
   <complexContent>
     <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Artifact"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields inherited from class com.sun.identity.saml2.protocol.impl.RequestAbstractImpl

consent, destinationURI, elementName, extensions, isMutable, isSignatureValid, isSigned, issueInstant, nameID, publicKey, requestId, signatureString, signedXMLString, version

Constructor Summary

Constructors

Constructor	Description
ArtifactResolveImpl()	Constructor.
ArtifactResolveImpl(String xmlString)	Class constructor with ArtifactResolve in xml string format.
ArtifactResolveImpl(Element element)	Class constructor with ArtifactResolve in Element format.

Method Summary

Modifier and Type	Method	Description
Artifact	getArtifact()	Gets the Artifact of the request.
void	setArtifact(Artifact value)	Sets the Artifact of the request.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation
protected void	validateData()

Methods inherited from class com.sun.identity.saml2.protocol.impl.RequestAbstractImpl

getAttributesString, getConsent, getDestination, getElements, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, getXMLString, isMutable, isSignatureValid, isSigned, makeImmutable, parseDOMAttributes, parseDOMChileElements, parseDOMElement, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign, validateID, validateIssueInstant, validateVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.saml2.protocol.RequestAbstract

getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, isMutable, isSignatureValid, isSigned, makeImmutable, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign

Constructor Detail

ArtifactResolveImpl

public ArtifactResolveImpl()

Constructor. Caller may need to call setters to populate the object.

ArtifactResolveImpl

public ArtifactResolveImpl(Element element)
                    throws SAML2Exception

Class constructor with ArtifactResolve in Element format.

Parameters:

element - the Document Element

Throws:

SAML2Exception - if there is an creating the object.

ArtifactResolveImpl

public ArtifactResolveImpl(String xmlString)
                    throws SAML2Exception

Class constructor with ArtifactResolve in xml string format.

Throws:

SAML2Exception

Method Detail

validateData

protected void validateData()
                     throws SAML2Exception

Overrides:

validateData in class RequestAbstractImpl

Throws:

SAML2Exception

getArtifact

public Artifact getArtifact()

Gets the Artifact of the request.

Specified by:

getArtifact in interface ArtifactResolve

Returns:

Artifact of the request.

See Also:

setArtifact(Artifact)

setArtifact

public void setArtifact(Artifact value)
                 throws SAML2Exception

Sets the Artifact of the request.

Specified by:

setArtifact in interface ArtifactResolve

Parameters:

value - new Artifact.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getArtifact()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface RequestAbstract

Overrides:

toXMLString in class RequestAbstractImpl

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if it could not create String object

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface RequestAbstract

Overrides:

toXMLString in class RequestAbstractImpl

Parameters:

includeNSPrefix - determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - determines whether or not the namespace is declared within the Element.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if it could not create String object.