saml/protocol/AssertionArtifact.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: AssertionArtifact.java,v 1.2 2008/06/25 05:47:36 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.saml.protocol;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLRequesterException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.encode.Base64;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class represents the <code>AssertionArtifact</code> element in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * SAML protocol schema. Current implementation supports TYPE 1 artifact only.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Other type of artifact can be supported by extending this class.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class AssertionArtifact {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This value specifies the assertion artifact as a string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected String artifact;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected String assertionHandle = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected String sourceID = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected byte[] typeCode = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    final static int ARTIFACT_1_LENGTH = 42;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    final static byte ARTIFACT_1_TYPE_CODE_0 = 0;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    final static byte ARTIFACT_1_TYPE_CODE_1 = 1;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    final static byte[] ARTIFACT_1_TYPE_CODE = {0, 1};
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This is the default constructor of assertion artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected AssertionArtifact() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This constructor is used to construct an assertion artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param theArtifact is the string that is generated by a provider.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception SAMLException if an error occurs.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public AssertionArtifact(String theArtifact) throws SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    // check if the input is empty
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if ((theArtifact == null) || (theArtifact.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.message("AssertionArtifact: empty input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.bundle.getString("nullInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    // decode the artifact
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    byte raw[] = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        raw = Base64.decode(theArtifact);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (SAMLUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.message("AssertionArtifact: exception decode"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            + " input:", e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.bundle.getString("wrongInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    // check if the length is 42bytes
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if (raw.length != ARTIFACT_1_LENGTH) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (SAMLUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.message("AssertionArtifact: the length is"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            + " not 42:" + raw.length);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.bundle.getString("wrongInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    // check if the typecode is correct
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if ((raw[0] != ARTIFACT_1_TYPE_CODE_0) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        (raw[1] != ARTIFACT_1_TYPE_CODE_1)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.message("AssertionArtifact: wrong typecode.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.bundle.getString("wrongInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    typeCode = ARTIFACT_1_TYPE_CODE;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    artifact = theArtifact;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    // get the sourceID and assertionHandle
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    byte sBytes[] = new byte[SAMLConstants.ID_LENGTH];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    byte aBytes[] = new byte[SAMLConstants.ID_LENGTH];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    System.arraycopy(raw, 2, sBytes, 0, SAMLConstants.ID_LENGTH);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    System.arraycopy(raw, 22, aBytes, 0, SAMLConstants.ID_LENGTH);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sourceID = SAMLUtils.byteArrayToString(sBytes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        assertionHandle = SAMLUtils.byteArrayToString(aBytes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.error("AssertionArtifact: encoding exception: ", e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sourceID = new String(sBytes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        assertionHandle = new String(aBytes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This constructor will be used at the sender side to create a new
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>AssertionArtifact</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param id A string that represents the <code>sourceID</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param handle A string that represents the <code>assertionHandle</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception SAMLException if wrong input or could not encode the artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public AssertionArtifact(String id, String handle) throws SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if ((id == null) || (handle == null)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.message("AssertionArtifact: null input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.bundle.getString("nullInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    byte idBytes[] = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    byte handleBytes[] = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        idBytes = SAMLUtils.stringToByteArray(id);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        handleBytes = SAMLUtils.stringToByteArray(handle);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.error("AssertionArtifact: encoding exception: ",e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        idBytes = id.getBytes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        handleBytes = handle.getBytes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if ((idBytes.length != SAMLConstants.ID_LENGTH) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        (handleBytes.length != SAMLConstants.ID_LENGTH)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.message("AssertionArtifact: wrong input length.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.bundle.getString("wrongInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    sourceID = id;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    assertionHandle = handle;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    byte raw[] = new byte[42];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    raw[0] = ARTIFACT_1_TYPE_CODE_0;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    raw[1] = ARTIFACT_1_TYPE_CODE_1;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    for (int i = 0; i < SAMLConstants.ID_LENGTH; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        raw[2+i] = idBytes[i];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        raw[22+i] = handleBytes[i];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        artifact = Base64.encode(raw).trim();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (SAMLUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.debug.message("AssertionArtifact: exception encode"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            + " input:", e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        SAMLUtils.bundle.getString("errorCreateArtifact"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    typeCode = ARTIFACT_1_TYPE_CODE;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets the artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the string format of the artifact. It's base64 encoded.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getAssertionArtifact() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    return artifact;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the <code>SourceID</code> of the artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return The <code>SourceID</code> of the artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getSourceID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    return sourceID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets the <code>AssertionHandle</code> of the artifact. The result will be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * decoded.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return The <code>AssertionHandle</code> of the artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getAssertionHandle() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    return assertionHandle;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets the <code>typeCode</code> of the artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return The byte array of the <code>TypeCode</code> for the artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public byte[] getTypeCode() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    return typeCode;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Translates the <code>AssertionArtifact</code> to an XML document String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * based on the SAML schema.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return An XML String representing the <code>AssertionArtifact</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toString() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    return toString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Creates a String representation of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>&lt;samlp:AssertionArtifact&gt;</code> element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param includeNS Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return A string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toString(boolean includeNS, boolean declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    StringBuffer xml = new StringBuffer(100);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    String prefix = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if (includeNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        prefix = SAMLConstants.PROTOCOL_PREFIX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    String uri = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if (declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        uri = SAMLConstants.PROTOCOL_NAMESPACE_STRING;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    xml.append("<").append(prefix).append("AssertionArtifact").append(uri).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        append(">").append(artifact).append("</").append(prefix).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        append("AssertionArtifact>\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    return xml.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}