Package org.opencms.security

Interface I_CmsCustomLogin

All Superinterfaces:

I_CmsConfigurationParameterHandler

public interface I_CmsCustomLogin
extends I_CmsConfigurationParameterHandler

Interface for plugging in a custom login button in the login dialog which redirects to some sort of third-party authentication page.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	I_CmsCustomLogin.Mode	Mode enum indicating how the custom login should be displayed.

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

Modifier and Type	Method	Description
String	getLoginButtonCaption(Locale locale)	Gets the caption to display on the button for the given locale.
I_CmsCustomLogin.Mode	getMode()	Indicates how the custom login should be displayed.
String	getRedirect(String orgUnit)	Gets the page to redirect to after the user has clicked on the custom button.
void	initialize(CmsObject cms)	Sets the CmsObject needed for VFS operations or anything like that.
boolean	isEnabled()	Only if this returns true should the custom login be enabled.
boolean	needsOrgUnit()	Checks if the custom login method needs the user to select the OU in the login dialog.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Method Details

getMode

I_CmsCustomLogin.Mode getMode()

Indicates how the custom login should be displayed.

Returns:

the display mode

getRedirect

String getRedirect(String orgUnit)

Gets the page to redirect to after the user has clicked on the custom button.

Parameters:

orgUnit - the organizational unit that has been selected, or null if none was selected

Returns:

the redirect URI

getLoginButtonCaption

String getLoginButtonCaption(Locale locale)

Gets the caption to display on the button for the given locale.

Parameters:

locale - the locale

Returns:

the caption to display

initialize

void initialize(CmsObject cms)

Sets the CmsObject needed for VFS operations or anything like that.

Parameters:

cms - a CmsObject with admin privileges

isEnabled

boolean isEnabled()

Only if this returns true should the custom login be enabled.

Returns:

true if the custom login should be enabled

needsOrgUnit

boolean needsOrgUnit()

Checks if the custom login method needs the user to select the OU in the login dialog.

Returns:

true if the custom login method needs the OU