authnsvc/protocol/SASLRequest.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: SASLRequest.java,v 1.2 2008/06/25 05:47:08 qcheng Exp $
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * Portions Copyrighted 2014 ForgeRock AS.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.liberty.ws.authnsvc.protocol;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Document;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Node;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.NodeList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.encode.Base64;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.authnsvc.AuthnSvcConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.authnsvc.AuthnSvcException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.authnsvc.AuthnSvcUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>SASLRequest</code> class represents <code>SASLRequest</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * element defined in Authentication Service schema.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * @deprecated since 12.0.0
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna@Deprecated
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class SASLRequest {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private byte[]  data = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private Element requestAuthnContext = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String mechanism = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String authzID = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String advisoryAuthnID = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String id = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String messageID = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String refToMessageID = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructs a <code>SASLRequest</code> instance.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param mechanism Mechanism attribute value.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public SASLRequest(String mechanism) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.mechanism = mechanism;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructs a <code>SAMLRequest</code> with a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>org.w3c.dom.Element</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param element a <code>SASLRequest</code> element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception AuthnSvcException if an error occurs while parsing the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *            <code>SASLRequest</code> element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public SASLRequest(Element element) throws AuthnSvcException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Element dataE = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        NodeList nl = element.getChildNodes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int length = nl.getLength();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        for(int i = 0; i < length; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            Node child = nl.item(i);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (child.getNodeType() == Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                Element childElement = (Element)child;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                String localName = childElement.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                String namespaceURI = childElement.getNamespaceURI();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                if (AuthnSvcConstants.NS_AUTHN_SVC.equals(namespaceURI) &&
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    AuthnSvcConstants.TAG_DATA.equals(localName)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                   if (dataE != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        throw new AuthnSvcException("tooManyDataInReq");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    } else if (requestAuthnContext != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        throw new AuthnSvcException("invalidSeqInReq");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    dataE = childElement;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                } else if (AuthnSvcConstants.NS_PROTOCOLS_SCHEMA
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                            .equals(namespaceURI) &&
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                           AuthnSvcConstants.TAG_REQUEST_AUTHN_CONTEXT
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                            .equals(localName)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    if (requestAuthnContext != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        throw new AuthnSvcException("tooManyReqAuthnCon");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    requestAuthnContext = childElement;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    throw new AuthnSvcException("invalidChildReq");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        data = AuthnSvcUtils.decodeDataElement(dataE);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        mechanism = XMLUtils.getNodeAttributeValue(element,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                    AuthnSvcConstants.ATTR_MECHANISM);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (mechanism == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            String msg = AuthnSvcUtils.getString("missingMechanism");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            AuthnSvcUtils.debug.error("SASLRequest: " + msg);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new AuthnSvcException(msg);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        id = XMLUtils.getNodeAttributeValue(element,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                            AuthnSvcConstants.ATTR_id);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        authzID = XMLUtils.getNodeAttributeValue(element,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                           AuthnSvcConstants.ATTR_AUTHZ_ID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        advisoryAuthnID = XMLUtils.getNodeAttributeValue(element,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                AuthnSvcConstants.ATTR_ADVISORY_AUTHN_ID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns value of Element 'Data'.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return value of Element 'Data'
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setData(byte[])
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public byte[] getData() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return data;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns Element <code>RequestAuthnContext</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return Element <code>RequestAuthnContext</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setRequestAuthnContext(Element)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Element getRequestAuthnContext() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return requestAuthnContext;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns value of <code>mechanism</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return value of <code>mechanism</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setMechanism(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getMechanism() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return mechanism;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns value of <code>authzID</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return value of <code>authzID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setAuthzID(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getAuthzID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return authzID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns value of <code>advisoryAuthnID</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return value of <code>advisoryAuthnID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setAdvisoryAuthnID(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getAdvisoryAuthnID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return advisoryAuthnID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns value of <code>id</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return value of <code>id</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setId(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getId() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return id;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns value of <code>messageID</code> attribute of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>CorrelationHeader</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return value of <code>messageID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setMessageID(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getMessageID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return messageID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns value of <code>refToMessageID</code> attribute of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>CorrelationHeader</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return value of <code>refToMessageID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setRefToMessageID(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getRefToMessageID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return refToMessageID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets value of Element 'Data'.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param data value of Element 'Data'
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getData()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setData(byte[] data) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.data = data;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets Element <code>RequestAuthnContext</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param requestAuthnContext Element <code>RequestAuthnContext</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getRequestAuthnContext()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setRequestAuthnContext(Element requestAuthnContext) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.requestAuthnContext = requestAuthnContext;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets value of <code>mechanism</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param mechanism value of <code>mechanism</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getMechanism()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setMechanism(String mechanism) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.mechanism = mechanism;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets value of <code>authzID</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param authzID value of <code>authzID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getAuthzID()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setAuthzID(String authzID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.authzID = authzID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets value of <code>advisoryAuthnID</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param advisoryAuthnID value of <code>advisoryAuthnID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getAdvisoryAuthnID()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setAdvisoryAuthnID(String advisoryAuthnID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.advisoryAuthnID = advisoryAuthnID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets value of <code>id</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param id value of <code>id</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getId()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setId(String id) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.id = id;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets value of <code>messageID</code> attribute of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>CorrelationHeader</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param messageID value of <code>messageID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getMessageID()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setMessageID(String messageID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.messageID = messageID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets value of <code>refToMessageID</code> attribute of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>CorrelationHeader</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param refToMessageID value of <code>refToMessageID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getRefToMessageID()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setRefToMessageID(String refToMessageID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.refToMessageID = refToMessageID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns <code>SASLRequest</code> in <code>org.w3c.dom.Element</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * format.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return <code>SASLRequest</code> in <code>org.w3c.dom.Element</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         format.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception AuthnSvcException if an error occurs while creating the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *            <code>SASLRequest</code> element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Element toElement() throws AuthnSvcException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Document doc = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            doc = XMLUtils.newDocument();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } catch (Exception ex) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            AuthnSvcUtils.debug.error("SASLRequest:toElement", ex);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new AuthnSvcException(ex.getMessage());
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Element saslReqE = doc.createElementNS(AuthnSvcConstants.NS_AUTHN_SVC,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                         AuthnSvcConstants.PTAG_SASL_REQUEST);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        saslReqE.setAttributeNS(AuthnSvcConstants.NS_XML,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                AuthnSvcConstants.XMLNS_AUTHN_SVC,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                AuthnSvcConstants.NS_AUTHN_SVC);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        saslReqE.setAttributeNS(AuthnSvcConstants.NS_XML,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                AuthnSvcConstants.XMLNS_PROTOCOLS_SCHEMA,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                AuthnSvcConstants.NS_PROTOCOLS_SCHEMA);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        saslReqE.setAttributeNS(null,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                AuthnSvcConstants.ATTR_MECHANISM,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                mechanism);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (authzID != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            saslReqE.setAttributeNS(null,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                    AuthnSvcConstants.ATTR_AUTHZ_ID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                    authzID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (advisoryAuthnID != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            saslReqE.setAttributeNS(null,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                    AuthnSvcConstants.ATTR_ADVISORY_AUTHN_ID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                    advisoryAuthnID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (id != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            saslReqE.setAttributeNS(null, AuthnSvcConstants.ATTR_id, id);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (data != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            Element dataE = doc.createElementNS(AuthnSvcConstants.NS_AUTHN_SVC,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                         AuthnSvcConstants.PTAG_DATA);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            dataE.appendChild(doc.createTextNode(Base64.encode(data)));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            saslReqE.appendChild(dataE);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        doc.appendChild(saslReqE);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return doc.getDocumentElement();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}