Java Doc for AbstractSSOAdapter.java in  » Portal » Open-Portal » com » sun » ssoadapter » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » Open Portal » com.sun.ssoadapter 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.ssoadapter.AbstractSSOAdapter

All known Subclasses:   com.sun.ssoadapter.impl.NotesCalendarSSOAdapter,  com.sun.ssoadapter.impl.JCAPISSOAdapter,  com.sun.ssoadapter.impl.WabpSSOAdapter,  com.sun.portal.wsrp.common.registry.RegistrySSOAdapter,  com.sun.ssoadapter.GenericSSOAdapter,  com.sun.ssoadapter.impl.LDAPABSSOAdapter,  com.sun.ssoadapter.impl.ExchangeABSSOAdapter,  com.sun.ssoadapter.impl.ExchangeCalendarSSOAdapter,  com.sun.ssoadapter.impl.JavaMailSSOAdapter,  com.sun.ssoadapter.impl.NotesABSSOAdapter,
AbstractSSOAdapter
abstract public class AbstractSSOAdapter implements SSOAdapter(Code)
This abstract class describes an object that implements SSOAdapter functionality.

The primary purpose of an AbstractSSOAdapter is to provide SSO enablement of servlet based middleware, in regards to access to back-end services, e.g., mail, calendar, or addressbook.

An AbstractSSOAdapter acts as a bridge between the DSAME authentication and sessioning mechanism and whatever authentication and sessioning mechanism is employed by a particular back-end service.

The derived class of AbstractSSOAdapter must implement

  • if init(...) implemeted , it should invoke the init(...) of the base AbstractSSOAdapter
  • getConnection()
  • closeConnection()
  • ssoTokenChanged()

Other methods provided by a particular AbstractSSOAdapter implementation will probably depend on the API and service for which the helper is providing SSO enablement.
version:
   1.0
See Also:   com.sun.ssoadapter.SSOAdapterFactory
See Also:   com.sun.ssoadapter.SSOAdapterException



Field Summary
protected  StringadapterName
    
protected  PropertiesadapterProperties
    
protected  ListencodedPropertyList
    
protected  Stringidentifier
    
protected  Localelocale
    
protected  SSOTokentoken
    
protected  ListuserPropertyList
    

Constructor Summary
protected  AbstractSSOAdapter()
    

Method Summary
abstract public  booleancloseConnection()
     Adapter specific Connection termination.
abstract public  ObjectgetConnection()
     Adapter specific Connection.
public  ListgetEncodedPropertiesList()
     A List of the encoded Properties Keys.
public  StringgetName()
     Returns the Name of this SSOAdapter.
public  PropertiesgetProperties()
     Returns the Properties bound to this SSOAdapter.
public  SSOTokengetSSOToken()
     Returns the SSOToken bound to this SSOAdapter.
public  ListgetUserPropertiesList()
     A List of the user Properties Keys.
public  voidinit(String adapterName, SSOToken token, Properties adapterProperties, List userPropertiesList, List encodedProperteisList, Locale locale)
     Performs AbstractSSOAdapter initialization.
public  booleanisAdminProperty(String propertyKey)
    
public  booleanisEncodedProperty(String propertyKey)
    
public  booleanisUserProperty(String propertyKey)
    
abstract public  voidssoTokenChanged(SSOTokenEvent evt)
     Implements SSOTokenListener "ssoTokenChanged" method.

Field Detail
adapterName
protected String adapterName(Code)
The adapterName



adapterProperties
protected Properties adapterProperties(Code)
TheadapterProperties



encodedPropertyList
protected List encodedPropertyList(Code)
The encodedPropertyList



identifier
protected String identifier(Code)
The identifier (DN) of the user



locale
protected Locale locale(Code)
The locale for localized Error Message



token
protected SSOToken token(Code)
the SSOToken



userPropertyList
protected List userPropertyList(Code)
the user's PropertyList




Constructor Detail
AbstractSSOAdapter
protected AbstractSSOAdapter()(Code)
The no argument Constructor




Method Detail
closeConnection
abstract public boolean closeConnection()(Code)
Adapter specific Connection termination. true on success , false otherwise



getConnection
abstract public Object getConnection()(Code)
Adapter specific Connection. It typically returns the MailStore for JavaMailSSOAdapter This can be any Object like JavaMailStore



getEncodedPropertiesList
public List getEncodedPropertiesList()(Code)
A List of the encoded Properties Keys. The values are available in getProperties the List containing EncodedProperties keys.
since:
   Portal 7



getName
public String getName()(Code)
Returns the Name of this SSOAdapter. The Name of this Adapter



getProperties
public Properties getProperties()(Code)
Returns the Properties bound to this SSOAdapter. A list of properties which are set



getSSOToken
public SSOToken getSSOToken() throws SSOAdapterException(Code)
Returns the SSOToken bound to this SSOAdapter.
throws:
  com.sun.ssoadapter.SSOAdapterException - Exception if fails The SSOToken



getUserPropertiesList
public List getUserPropertiesList()(Code)
A List of the user Properties Keys. The values are available in getProperties the List containing UserProperties keys.
since:
   Portal 7



init
public void init(String adapterName, SSOToken token, Properties adapterProperties, List userPropertiesList, List encodedProperteisList, Locale locale) throws SSOAdapterException(Code)
Performs AbstractSSOAdapter initialization.

When an AbstractSSOAdapter is instantiated by an SSOAdapterFactory, this method is invoked immediately following object creation.

The init() method should not be used to perform any sort of authencation nor should it establish a connection with any backend service.

The init() method is only invoked once during the lifetime of an AbstractSSOAdapter.
Parameters:
  adapterName - Used to identify the AbstractSSOAdapter
Parameters:
  token - Used to identify the user on who's behalf the request isbeing processed.
Parameters:
  adapterProperties - Contains the adapter information that will drivethe operation of this instance of an AbstractSSOAdapter.
Parameters:
  userPropertiesList - a list on Strings , which contains the keys userConfigurableProperties
Parameters:
  encodedProperteisList - a list on Strings , which contains the keys encodedConfigurableProperties
Parameters:
  locale - locale if passed in to the SSOAdapterFactory.
throws:
  com.sun.ssoadapter.SSOAdapterException - If fails




isAdminProperty
public boolean isAdminProperty(String propertyKey)(Code)
if this property can be configured only by Admin returns true else false
Parameters:
  propertyKey - the key you want to test true if it is a admin Property else false
since:
   Portal 7



isEncodedProperty
public boolean isEncodedProperty(String propertyKey)(Code)
If this is a Encoded property returns true else false
Parameters:
  propertyKey - the key you want to test true if it is a EncodedProperty else false
since:
   Portal 7



isUserProperty
public boolean isUserProperty(String propertyKey)(Code)
If the sepcified Property is a User configurable it will return true else false
Parameters:
  propertyKey - the key you want to check true if the argument is a UserProperty else false
since:
   Portal 7



ssoTokenChanged
abstract public void ssoTokenChanged(SSOTokenEvent evt)(Code)
Implements SSOTokenListener "ssoTokenChanged" method.
See Also:   com.iplanet.sso.SSOTokenListener
Parameters:
  evt - This is passed by AM with clean if evtType != evt.SSO_TOKEN_DESTROY || evtType != evt.SSO_TOKEN_IDLE_TIMEOUT || evtType != evt.SSO_TOKEN_MAX_TIMEOUT



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.