src/share/classes/com/sun/org/apache/xml/internal/security/algorithms/Algorithm.java

Print this page


   1 /*
   2  * reserved comment block
   3  * DO NOT REMOVE OR ALTER!
   4  */
   5 /*
   6  * Copyright  1999-2004 The Apache Software Foundation.
   7  *
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at


  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  */
  21 package com.sun.org.apache.xml.internal.security.algorithms;
  22 
  23 
  24 
  25 import com.sun.org.apache.xml.internal.security.exceptions.XMLSecurityException;
  26 import com.sun.org.apache.xml.internal.security.utils.Constants;
  27 import com.sun.org.apache.xml.internal.security.utils.SignatureElementProxy;
  28 import org.w3c.dom.Document;
  29 import org.w3c.dom.Element;
  30 
  31 
  32 /**
  33  * The Algorithm class which stores the Algorithm URI as a string.
  34  *
  35  */
  36 public abstract class Algorithm extends SignatureElementProxy {
  37 
  38    /**
  39     *
  40     * @param doc
  41     * @param algorithmURI is the URI of the algorithm as String
  42     */
  43    public Algorithm(Document doc, String algorithmURI) {
  44 
  45       super(doc);
  46 
  47       this.setAlgorithmURI(algorithmURI);
  48    }
  49 
  50    /**
  51     * Constructor Algorithm
  52     *
  53     * @param element
  54     * @param BaseURI
  55     * @throws XMLSecurityException
  56     */
  57    public Algorithm(Element element, String BaseURI)
  58            throws XMLSecurityException {
  59       super(element, BaseURI);
  60    }
  61 
  62    /**
  63     * Method getAlgorithmURI
  64     *
  65     * @return The URI of the alogrithm
  66     */
  67    public String getAlgorithmURI() {
  68       return this._constructionElement.getAttributeNS(null, Constants._ATT_ALGORITHM);
  69    }
  70 
  71    /**
  72     * Sets the algorithm's URI as used in the signature.
  73     *
  74     * @param algorithmURI is the URI of the algorithm as String
  75     */
  76    protected void setAlgorithmURI(String algorithmURI) {
  77 
  78       if ( (algorithmURI != null)) {
  79          this._constructionElement.setAttributeNS(null, Constants._ATT_ALGORITHM,
  80                                                 algorithmURI);
  81       }
  82    }
  83 }
   1 /*
   2  * reserved comment block
   3  * DO NOT REMOVE OR ALTER!
   4  */
   5 /**
   6  * Licensed to the Apache Software Foundation (ASF) under one
   7  * or more contributor license agreements. See the NOTICE file
   8  * distributed with this work for additional information
   9  * regarding copyright ownership. The ASF licenses this file
  10  * to you under the Apache License, Version 2.0 (the
  11  * "License"); you may not use this file except in compliance
  12  * with the License. You may obtain a copy of the License at
  13  *
  14  * http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing,
  17  * software distributed under the License is distributed on an
  18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  19  * KIND, either express or implied. See the License for the
  20  * specific language governing permissions and limitations
  21  * under the License.
  22  */
  23 package com.sun.org.apache.xml.internal.security.algorithms;
  24 


  25 import com.sun.org.apache.xml.internal.security.exceptions.XMLSecurityException;
  26 import com.sun.org.apache.xml.internal.security.utils.Constants;
  27 import com.sun.org.apache.xml.internal.security.utils.SignatureElementProxy;
  28 import org.w3c.dom.Document;
  29 import org.w3c.dom.Element;
  30 

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

  33  */
  34 public abstract class Algorithm extends SignatureElementProxy {
  35 
  36     /**
  37      *
  38      * @param doc
  39      * @param algorithmURI is the URI of the algorithm as String
  40      */
  41     public Algorithm(Document doc, String algorithmURI) {

  42         super(doc);
  43 
  44         this.setAlgorithmURI(algorithmURI);
  45     }
  46 
  47     /**
  48      * Constructor Algorithm
  49      *
  50      * @param element
  51      * @param BaseURI
  52      * @throws XMLSecurityException
  53      */
  54     public Algorithm(Element element, String BaseURI) throws XMLSecurityException {

  55         super(element, BaseURI);
  56     }
  57 
  58     /**
  59      * Method getAlgorithmURI
  60      *
  61      * @return The URI of the algorithm
  62      */
  63     public String getAlgorithmURI() {
  64         return this.constructionElement.getAttributeNS(null, Constants._ATT_ALGORITHM);
  65     }
  66 
  67     /**
  68      * Sets the algorithm's URI as used in the signature.
  69      *
  70      * @param algorithmURI is the URI of the algorithm as String
  71      */
  72     protected void setAlgorithmURI(String algorithmURI) {
  73         if (algorithmURI != null) {
  74             this.constructionElement.setAttributeNS(
  75                 null, Constants._ATT_ALGORITHM, algorithmURI
  76             );
  77         }
  78     }
  79 }