View Javadoc

1   /*
2    * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.xml.signature;
18  
19  import org.opensaml.xml.XMLObject;
20  
21  /**
22   * An XMLObject whose DOM representation can be digitally signed.
23   */
24  public interface SignableXMLObject extends XMLObject {
25          
26      /**
27       * Checks to see if the element has been signed.
28       * 
29       * @return true if this element is signed, false if not
30       */
31      public boolean isSigned();
32      
33      /**
34       * Gets the Signature XMLObject.
35       * 
36       * @return the Signature XMLObject
37       */
38      public Signature getSignature();
39      
40      /**
41       * Sets the Signature XMLObject.
42       * 
43       * @param newSignature the Signature XMLObject
44       */
45      public void setSignature(Signature newSignature);
46  }