org.apache.jetspeed.administration

Interface PortalAuthenticationConfiguration

public interface PortalAuthenticationConfiguration

Portal Authentication Configuration for advanced settings on authentication activities going beyond default behavior. Extended authentication behaviors include:

• Create new session upon logging on. The default behavior is to create a new session.
• Hard limit on session expiration. Overrides Servlet API inactivity-based session expiration with hard limit expiration (ignores inactivity)
• Configure the hard limit timeout expiration redirect URL

These settings are configurable via the portal's spring configuration

Since:

2.1.2

Version:

$Id: $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaxSessionHardLimit() The max value in seconds for session invalidation.
long	getMsMaxSessionHardLimit() The max value in milliseconds for session invalidation.
String	getTimeoutRedirectLocation() A redirect URL location for hard session expiration, must be used with Max Session Hard Limit turned on isMaxSessionHardLimitEnabled() This location is usually a logout-related URL
boolean	isCreateNewSessionOnLogin() Retrieve portal configuration setting which determines whether to create new session upon authentication.
boolean	isMaxSessionHardLimitEnabled() Determine if the hard session timeout limit setting getMaxSessionHardLimit() is turned on or not in portal configuration.
void	setTimeoutRedirectLocation(String timeoutRedirectLocation) Override the configured portal-relative redirect URL location for hard session expiration, must be used with Max Session Hard Limit turned on isMaxSessionHardLimitEnabled() This location is usually a logout-related URL

Method Detail

isMaxSessionHardLimitEnabled

boolean isMaxSessionHardLimitEnabled()

Determine if the hard session timeout limit setting getMaxSessionHardLimit() is turned on or not in portal configuration. Hard limits override the Servlet API inactivity-based session expiration with hard limit expiration (ignores activity-based session invalidation) This setting requires the isCreateNewSessionOnLogin() setting being enabled.

Returns:

whether getMaxSessionHardLimit() setting is enabled

getMaxSessionHardLimit

int getMaxSessionHardLimit()

The max value in seconds for session invalidation. Hard limits expirations override the Servlet API inactivity-based session expiration with hard limit expiration (ignores activity-based session invalidation) This setting requires the isCreateNewSessionOnLogin() setting being enabled.

Returns:

the max session hard limit expiration value in seconds

getMsMaxSessionHardLimit

long getMsMaxSessionHardLimit()

The max value in milliseconds for session invalidation. Hard limits expirations override the Servlet API inactivity-based session expiration with hard limit expiration (ignores activity-based session invalidation) This setting requires the isCreateNewSessionOnLogin() setting being enabled.

Returns:

the max session hard limit expiration value in milliseconds

getTimeoutRedirectLocation

String getTimeoutRedirectLocation()

A redirect URL location for hard session expiration, must be used with Max Session Hard Limit turned on isMaxSessionHardLimitEnabled() This location is usually a logout-related URL

Returns:

the configured portal-relative redirect URL location

setTimeoutRedirectLocation

void setTimeoutRedirectLocation(String timeoutRedirectLocation)

Override the configured portal-relative redirect URL location for hard session expiration, must be used with Max Session Hard Limit turned on isMaxSessionHardLimitEnabled() This location is usually a logout-related URL

Parameters:

timeoutRedirectLocation - the new timeout redirect URL

isCreateNewSessionOnLogin

boolean isCreateNewSessionOnLogin()

Retrieve portal configuration setting which determines whether to create new session upon authentication. The default behavior is to create a new session.

Returns:

the portal configuration setting determining whether to create new sessions on login