org.opensaml.artifact
Interface Artifact

All Superinterfaces:

ByteSizedSequence

All Known Implementing Classes:

SAMLArtifact, SAMLArtifactType0001, SAMLArtifactType0002

public interface Artifact
extends ByteSizedSequence

An Artifact is an encoded sequence of bytes. By definition, every Artifact has a two-byte TypeCode, which uniquely identifies the Artifact. Each implementation uniquely defines the structure of the RemainingArtifact component.

Associated with each Artifact is a Parser, which is used to parse encoded strings into Artifact objects. Every implementation must provide its own Parser as defined by this interface.

Author:

Tom Scavo

Nested Class Summary

static interface	Artifact.Parser A Parser is used to parse (decode) an encoded Artifact.
static interface	Artifact.RemainingArtifact A RemainingArtifact, being a subcomponent of Artifact, is a sequence of bytes.
static interface	Artifact.TypeCode A TypeCode, being a subcomponent of Artifact, is a sequence of bytes.

Method Summary

String	encode() Encode this Artifact object.
Artifact.RemainingArtifact	getRemainingArtifact() Get the remainingArtifact property of this Artifact object.
Artifact.TypeCode	getTypeCode() Get the typeCode property of this Artifact object.

Methods inherited from interface org.opensaml.artifact.ByteSizedSequence

equals, getBytes, hashCode, size, toString

Method Detail

getTypeCode

Artifact.TypeCode getTypeCode()

Get the typeCode property of this Artifact object.

Returns:

the typeCode property

getRemainingArtifact

Artifact.RemainingArtifact getRemainingArtifact()

Get the remainingArtifact property of this Artifact object.

Returns:

the remainingArtifact property

encode

String encode()

Encode this Artifact object.

Returns:

the encoded artifact