| com.sun.ssoadapter.SSOAdapter
All known Subclasses: com.sun.ssoadapter.AbstractSSOAdapter,
| SSOAdapter | | public interface SSOAdapter extends SSOAdapterConstants,SSOTokenListener(Code) | | This interface describes an object that implements SSOAdapter functionality.
The primary purpose of an SSOAdapter is to provide SSO enablement
of servlet based middleware, in regards to access to back-end services, e.g.,
mail, calendar, or addressbook.
An SSOAdapter 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.
version:
1.0
See Also: com.sun.ssoadapter.SSOAdapterFactory
See Also: com.sun.ssoadapter.SSOAdapterException |
| closeConnection | | public boolean closeConnection()(Code) | | Adapter specific Connection termination.
true on success , false otherwise |
| getConnection | | 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 |
| 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 encodedPropertiesList, Locale locale) throws SSOAdapterException(Code) | | Performs SSOAdapter initialization.
When an SSOAdapter 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 SSOAdapter.
Parameters:
userPropertiesList - the list with userPropertie's keys as Strings
Parameters:
encodedPropertiesList - A list of encodedPropertie's keys as String
Parameters:
locale - The locale
Parameters:
adapterName - Used to identify the SSOAdapter
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 SSOAdapter.
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 | | 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 |
|
|