org.apache.xml.security.stax.ext.DocumentContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation

Apache XML Security for Java supports XML-Signature Syntax and Processing, W3C Recommendation 12 February 2002, and XML Encryption Syntax and Processing, W3C Recommendation 10 December 2002. As of version 1.4, the library supports the standard Java API JSR-105: XML Digital Signature APIs.

There is a newer version: 4.0.2

Show 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.stax.ext;

import java.util.List;
import java.util.Map;

/**
 * This class holds per document, context informations
 *
 * @author $Author: giger $
 * @version $Revision: 1367437 $ $Date: 2012-07-31 08:20:29 +0100 (Tue, 31 Jul 2012) $
 */
public interface DocumentContext {

    /**
     * @return The Encoding of the document
     */
    String getEncoding();

    /**
     * @return The base URI of the document if known
     */
    String getBaseURI();

    /**
     * Indicates if we currently stay in an encrypted content
     */
    void setIsInEncryptedContent(int index, Object object);

    /**
     * unset when we leave the encrypted content
     */
    void unsetIsInEncryptedContent(Object object);

    /**
     * @return true if we currently stay in encrypted content
     */
    boolean isInEncryptedContent();

    /**
     * Indicates if we currently stay in a signed content
     */
    void setIsInSignedContent(int index, Object object);

    /**
     * unset when we leave the signed content
     */
    void unsetIsInSignedContent(Object object);

    /**
     * @return true if we currently stay in signed content
     */
    boolean isInSignedContent();

    List getProtectionOrder();

    Map getContentTypeMap();
}