com.sun.identity.saml2.protocol
インタフェース Artifact

public interface Artifact

This class represents the Artifact element in SAMLv2 protocol schema.

 <element name="Artifact" type="{http://www.w3.org/2001/XMLSchema}string"/>
 

メソッドの概要

String	getArtifactValue() Returns the artifact.
int	getEndpointIndex() Returns the EndpointIndex of the artifact.
String	getMessageHandle() Returns the MessageHandle of the artifact.
String	getSourceID() Returns the SourceID of the artifact.
byte[]	getTypeCode() Returns the TypeCode of the artifact.
String	toXMLString() Returns a String representation of the element.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the element.

メソッドの詳細

getArtifactValue

String getArtifactValue()

Returns the artifact.

戻り値:

the value of the artifact. It's Base64 encoded.

getSourceID

String getSourceID()

Returns the SourceID of the artifact.

戻り値:

The SourceID of the artifact.

getMessageHandle

String getMessageHandle()

Returns the MessageHandle of the artifact. The result will be decoded.

戻り値:

The MessageHandle of the artifact.

getTypeCode

byte[] getTypeCode()

Returns the TypeCode of the artifact.

戻り値:

The byte array of the TypeCode for the artifact.

getEndpointIndex

int getEndpointIndex()

Returns the EndpointIndex of the artifact.

戻り値:

value of the EndpointIndex for the artifact.

toXMLString

String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

戻り値:

A string containing the valid XML for this element. By default name space name is prepended to the element name.

例外:

SAML2Exception - if the object does not conform to the schema.

toXMLString

String toXMLString(boolean includeNS,
                   boolean declareNS)
                   throws SAML2Exception

Returns a String representation of the element.

パラメータ:

includeNS - 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.

戻り値:

A string containing the valid XML for this element

例外:

SAML2Exception - if the object does not conform to the schema.