View Javadoc

1   /*
2    * Copyright [2007] [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 edu.internet2.middleware.shibboleth.common.xmlobject;
18  
19  import java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  import org.opensaml.xml.AttributeExtensibleXMLObject;
24  import org.opensaml.xml.signature.KeyInfo;
25  import org.opensaml.xml.validation.ValidatingXMLObject;
26  
27  import edu.internet2.middleware.shibboleth.common.ShibbolethConstants;
28  
29  /**
30   * Shibboleth SAML metadata extension KeyAuthority element.
31   */
32  public interface ShibbolethMetadataKeyAuthority extends ValidatingXMLObject, AttributeExtensibleXMLObject {
33      
34      /** Element local name. */
35      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "KeyAuthority";
36  
37      /** Default element name. */
38      public static final QName DEFAULT_ELEMENT_NAME = 
39          new QName(ShibbolethConstants.SHIB_MDEXT10_NS, DEFAULT_ELEMENT_LOCAL_NAME,
40                  ShibbolethConstants.SHIB_MDEXT10_PREFIX);
41      
42      /** VerifyDepth attribute name. */
43      public static final String VERIFY_DEPTH_ATTRIB_NAME = "VerifyDepth";
44      
45      /**
46       * Get the list of KeyInfo child elements.
47       * 
48       * @return the list of KeyInfo child elements
49       */
50      public List<KeyInfo> getKeyInfos();
51      
52      /**
53       * Get the VerifyDepth attribute value.
54       * 
55       * @return the VerifyDepth attribute value
56       */
57      public Integer getVerifyDepth();
58      
59      /**
60       * Set the VerifyDepth attribute value.
61       * 
62       * @param newVerifyDepth the new VerifyDepth attribute value
63       */
64      public void setVerifyDepth(Integer newVerifyDepth);
65  
66  }