pulse - the web application framework Get pulse at SourceForge.net. Fast, secure and Free Open Source software downloads Ohloh project report for pulse-java

org.torweg.pulse.component.core.accesscontrol.sso
Class CookieBasedSSOConfig

java.lang.Object
  extended by org.torweg.pulse.configuration.Configuration
      extended by org.torweg.pulse.component.core.accesscontrol.sso.CookieBasedSSOConfig
All Implemented Interfaces:
java.io.Serializable

public class CookieBasedSSOConfig
extends Configuration

is the configuration for the CookieBasedSSO single sign-on task.

Version:
$Revision: 1451 $
Author:
Thomas Weber
See Also:
Serialized Form

Constructor Summary
CookieBasedSSOConfig()
          default constructor.
 
Method Summary
 java.lang.String getDomain()
          returns the cookie-domain.
 JNDILookupConfiguration getJndiConfig()
          returns the JNDI configuration for the JDBC DataSource.
 TimeSpan getMaxTimeToLive()
          returns the maximum time-to-live for entries in the sso table.
 java.lang.String getPath()
          retruns the cookie-path.
 java.lang.String getTableName()
          returns the database table name.
 boolean isIncludePassword()
          returns whether passwords are to be stored in the sso table.
 boolean isSSOEnabledFor(User user)
          returns whether SSO is enabled for the given user.
 void setIncludePassword(boolean b)
          sets whether passwords are to be stored in the sso table.
 void setMaxTimeToLive(TimeSpan ttl)
          sets the maximum time-to-live for entries in the sso table.
 void setSSORoleIds(java.util.Collection<java.lang.Long> ids)
          sets the SSO roles.
 void setTableName(java.lang.String t)
          sets the database table name.
 
Methods inherited from class org.torweg.pulse.configuration.Configuration
getBundle, isBundleConfiguration, isModified, setBundle, setConfigFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CookieBasedSSOConfig

public CookieBasedSSOConfig()
default constructor.

Method Detail

getPath

public final java.lang.String getPath()
retruns the cookie-path.

Returns:
the cookie-path

getDomain

public final java.lang.String getDomain()
returns the cookie-domain.

Returns:
the cookie-domain

getJndiConfig

public final JNDILookupConfiguration getJndiConfig()
returns the JNDI configuration for the JDBC DataSource.

Returns:
the JNDI configuration for the JDBC DataSource

getTableName

public final java.lang.String getTableName()
returns the database table name.

Returns:
the database table name

setTableName

public final void setTableName(java.lang.String t)
sets the database table name.

Parameters:
t - the database table name

isIncludePassword

public final boolean isIncludePassword()
returns whether passwords are to be stored in the sso table.

Returns:
true, if and only if, passwords are stored in the sso table. Otherwise false.

setIncludePassword

public final void setIncludePassword(boolean b)
sets whether passwords are to be stored in the sso table.

Parameters:
b - the password flag

getMaxTimeToLive

public final TimeSpan getMaxTimeToLive()
returns the maximum time-to-live for entries in the sso table.

Returns:
the maximum time-to-live

setMaxTimeToLive

public final void setMaxTimeToLive(TimeSpan ttl)
sets the maximum time-to-live for entries in the sso table.

Parameters:
ttl - the maximum time-to-live

setSSORoleIds

public final void setSSORoleIds(java.util.Collection<java.lang.Long> ids)
sets the SSO roles.

Parameters:
ids - the ids of the roles for which to enable sso

isSSOEnabledFor

public final boolean isSSOEnabledFor(User user)
returns whether SSO is enabled for the given user.

Parameters:
user - the user
Returns:
true, if SSO is enabled