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

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

/**
 * CipherData provides encrypted data. It must either contain the
 * encrypted octet sequence as base64 encoded text of the
 * CipherValue element, or provide a reference to an external
 * location containing the encrypted octet sequence via the
 * CipherReference element.
 * 
 * The schema definition is as follows:
 * 

 * <element name='CipherData' type='xenc:CipherDataType'/>
 * <complexType name='CipherDataType'>
 *     <choice>
 *         <element name='CipherValue' type='base64Binary'/>
 *         <element ref='xenc:CipherReference'/>
 *     </choice>
 * </complexType>
 * 
 *
 * @author Axl Mattheus
 */
public interface CipherData {
    
    /** VALUE_TYPE ASN */
    int VALUE_TYPE = 0x00000001;
    
    /** REFERENCE_TYPE ASN */
    int REFERENCE_TYPE = 0x00000002;

    /**
     * Returns the type of encrypted data contained in the
     * CipherData.
     *
     * @return VALUE_TYPE if the encrypted data is contained as
     *   CipherValue or REFERENCE_TYPE if the
     *   encrypted data is contained as CipherReference.
     */
    int getDataType();

    /**
     * Returns the cipher value as a base64 encoded byte array.
     *
     * @return the CipherData's value.
     */
    CipherValue getCipherValue();

    /**
     * Sets the CipherData's value.
     *
     * @param value the value of the CipherData.
     * @throws XMLEncryptionException
     */
    void setCipherValue(CipherValue value) throws XMLEncryptionException;

    /**
     * Returns a reference to an external location containing the encrypted
     * octet sequence (byte array).
     *
     * @return the reference to an external location containing the encrypted
     * octet sequence.
     */
    CipherReference getCipherReference();

    /**
     * Sets the CipherData's reference.
     *
     * @param reference an external location containing the encrypted octet sequence.
     * @throws XMLEncryptionException
     */
    void setCipherReference(CipherReference reference) throws XMLEncryptionException;
}