View Javadoc

1   /*
2    * Licensed to the University Corporation for Advanced Internet Development, 
3    * Inc. (UCAID) under one or more contributor license agreements.  See the 
4    * NOTICE file distributed with this work for additional information regarding
5    * copyright ownership. The UCAID licenses this file to You under the Apache 
6    * License, Version 2.0 (the "License"); you may not use this file except in 
7    * compliance with the License.  You may obtain a copy of the License at
8    *
9    *    http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package edu.internet2.middleware.shibboleth.common.xmlobject;
19  
20  import java.util.List;
21  
22  import javax.xml.namespace.QName;
23  
24  import org.opensaml.xml.AttributeExtensibleXMLObject;
25  import org.opensaml.xml.signature.KeyInfo;
26  import org.opensaml.xml.validation.ValidatingXMLObject;
27  
28  import edu.internet2.middleware.shibboleth.common.ShibbolethConstants;
29  
30  /**
31   * Shibboleth SAML metadata extension KeyAuthority element.
32   */
33  public interface ShibbolethMetadataKeyAuthority extends ValidatingXMLObject, AttributeExtensibleXMLObject {
34      
35      /** Element local name. */
36      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "KeyAuthority";
37  
38      /** Default element name. */
39      public static final QName DEFAULT_ELEMENT_NAME = 
40          new QName(ShibbolethConstants.SHIB_MDEXT10_NS, DEFAULT_ELEMENT_LOCAL_NAME,
41                  ShibbolethConstants.SHIB_MDEXT10_PREFIX);
42      
43      /** VerifyDepth attribute name. */
44      public static final String VERIFY_DEPTH_ATTRIB_NAME = "VerifyDepth";
45      
46      /**
47       * Get the list of KeyInfo child elements.
48       * 
49       * @return the list of KeyInfo child elements
50       */
51      public List<KeyInfo> getKeyInfos();
52      
53      /**
54       * Get the VerifyDepth attribute value.
55       * 
56       * @return the VerifyDepth attribute value
57       */
58      public Integer getVerifyDepth();
59      
60      /**
61       * Set the VerifyDepth attribute value.
62       * 
63       * @param newVerifyDepth the new VerifyDepth attribute value
64       */
65      public void setVerifyDepth(Integer newVerifyDepth);
66  
67  }