org.opensaml.artifact
Class SAMLArtifactType0002

java.lang.Object
  extended by org.opensaml.artifact.SAMLArtifact
      extended by org.opensaml.artifact.SAMLArtifactType0002
All Implemented Interfaces:
Artifact, ByteSizedSequence, SAMLArtifactChecking

public class SAMLArtifactType0002
extends SAMLArtifact

This class implements a type 0x0002 artifact as specified by SAML V1.1.

TypeCode            := 0x0002
RemainingArtifact   := AssertionHandle SourceLocation
AssertionHandle     := 20-byte_sequence
SourceLocation      := URI

Since the URI is arbitrary, a type 0x0002 artifact is of indeterminate size.

The AssertionHandle is a sequence of random bytes that points to an authentication assertion at the IdP.

Before the artifact is base64-encoded, the URI is converted to a sequence of bytes based on UTF-8. While parsing an encoded artifact, this encoding process is reversed.

Author:
Tom Scavo

Nested Class Summary
static class SAMLArtifactType0002.Parser
          An implementation of Artifact.Parser for type 0x0002 artifacts.
static class SAMLArtifactType0002.RemainingArtifact
          An implementation of Artifact.RemainingArtifact for type 0x0002 artifacts (via extension of SAMLArtifact.RemainingArtifact).
 
Nested classes/interfaces inherited from class org.opensaml.artifact.SAMLArtifact
SAMLArtifact.TypeCode
 
Field Summary
static Artifact.TypeCode TYPE_CODE
          The type code of this Artifact object.
 
Fields inherited from class org.opensaml.artifact.SAMLArtifact
remainingArtifact, typeCode
 
Fields inherited from interface org.opensaml.artifact.SAMLArtifactChecking
HANDLE_LENGTH, IDENTIFIER_LENGTH, INVALID_ARG_ERROR_MSG, LENGTH_ERROR_MSG, NULL_ARG_ERROR_MSG, PARSE_ERROR_MSG, PARSER_ERROR_MSG, TYPE_CODE_ERROR_MSG
 
Constructor Summary
SAMLArtifactType0002(Artifact.RemainingArtifact remainingArtifact)
          This constructor initializes the remainingArtifact property to the given value.
SAMLArtifactType0002(byte[] assertionHandle, URI sourceLocation)
          This constructor initializes the remainingArtifact property by calling the corresponding constructor of this implementation of Artifact.RemainingArtifact.
SAMLArtifactType0002(URI sourceLocation)
          This constructor initializes the remainingArtifact property by calling the corresponding constructor of this implementation of Artifact.RemainingArtifact.
 
Method Summary
 byte[] getAssertionHandle()
          A convenience method that returns the assertionHandle property of this implementation of Artifact.RemainingArtifact.
 URI getSourceLocation()
          A convenience method that returns the sourceLocation property of this implementation of Artifact.RemainingArtifact.
 
Methods inherited from class org.opensaml.artifact.SAMLArtifact
checkHandleArg, checkIdentifierArg, checkNullArg, encode, equals, getBytes, getRemainingArtifact, getTypeCode, getTypeCode, hashCode, size, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_CODE

public static final Artifact.TypeCode TYPE_CODE
The type code of this Artifact object.

Constructor Detail

SAMLArtifactType0002

public SAMLArtifactType0002(URI sourceLocation)
This constructor initializes the remainingArtifact property by calling the corresponding constructor of this implementation of Artifact.RemainingArtifact.

This constructor throws an (unchecked) NullArgumentException if its argument is null.

Parameters:
sourceLocation - the desired source location of this SAMLArtifactType0002 object
See Also:
SAMLArtifactType0002.RemainingArtifact, NullArgumentException

SAMLArtifactType0002

public SAMLArtifactType0002(byte[] assertionHandle,
                            URI sourceLocation)
This constructor initializes the remainingArtifact property by calling the corresponding constructor of this implementation of Artifact.RemainingArtifact.

This constructor throws a NullArgumentException or InvalidArgumentException if any of its arguments are null or invalid, respectively. These exceptions are unchecked.

Parameters:
assertionHandle - the desired assertion handle of this SAMLArtifactType0002 object
sourceLocation - the desired source location of this SAMLArtifactType0002 object
See Also:
SAMLArtifactType0002.RemainingArtifact, NullArgumentException, InvalidArgumentException

SAMLArtifactType0002

public SAMLArtifactType0002(Artifact.RemainingArtifact remainingArtifact)
This constructor initializes the remainingArtifact property to the given value.

This constructor throws an (unchecked) NullArgumentException if its argument is null.

Parameters:
remainingArtifact - the desired value of the remainingArtifact property of this SAMLArtifactType0002 object
See Also:
SAMLArtifactType0002.RemainingArtifact, NullArgumentException
Method Detail

getAssertionHandle

public byte[] getAssertionHandle()
A convenience method that returns the assertionHandle property of this implementation of Artifact.RemainingArtifact.

Returns:
the assertionHandle property
See Also:
SAMLArtifactType0002.RemainingArtifact

getSourceLocation

public URI getSourceLocation()
A convenience method that returns the sourceLocation property of this implementation of Artifact.RemainingArtifact.

Returns:
the sourceLocation property
See Also:
SAMLArtifactType0002.RemainingArtifact


Copyright ? 2005 UCAID. All Rights Reserved.