/*
 * 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.
/**
 * 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.signature;

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;
import org.w3c.dom.Node;

Handles <ds:SignatureProperty> elements
Additional information item concerning the generation of the signature(s) can
be placed in this Element
Author:
Christian Geuer-Pollmann/**
 * Handles <code>&lt;ds:SignatureProperty&gt;</code> elements
 * Additional information item concerning the generation of the signature(s) can
 * be placed in this Element
 *
 * @author Christian Geuer-Pollmann
 */
public class SignatureProperty extends SignatureElementProxy {

    
ConstructsSignatureProperty using specified target attribute
Params:
doc – the Document in which XMLsignature is placed
target – the target attribute references the Signature
element to which the property applies SignatureProperty/**
     * Constructs{@link SignatureProperty} using specified <code>target</code> attribute
     *
     * @param doc the {@link Document} in which <code>XMLsignature</code> is placed
     * @param target the <code>target</code> attribute references the <code>Signature</code>
     * element to which the property applies SignatureProperty
     */
    public SignatureProperty(Document doc, String target) {
        this(doc, target, null);
    }

    
Constructs SignatureProperty using sepcified target attribute and
id attribute
Params:
doc – the Document in which XMLsignature is placed
target – the target attribute references the Signature
 element to which the property applies
id – the id will be specified by Reference.getURI in validation/**
     * Constructs {@link SignatureProperty} using sepcified <code>target</code> attribute and
     * <code>id</code> attribute
     *
     * @param doc the {@link Document} in which <code>XMLsignature</code> is placed
     * @param target the <code>target</code> attribute references the <code>Signature</code>
     *  element to which the property applies
     * @param id the <code>id</code> will be specified by {@link Reference#getURI} in validation
     */
    public SignatureProperty(Document doc, String target, String id) {
        super(doc);

        this.setTarget(target);
        this.setId(id);
    }

    
Constructs a SignatureProperty from an Element 
Params:
element – SignatureProperty element
BaseURI – the URI of the resource where the XML instance was stored
Throws:
XMLSecurityException – /**
     * Constructs a {@link SignatureProperty} from an {@link Element}
     * @param element <code>SignatureProperty</code> element
     * @param BaseURI the URI of the resource where the XML instance was stored
     * @throws XMLSecurityException
     */
    public SignatureProperty(Element element, String BaseURI) throws XMLSecurityException {
        super(element, BaseURI);
    }

    
  Sets the id attribute
  @param id the id attribute
/**
     *   Sets the <code>id</code> attribute
     *
     *   @param id the <code>id</code> attribute
     */
    public void setId(String id) {
        if (id != null) {
            this.constructionElement.setAttributeNS(null, Constants._ATT_ID, id);
            this.constructionElement.setIdAttributeNS(null, Constants._ATT_ID, true);
        }
    }

    
Returns the id attribute
Returns:
the id attribute/**
     * Returns the <code>id</code> attribute
     *
     * @return the <code>id</code> attribute
     */
    public String getId() {
        return this.constructionElement.getAttributeNS(null, Constants._ATT_ID);
    }

    
Sets the target attribute
Params:
target – the target attribute/**
     * Sets the <code>target</code> attribute
     *
     * @param target the <code>target</code> attribute
     */
    public void setTarget(String target) {
        if (target != null) {
            this.constructionElement.setAttributeNS(null, Constants._ATT_TARGET, target);
        }
    }

    
Returns the target attribute
Returns:
the target attribute/**
     * Returns the <code>target</code> attribute
     *
     * @return the <code>target</code> attribute
     */
    public String getTarget() {
        return this.constructionElement.getAttributeNS(null, Constants._ATT_TARGET);
    }

    
Method appendChild
Params:
node – 
Returns:
the node in this element./**
     * Method appendChild
     *
     * @param node
     * @return the node in this element.
     */
    public Node appendChild(Node node) {
        return this.constructionElement.appendChild(node);
    }

    
@inheritDoc
/** @inheritDoc */
    public String getBaseLocalName() {
        return Constants._TAG_SIGNATUREPROPERTY;
    }
}