1/*
2 * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25/*
26 * $Id: AlgorithmMethod.java,v 1.4 2005/05/10 15:47:41 mullan Exp $
27 */
28package javax.xml.crypto;
29
30import java.security.spec.AlgorithmParameterSpec;
31
32/**
33 * An abstract representation of an algorithm defined in the XML Security
34 * specifications. Subclasses represent specific types of XML security
35 * algorithms, such as a {@link javax.xml.crypto.dsig.Transform}.
36 *
37 * @author Sean Mullan
38 * @author JSR 105 Expert Group
39 * @since 1.6
40 */
41public interface AlgorithmMethod {
42
43    /**
44     * Returns the algorithm URI of this <code>AlgorithmMethod</code>.
45     *
46     * @return the algorithm URI of this <code>AlgorithmMethod</code>
47     */
48    String getAlgorithm();
49
50    /**
51     * Returns the algorithm parameters of this <code>AlgorithmMethod</code>.
52     *
53     * @return the algorithm parameters of this <code>AlgorithmMethod</code>.
54     *    Returns <code>null</code> if this <code>AlgorithmMethod</code> does
55     *    not require parameters and they are not specified.
56     */
57    AlgorithmParameterSpec getParameterSpec();
58}
59