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

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

EncryptionMethod describes the encryption algorithm applied to the cipher data. If the element is absent, the encryption algorithm must be known by the recipient or the decryption will fail. 

It is defined as follows:

<complexType name='EncryptionMethodType' mixed='true'>
    <sequence>
        <element name='KeySize' minOccurs='0' type='xenc:KeySizeType'/>
        <element name='OAEPparams' minOccurs='0' type='base64Binary'/>
        <any namespace='##other' minOccurs='0' maxOccurs='unbounded'/>
    </sequence>
    <attribute name='Algorithm' type='anyURI' use='required'/>
</complexType>

Author:
Axl Mattheus/**
 * {@code EncryptionMethod} describes the encryption algorithm applied to
 * the cipher data. If the element is absent, the encryption algorithm must be
 * known by the recipient or the decryption will fail.
 * <p>
 * It is defined as follows:
 * <pre>{@code
 * <complexType name='EncryptionMethodType' mixed='true'>
 *     <sequence>
 *         <element name='KeySize' minOccurs='0' type='xenc:KeySizeType'/>
 *         <element name='OAEPparams' minOccurs='0' type='base64Binary'/>
 *         <any namespace='##other' minOccurs='0' maxOccurs='unbounded'/>
 *     </sequence>
 *     <attribute name='Algorithm' type='anyURI' use='required'/>
 * </complexType>
 * }</pre>
 *
 * @author Axl Mattheus
 */
public interface EncryptionMethod {
    
Returns the algorithm applied to the cipher data.
Returns:
the encryption algorithm./**
     * Returns the algorithm applied to the cipher data.
     *
     * @return the encryption algorithm.
     */
    String getAlgorithm();

    
Returns the key size of the key of the algorithm applied to the cipher
data.
Returns:
the key size./**
     * Returns the key size of the key of the algorithm applied to the cipher
     * data.
     *
     * @return the key size.
     */
    int getKeySize();

    
Sets the size of the key of the algorithm applied to the cipher data.
Params:
size – the key size./**
     * Sets the size of the key of the algorithm applied to the cipher data.
     *
     * @param size the key size.
     */
    void setKeySize(int size);

    
Returns the OAEP parameters of the algorithm applied to the
cipher data.
Returns:
the OAEP parameters./**
     * Returns the OAEP parameters of the algorithm applied to the
     * cipher data.
     *
     * @return the OAEP parameters.
     */
    byte[] getOAEPparams();

    
Sets the OAEP parameters.
Params:
parameters – the OAEP parameters./**
     * Sets the OAEP parameters.
     *
     * @param parameters the OAEP parameters.
     */
    void setOAEPparams(byte[] parameters);

    
Set the Digest Algorithm to use
Params:
digestAlgorithm – the Digest Algorithm to use/**
     * Set the Digest Algorithm to use
     * @param digestAlgorithm the Digest Algorithm to use
     */
    void setDigestAlgorithm(String digestAlgorithm);

    
Get the Digest Algorithm to use
Returns:
the Digest Algorithm to use/**
     * Get the Digest Algorithm to use
     * @return the Digest Algorithm to use
     */
    String getDigestAlgorithm();

    
Set the MGF Algorithm to use
Params:
mgfAlgorithm – the MGF Algorithm to use/**
     * Set the MGF Algorithm to use
     * @param mgfAlgorithm the MGF Algorithm to use
     */
    void setMGFAlgorithm(String mgfAlgorithm);

    
Get the MGF Algorithm to use
Returns:
the MGF Algorithm to use/**
     * Get the MGF Algorithm to use
     * @return the MGF Algorithm to use
     */
    String getMGFAlgorithm();

    
Returns an iterator over all the additional elements contained in the EncryptionMethod. 
Returns:
an Iterator over all the additional information about the EncryptionMethod./**
     * Returns an iterator over all the additional elements contained in the
     * {@code EncryptionMethod}.
     *
     * @return an {@code Iterator} over all the additional information
     *   about the {@code EncryptionMethod}.
     */
    Iterator<Element> getEncryptionMethodInformation();

    
Adds encryption method information.
Params:
information – additional encryption method information./**
     * Adds encryption method information.
     *
     * @param information additional encryption method information.
     */
    void addEncryptionMethodInformation(Element information);

    
Removes encryption method information.
Params:
information – the information to remove from the EncryptionMethod./**
     * Removes encryption method information.
     *
     * @param information the information to remove from the
     *   {@code EncryptionMethod}.
     */
    void removeEncryptionMethodInformation(Element information);
}