KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > xml > crypto > AlgorithmMethod


1 /*
2  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
3  */

4 /*
5  * $Id: AlgorithmMethod.java,v 1.4 2005/05/10 15:47:41 mullan Exp $
6  */

7 package javax.xml.crypto;
8
9 import java.security.spec.AlgorithmParameterSpec JavaDoc;
10
11 /**
12  * An abstract representation of an algorithm defined in the XML Security
13  * specifications. Subclasses represent specific types of XML security
14  * algorithms, such as a {@link javax.xml.crypto.dsig.Transform}.
15  *
16  * @author Sean Mullan
17  * @author JSR 105 Expert Group
18  * @since 1.6
19  */

20 public interface AlgorithmMethod {
21
22     /**
23      * Returns the algorithm URI of this <code>AlgorithmMethod</code>.
24      *
25      * @return the algorithm URI of this <code>AlgorithmMethod</code>
26      */

27     String JavaDoc getAlgorithm();
28
29     /**
30      * Returns the algorithm parameters of this <code>AlgorithmMethod</code>.
31      *
32      * @return the algorithm parameters of this <code>AlgorithmMethod</code>.
33      * Returns <code>null</code> if this <code>AlgorithmMethod</code> does
34      * not require parameters and they are not specified.
35      */

36     AlgorithmParameterSpec JavaDoc getParameterSpec();
37 }
38
Popular Tags