From 0a90384a9c7d840e88d9636271e8393a514647a0 Mon Sep 17 00:00:00 2001 From: Leif Johansson Date: Tue, 28 Jul 2009 10:34:52 +0200 Subject: Import shibboleth ds 1.1.0 --- .../middleware/shibboleth/wayf/IdPSite.html | 396 +++++++++++++++++++++ 1 file changed, 396 insertions(+) create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.html (limited to 'doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.html') diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.html new file mode 100644 index 0000000..b90486c --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.html @@ -0,0 +1,396 @@ + + + + + + + +IdPSite (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf +
+Class IdPSite

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.IdPSite
+
+
+
+
public class IdPSite
extends Object
+ + +

+A class which abstracts an IdP for the sake of the WAYF display. Given an EntityDescriptor as + input it provides bean style get functions for the name (EntityId), the display name + (a hybrid of Organization name or EntityId and the IdP's SSO connection point. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classIdPSite.Compare + +
+           
+  + + + + + + + + + + +
+Constructor Summary
IdPSite(org.opensaml.saml2.metadata.EntityDescriptor entityParam) + +
+          Create a new element from the provided Entity.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  intcompareTo(Object o, + javax.servlet.http.HttpServletRequest req) + +
+          Comparison so we can sort the output for jsp.
+ StringgetAddressForWAYF() + +
+          When a user has selected an IdP, this provides the address to which we redirect.
+ StringgetDisplayName() + +
+          Get the user friendly name for the entity, the language we previouslt set up
+ StringgetDisplayName(javax.servlet.http.HttpServletRequest req) + +
+          Get the user friendly name for the entity, collecting the locale from the + browser if possible
+ StringgetName() + +
+          Get the name for the enclosed entity.
+ voidsetDisplayLanguage(String lang) + +
+          Prior to display we set the display language from the + browser.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IdPSite

+
+public IdPSite(org.opensaml.saml2.metadata.EntityDescriptor entityParam)
+
+
Create a new element from the provided Entity. +

+

+
Parameters:
entityParam - - What to create from
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public String getName()
+
+
Get the name for the enclosed entity. +

+

+ +
Returns:
the name for the enclosed entity.
+
+
+
+ +

+getDisplayName

+
+public String getDisplayName(javax.servlet.http.HttpServletRequest req)
+
+
Get the user friendly name for the entity, collecting the locale from the + browser if possible +

+

+
Parameters:
req - the request +
Returns:
a user friendly name.
+
+
+
+ +

+getDisplayName

+
+public String getDisplayName()
+
+
Get the user friendly name for the entity, the language we previouslt set up +

+

+
Parameters:
lang - the language. +
Returns:
a user friendly name.
+
+
+
+ +

+compareTo

+
+protected int compareTo(Object o,
+                        javax.servlet.http.HttpServletRequest req)
+
+
Comparison so we can sort the output for jsp. +

+

+
Parameters:
o - What to compare against +
Returns:
numeric encoding of comparison
See Also:
Comparator
+
+
+
+ +

+getAddressForWAYF

+
+public String getAddressForWAYF()
+
+
When a user has selected an IdP, this provides the address to which we redirect. +

+

+ +
Returns:
http address for the IdP this represents.
+
+
+
+ +

+setDisplayLanguage

+
+public void setDisplayLanguage(String lang)
+
+
Prior to display we set the display language from the + browser. There is probably a proper way to do this using + jsp, but I want to keep the API between JSP and java the same 1.3->2.0 +

+

+
Parameters:
lang - the language to set
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + -- cgit v1.1