Class AbstractSAMLArtifact
- java.lang.Object
-
- org.opensaml.saml.common.binding.artifact.AbstractSAMLArtifact
-
- All Implemented Interfaces:
SAMLArtifact
- Direct Known Subclasses:
AbstractSAML1Artifact
,AbstractSAML2Artifact
public abstract class AbstractSAMLArtifact extends Object implements SAMLArtifact
Base class for SAML artifacts.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractSAMLArtifact(byte[] code)
Constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description String
base64Encode()
Gets the Base64 encoded artifact.boolean
equals(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()
String
hexEncode()
Gets the hex encoded artifact.protected void
setTypeCode(byte[] newTypeCode)
Sets the 2 byte type code for this artifact.String
toString()
-
-
-
Constructor Detail
-
AbstractSAMLArtifact
protected AbstractSAMLArtifact(@Nonnull byte[] code)
Constructor.- Parameters:
code
- the artifact type code- Throws:
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.- Specified by:
getArtifactBytes
in interfaceSAMLArtifact
- Returns:
- the bytes for the artifact
-
getTypeCode
@Nonnull public byte[] getTypeCode()
Gets the 2 byte type code for this artifact.- Specified by:
getTypeCode
in interfaceSAMLArtifact
- 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 String base64Encode() throws net.shibboleth.utilities.java.support.codec.EncodingException
Gets the Base64 encoded artifact.- Returns:
- Base64 encoded artifact.
- Throws:
net.shibboleth.utilities.java.support.codec.EncodingException
- if the artifact could not be base64 encoded.
-
hexEncode
@Nonnull @NotEmpty public String hexEncode()
Gets the hex encoded artifact.- Returns:
- hex encoded artifact
-
-