org.opensaml.saml.common.binding.artifact

Class AbstractSAMLArtifact

java.lang.Object

org.opensaml.saml.common.binding.artifact.AbstractSAMLArtifact

Direct Known Subclasses:

AbstractSAML1Artifact, AbstractSAML2Artifact

public abstract class AbstractSAMLArtifact
extends java.lang.Object

Base class for SAML artifacts.

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	typeCode 2 byte artifact type code.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSAMLArtifact(byte[] code) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	base64Encode() Gets the Base64 encoded artifact.
boolean	equals(java.lang.Object o)
byte[]	getArtifactBytes() Gets the bytes for the artifact.
abstract byte[]	getRemainingArtifact() Gets the artifact bytes minus the type code.
byte[]	getTypeCode() Gets the 2 byte type code for this artifact.
int	hashCode()
java.lang.String	hexEncode() Gets the hex encoded artifact.
protected void	setTypeCode(byte[] newTypeCode) Sets the 2 byte type code for this artifact.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

typeCode

private byte[] typeCode

2 byte artifact type code.

Constructor Detail

AbstractSAMLArtifact

protected AbstractSAMLArtifact(@Nonnull
                               byte[] code)

Constructor.

Parameters:

code - the artifact type code

Throws:

java.lang.IllegalArgumentException - thrown if the given type code is not two bytes in length

Method Detail

getArtifactBytes

@Nonnull
public byte[] getArtifactBytes()

Gets the bytes for the artifact.

Returns:

the bytes for the artifact

getTypeCode

@Nonnull
public byte[] getTypeCode()

Gets the 2 byte type code for this artifact.

Returns:

the type code for this artifact

setTypeCode

protected void setTypeCode(@Nonnull
                           byte[] newTypeCode)

Sets the 2 byte type code for this artifact.

Parameters:

newTypeCode - 2 byte type code for this artifact

getRemainingArtifact

@Nonnull
public abstract byte[] getRemainingArtifact()

Gets the artifact bytes minus the type code.

Returns:

artifact bytes minus the type code

base64Encode

@Nonnull
 @NotEmpty
public java.lang.String base64Encode()

Gets the Base64 encoded artifact.

Returns:

Base64 encoded artifact.

hexEncode

@Nonnull
 @NotEmpty
public java.lang.String hexEncode()

Gets the hex encoded artifact.

Returns:

hex encoded artifact

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object