org.apache.xml.security.encryption.Reference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation
The newest version!
/**
 * 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 org.apache.xml.security.encryption;

import java.util.Iterator;
import org.w3c.dom.Element;

/**
 * A wrapper for a pointer from a key value of an EncryptedKey to
 * items encrypted by that key value (EncryptedData or
 * EncryptedKey elements).
 * 
 * It is defined as follows:
 * 

 * <complexType name='ReferenceType'>
 *     <sequence>
 *         <any namespace='##other' minOccurs='0' maxOccurs='unbounded'/>
 *     </sequence>
 *     <attribute name='URI' type='anyURI' use='required'/>
 * </complexType>
 * 
 *
 * @author Axl Mattheus
 * @see ReferenceList
 */
public interface Reference {
    /**
     * Returns the Element tag name for this Reference.
     *
     * @return the tag name of this Reference.
     */
    String getType();

    /**
     * Returns a URI that points to an Element that
     * were encrypted using the key defined in the enclosing
     * EncryptedKey element.
     *
     * @return an Uniform Resource Identifier that qualifies an
     *   EncryptedType.
     */
    String getURI();

    /**
     * Sets a URI that points to an Element that
     * were encrypted using the key defined in the enclosing
     * EncryptedKey element.
     *
     * @param uri the Uniform Resource Identifier that qualifies an
     *   EncryptedType.
     */
    void setURI(String uri);

    /**
     * Returns an Iterator over all the child elements contained in
     * this Reference that will aid the recipient in retrieving the
     * EncryptedKey and/or EncryptedData elements.
     * These could include information such as XPath transforms, decompression
     * transforms, or information on how to retrieve the elements from a
     * document storage facility.
     *
     * @return child elements.
     */
    Iterator getElementRetrievalInformation();

    /**
     * Adds retrieval information.
     *
     * @param info
     */
    void addElementRetrievalInformation(Element info);

    /**
     * Removes the specified retrieval information.
     *
     * @param info
     */
    void removeElementRetrievalInformation(Element info);
}