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.saml2.core; 18 19 import java.util.List; 20 21 import javax.xml.namespace.QName; 22 23 import org.opensaml.common.SAMLObject; 24 import org.opensaml.common.xml.SAMLConstants; 25 import org.opensaml.xml.XMLObject; 26 27 /** 28 * SAML 2.0 Core Advice. 29 */ 30 public interface Advice extends SAMLObject { 31 32 /** Element local name. */ 33 public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Advice"; 34 35 /** Default element name. */ 36 public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20_NS, DEFAULT_ELEMENT_LOCAL_NAME, 37 SAMLConstants.SAML20_PREFIX); 38 39 /** Local name of the XSI type. */ 40 public static final String TYPE_LOCAL_NAME = "AdviceType"; 41 42 /** QName of the XSI type. */ 43 public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20_NS, TYPE_LOCAL_NAME, 44 SAMLConstants.SAML20_PREFIX); 45 46 /** 47 * Gets the list of all child elements attached to this advice. 48 * 49 * @return the list of all child elements attached to this advice 50 */ 51 public List<XMLObject> getChildren(); 52 53 /** 54 * Gets the list of child elements attached to this advice that match a particular QName. 55 * 56 * @param typeOrName the QName of the child elements to return 57 * @return the list of matching child elements attached to this advice 58 */ 59 public List<XMLObject> getChildren(QName typeOrName); 60 61 /** 62 * Gets the list of AssertionID references used as advice. 63 * 64 * @return the list of AssertionID references used as advice 65 */ 66 public List<AssertionIDRef> getAssertionIDReferences(); 67 68 /** 69 * Gets the list of AssertionURI references used as advice. 70 * 71 * @return the list of AssertionURI references used as advice 72 */ 73 public List<AssertionURIRef> getAssertionURIReferences(); 74 75 /** 76 * Gets the list of Assertions used as advice. 77 * 78 * @return the list of Assertions used as advice 79 */ 80 public List<Assertion> getAssertions(); 81 82 /** 83 * Gets the list of EncryptedAssertions used as advice. 84 * 85 * @return the list of EncryptedAssertions used as advice 86 */ 87 public List<EncryptedAssertion> getEncryptedAssertions(); 88 }