/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

/**

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements. See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership. The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License. You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing,

 * software distributed under the License is distributed on an

 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

 * KIND, either express or implied. See the License for the

 * specific language governing permissions and limitations

 * under the License.

 */

package com.sun.org.apache.xml.internal.security.algorithms;

import com.sun.org.apache.xml.internal.security.exceptions.XMLSecurityException;

import com.sun.org.apache.xml.internal.security.utils.Constants;

import com.sun.org.apache.xml.internal.security.utils.SignatureElementProxy;

import org.w3c.dom.Document;

import org.w3c.dom.Element;

/**

 * The Algorithm class which stores the Algorithm URI as a string.

 */

public abstract class Algorithm extends SignatureElementProxy {

    /**

     *

     * @param doc

     * @param algorithmURI is the URI of the algorithm as String

     */

    public Algorithm(Document doc, String algorithmURI) {

        super(doc);

        this.setAlgorithmURI(algorithmURI);

    }

    /**

     * Constructor Algorithm

     *

     * @param element

     * @param baseURI

     * @throws XMLSecurityException

     */

    public Algorithm(Element element, String baseURI) throws XMLSecurityException {

        super(element, baseURI);

    }

    /**

     * Method getAlgorithmURI

     *

     * @return The URI of the algorithm

     */

    public String getAlgorithmURI() {

        return getLocalAttribute(Constants._ATT_ALGORITHM);

    }

    /**

     * Sets the algorithm's URI as used in the signature.

     *

     * @param algorithmURI is the URI of the algorithm as String

     */

    protected void setAlgorithmURI(String algorithmURI) {

        if (algorithmURI != null) {

            setLocalAttribute(Constants._ATT_ALGORITHM, algorithmURI);

        }

    }

}