org.apache.jetspeed.sso
Interface SSOProvider


public interface SSOProvider

Utility component to handle SSO requests

Author:
Roger Ruttimann

Method Summary
 void addCredentialsForSite(String fullPath, String remoteUser, String site, String pwd)
          addCredentialsForSite()
 void addCredentialsForSite(Subject subject, String remoteUser, String site, String pwd)
           
 void addSite(String siteName, String siteUrl)
           
 SSOContext getCredentials(Subject subject, String site)
           
 List getPrincipalsForSite(SSOSite site)
          return a list of SSOContext objects containing both the portal principal, remote principal, and credentials
 SSOSite getSite(String siteUrl)
           
 String getSiteName(String site)
           
 Iterator getSites(String filter)
           
 String getSiteURL(String site)
           
 boolean hasSSOCredentials(Subject subject, String site)
          Public API's for SSO functinality
 void init()
          Init Called from the Spring Framework to initialize SSO Provider component
 void removeCredentialsForSite(String fullPath, String site)
          removeCredentialsForSite()
 void removeCredentialsForSite(Subject subject, String site)
           
 void removeSite(SSOSite site)
           
 void updateCredentialsForSite(Subject subject, String remoteUser, String site, String pwd)
           
 void updateSite(SSOSite site)
           
 

Method Detail

init

public void init()
          throws Exception
Init Called from the Spring Framework to initialize SSO Provider component

Throws:
Exception

hasSSOCredentials

public boolean hasSSOCredentials(Subject subject,
                                 String site)
Public API's for SSO functinality

Returns:

getCredentials

public SSOContext getCredentials(Subject subject,
                                 String site)
                          throws SSOException
Throws:
SSOException

addCredentialsForSite

public void addCredentialsForSite(Subject subject,
                                  String remoteUser,
                                  String site,
                                  String pwd)
                           throws SSOException
Throws:
SSOException

updateCredentialsForSite

public void updateCredentialsForSite(Subject subject,
                                     String remoteUser,
                                     String site,
                                     String pwd)
                              throws SSOException
Throws:
SSOException

removeCredentialsForSite

public void removeCredentialsForSite(Subject subject,
                                     String site)
                              throws SSOException
Throws:
SSOException

getPrincipalsForSite

public List getPrincipalsForSite(SSOSite site)
return a list of SSOContext objects containing both the portal principal, remote principal, and credentials

Parameters:
site -
Returns:
list SSOContext objects

getSites

public Iterator getSites(String filter)

getSite

public SSOSite getSite(String siteUrl)

updateSite

public void updateSite(SSOSite site)
                throws SSOException
Throws:
SSOException

addSite

public void addSite(String siteName,
                    String siteUrl)
             throws SSOException
Throws:
SSOException

removeSite

public void removeSite(SSOSite site)
                throws SSOException
Throws:
SSOException

addCredentialsForSite

public void addCredentialsForSite(String fullPath,
                                  String remoteUser,
                                  String site,
                                  String pwd)
                           throws SSOException
addCredentialsForSite()

Parameters:
fullPath -
remoteUser -
site -
pwd -
Throws:
SSOException

removeCredentialsForSite

public void removeCredentialsForSite(String fullPath,
                                     String site)
                              throws SSOException
removeCredentialsForSite()

Parameters:
fullPath -
site -
Throws:
SSOException

getSiteURL

public String getSiteURL(String site)

getSiteName

public String getSiteName(String site)


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.