org.opensaml.xmlsec.algorithm.BlockEncryptionAlgorithm Maven / Gradle / Ivy

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

XML Security API

There is a newer version: 4.0.1

/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID 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.opensaml.xmlsec.algorithm;

import javax.annotation.Nonnull;

import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;

/**
 * Interface for block encryption algorithm descriptors.
 */
public interface BlockEncryptionAlgorithm extends KeySpecifiedAlgorithm, KeyLengthSpecifiedAlgorithm {

    /**
     * Get the JCA cipher mode specified by this algorithm.
     * 
     * @return the cipher mode
     */
    @Nonnull @NotEmpty public String getCipherMode();
    
    /**
     * Get the JCA padding algorithm specified by this algorithm.
     * 
     * @return the padding algorithm
     */
    @Nonnull @NotEmpty public String getPadding();

}