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.metadata; 18 19 import javax.xml.namespace.QName; 20 21 import org.opensaml.common.xml.SAMLConstants; 22 import org.opensaml.xml.schema.XSBooleanValue; 23 24 /** 25 * SAML 2.0 Metadata IndexedEndpoint. 26 */ 27 public interface IndexedEndpoint extends Endpoint { 28 29 /** Local name, no namespace. */ 30 public static final String DEFAULT_ELEMENT_LOCAL_NAME = "IndexedEndpoint"; 31 32 /** Default element name. */ 33 public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME, 34 SAMLConstants.SAML20MD_PREFIX); 35 36 /** Local name of the XSI type. */ 37 public static final String TYPE_LOCAL_NAME = "IndexedEndpointType"; 38 39 /** QName of the XSI type. */ 40 public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME, 41 SAMLConstants.SAML20MD_PREFIX); 42 43 /** index attribute name. */ 44 public static final String INDEX_ATTRIB_NAME = "index"; 45 46 /** isDeault attribute name. */ 47 public static final String IS_DEFAULT_ATTRIB_NAME = "isDefault"; 48 49 /** 50 * Gets the index of the endpoint. 51 * 52 * @return index of the endpoint 53 */ 54 public Integer getIndex(); 55 56 /** 57 * Sets the index of the endpoint. 58 * 59 * @param index index of the endpoint 60 */ 61 public void setIndex(Integer index); 62 63 /** 64 * Gets whether this is the default endpoint in a list. 65 * 66 * @return whether this is the default endpoint in a list 67 */ 68 public Boolean isDefault(); 69 70 /** 71 * Gets whether this is the default endpoint in a list. 72 * 73 * @return whether this is the default endpoint in a list 74 */ 75 public XSBooleanValue isDefaultXSBoolean(); 76 77 /** 78 * Sets whether this is the default endpoint in a list. Boolean values will be marshalled to either "true" or 79 * "false". 80 * 81 * @param newIsDefault whether this is the default endpoint in a list 82 */ 83 public void setIsDefault(Boolean newIsDefault); 84 85 /** 86 * Sets whether this is the default endpoint in a list. 87 * 88 * @param newIsDefault whether this is the default endpoint in a list 89 */ 90 public void setIsDefault(XSBooleanValue newIsDefault); 91 }