org.opensaml.artifact
Class SAMLArtifactType0001

java.lang.Object
  extended byorg.opensaml.artifact.SAMLArtifact
      extended byorg.opensaml.artifact.SAMLArtifactType0001
All Implemented Interfaces:
Artifact, ByteSizedSequence, SAMLArtifactChecking

public class SAMLArtifactType0001
extends SAMLArtifact

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

TypeCode            := 0x0001
RemainingArtifact   := SourceId AssertionHandle
SourceId            := 20-byte_sequence
AssertionHandle     := 20-byte_sequence

Thus a type 0x0001 artifact is of size 42 bytes (unencoded).

The SourceId is an arbitrary sequence of bytes. In practice, the SourceId is the SHA-1 hash of the IdP providerId.

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

Author:
Tom Scavo

Nested Class Summary
static class SAMLArtifactType0001.Parser
          An implementation of Artifact.Parser for type 0x0001 artifacts.
static class SAMLArtifactType0001.RemainingArtifact
          An implementation of Artifact.RemainingArtifact for type 0x0001 artifacts (via extension of SAMLArtifact.RemainingArtifact).
 
Nested classes 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
SAMLArtifactType0001(Artifact.RemainingArtifact remainingArtifact)
          This constructor initializes the remainingArtifact property to the given value.
SAMLArtifactType0001(byte[] sourceId)
          This constructor initializes the remainingArtifact property by calling the corresponding constructor of this implementation of Artifact.RemainingArtifact.
SAMLArtifactType0001(byte[] sourceId, byte[] assertionHandle)
          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.
 byte[] getSourceId()
          A convenience method that returns the sourceId 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

SAMLArtifactType0001

public SAMLArtifactType0001(byte[] sourceId)
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 its argument is null or invalid, respectively. These exceptions are unchecked.

Parameters:
sourceId - the desired source Id of this SAMLArtifactType0001 object
See Also:
SAMLArtifactType0001.RemainingArtifact, NullArgumentException, InvalidArgumentException

SAMLArtifactType0001

public SAMLArtifactType0001(byte[] sourceId,
                            byte[] assertionHandle)
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:
sourceId - the desired source Id of this SAMLArtifactType0001 object
assertionHandle - the desired assertion handle of this SAMLArtifactType0001 object
See Also:
SAMLArtifactType0001.RemainingArtifact, NullArgumentException, InvalidArgumentException

SAMLArtifactType0001

public SAMLArtifactType0001(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 SAMLArtifactType0001 object
See Also:
SAMLArtifactType0001.RemainingArtifact, NullArgumentException
Method Detail

getSourceId

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

Returns:
the sourceId property
See Also:
SAMLArtifactType0001.RemainingArtifact

getAssertionHandle

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

Returns:
the assertionHandle property
See Also:
SAMLArtifactType0001.RemainingArtifact


Copyright ? 2005 UCAID. All Rights Reserved.