<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_22) on Fri Nov 19 06:49:19 EST 2010 --> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <TITLE> DiscoHints (Shibboleth Discovery Service 1.1.2 Java API.) </TITLE> <META NAME="date" CONTENT="2010-11-19"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="DiscoHints (Shibboleth Discovery Service 1.1.2 Java API.)"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DiscoHints.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DescriptionUnmarshaller.html" title="class in edu.internet2.middleware.shibboleth.wayf.idpdisco"><B>PREV CLASS</B></A> <A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHintsBuilder.html" title="class in edu.internet2.middleware.shibboleth.wayf.idpdisco"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../index.html?edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html" target="_top"><B>FRAMES</B></A> <A HREF="DiscoHints.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> edu.internet2.middleware.shibboleth.wayf.idpdisco</FONT> <BR> Interface DiscoHints</H2> <DL> <DT><B>All Superinterfaces:</B> <DD>org.opensaml.common.SAMLObject, org.opensaml.xml.validation.ValidatingXMLObject, org.opensaml.xml.XMLObject</DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHintsImpl.html" title="class in edu.internet2.middleware.shibboleth.wayf.idpdisco">DiscoHintsImpl</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>DiscoHints</B><DT>extends org.opensaml.common.SAMLObject</DL> </PRE> <P> See IdP Discovery and Login UI Metadata Extension Profile. <P> <P> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html#DEFAULT_ELEMENT_LOCAL_NAME">DEFAULT_ELEMENT_LOCAL_NAME</A></B></CODE> <BR> Name of the element inside the Extensions.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html#DEFAULT_ELEMENT_NAME">DEFAULT_ELEMENT_NAME</A></B></CODE> <BR> Default element name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html#MDUI_NS">MDUI_NS</A></B></CODE> <BR> Namespace for Discovery Service metadata extensions.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html#MDUI_PREFIX">MDUI_PREFIX</A></B></CODE> <BR> Default namespace prefix used by this library.</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DomainHint.html" title="interface in edu.internet2.middleware.shibboleth.wayf.idpdisco">DomainHint</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html#getDomainHints()">getDomainHints</A></B>()</CODE> <BR> The <DomainHint> element specifies a set of DNS domains associated with, or serviced by, the entity.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/GeolocationHint.html" title="interface in edu.internet2.middleware.shibboleth.wayf.idpdisco">GeolocationHint</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html#getGeolocationHints()">getGeolocationHints</A></B>()</CODE> <BR> The <GeolocationHint> element specifies the geographic coordinates associated with, or serviced by, the entity.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/IPHint.html" title="interface in edu.internet2.middleware.shibboleth.wayf.idpdisco">IPHint</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html#getIPHints()">getIPHints</A></B>()</CODE> <BR> The <IPHint> element specifies a set of [CIDR] blocks associated with, or serviced by, the entity.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.opensaml.xml.validation.ValidatingXMLObject"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface org.opensaml.xml.validation.ValidatingXMLObject</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>deregisterValidator, getValidators, registerValidator, validate</CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.opensaml.xml.XMLObject"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface org.opensaml.xml.XMLObject</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation</CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="MDUI_NS"><!-- --></A><H3> MDUI_NS</H3> <PRE> static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>MDUI_NS</B></PRE> <DL> <DD>Namespace for Discovery Service metadata extensions. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#edu.internet2.middleware.shibboleth.wayf.idpdisco.DiscoHints.MDUI_NS">Constant Field Values</A></DL> </DL> <HR> <A NAME="MDUI_PREFIX"><!-- --></A><H3> MDUI_PREFIX</H3> <PRE> static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>MDUI_PREFIX</B></PRE> <DL> <DD>Default namespace prefix used by this library. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#edu.internet2.middleware.shibboleth.wayf.idpdisco.DiscoHints.MDUI_PREFIX">Constant Field Values</A></DL> </DL> <HR> <A NAME="DEFAULT_ELEMENT_LOCAL_NAME"><!-- --></A><H3> DEFAULT_ELEMENT_LOCAL_NAME</H3> <PRE> static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>DEFAULT_ELEMENT_LOCAL_NAME</B></PRE> <DL> <DD>Name of the element inside the Extensions. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#edu.internet2.middleware.shibboleth.wayf.idpdisco.DiscoHints.DEFAULT_ELEMENT_LOCAL_NAME">Constant Field Values</A></DL> </DL> <HR> <A NAME="DEFAULT_ELEMENT_NAME"><!-- --></A><H3> DEFAULT_ELEMENT_NAME</H3> <PRE> static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A> <B>DEFAULT_ELEMENT_NAME</B></PRE> <DL> <DD>Default element name. <P> <DL> </DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="getIPHints()"><!-- --></A><H3> getIPHints</H3> <PRE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/IPHint.html" title="interface in edu.internet2.middleware.shibboleth.wayf.idpdisco">IPHint</A>> <B>getIPHints</B>()</PRE> <DL> <DD>The <IPHint> element specifies a set of [CIDR] blocks associated with, or serviced by, the entity. Both IPv4 and IPv6 CIDR blocks MUST be supported. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>hints</DL> </DD> </DL> <HR> <A NAME="getDomainHints()"><!-- --></A><H3> getDomainHints</H3> <PRE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DomainHint.html" title="interface in edu.internet2.middleware.shibboleth.wayf.idpdisco">DomainHint</A>> <B>getDomainHints</B>()</PRE> <DL> <DD>The <DomainHint> element specifies a set of DNS domains associated with, or serviced by, the entity. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>hints.</DL> </DD> </DL> <HR> <A NAME="getGeolocationHints()"><!-- --></A><H3> getGeolocationHints</H3> <PRE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/GeolocationHint.html" title="interface in edu.internet2.middleware.shibboleth.wayf.idpdisco">GeolocationHint</A>> <B>getGeolocationHints</B>()</PRE> <DL> <DD>The <GeolocationHint> element specifies the geographic coordinates associated with, or serviced by, the entity. Coordinates are given in decimal form using the World Geodetic System (2d) coordinate system. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>hints</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DiscoHints.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DescriptionUnmarshaller.html" title="class in edu.internet2.middleware.shibboleth.wayf.idpdisco"><B>PREV CLASS</B></A> <A HREF="../../../../../../edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHintsBuilder.html" title="class in edu.internet2.middleware.shibboleth.wayf.idpdisco"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../index.html?edu/internet2/middleware/shibboleth/wayf/idpdisco/DiscoHints.html" target="_top"><B>FRAMES</B></A> <A HREF="DiscoHints.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright © 2006-2010 <a href="http://www.internet2.edu/">Internet2</a>. All Rights Reserved. </BODY> </HTML>