org.benow.web
Class InitializationCheckerImpl

java.lang.Object
  org.benow.web.InitializationCheckerImpl

All Implemented Interfaces:

InitializationChecker

Direct Known Subclasses:

UserModuleChecker

public abstract class InitializationCheckerImpl
extends java.lang.Object
implements InitializationChecker

Field Summary

protected java.util.List<java.lang.String>	allowedEnds
protected java.util.List<java.lang.String>	allowedEquals
protected java.util.List<java.lang.String>	allowedStarts
protected java.lang.String	redirectURI
protected org.benow.security.permission.Permission	requiredPermission

Constructor Summary

InitializationCheckerImpl()

InitializationCheckerImpl(java.lang.String redirectURI)

Method Summary

protected void	allowCSS()
protected void	allowEnds(java.lang.String endsWith) Allows paths ending in given term
protected void	allowEquals(java.lang.String equals)
protected void	allowIfInSession(java.lang.String key) Allow if given key (with any value) is in session
protected void	allowIfInSession(java.lang.String key, java.lang.Object value) Allow if key with given value is in session
protected void	allowImagesDir()
protected void	allowJSDir()
protected void	allowServiceJS(java.lang.Class<? extends org.benow.service.Service> serviceClass)
protected void	allowServiceMethodJS(java.lang.Class<? extends org.benow.service.Service> serviceClass, java.lang.String methodSig)
void	allowServices()
protected void	clearAllows() Clears the allow strings, including the default strings to allow css, /js dir and /images dir.
boolean	continueTesting()
protected boolean	doIsAllowed(java.lang.String path)
java.lang.String	getInitializationURI()
boolean	isAllowed(java.lang.String path) Is this initializer at the given url in the process of initializing, if so requests will be allowed.
boolean	isInitialized() Override to return initialized state if constructed with a redirect URI
protected void	showForAnyUser() Initialization shown for any user
protected void	showForOnlyAdmin() Initialization only shown for administrator (the default)
protected void	showWhenPermission(org.benow.security.permission.Permission requiredPermission) Initialization shown for users with given permission

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

allowedEnds

protected final java.util.List<java.lang.String> allowedEnds

allowedStarts

protected final java.util.List<java.lang.String> allowedStarts

allowedEquals

protected final java.util.List<java.lang.String> allowedEquals

redirectURI

protected java.lang.String redirectURI

requiredPermission

protected org.benow.security.permission.Permission requiredPermission

Constructor Detail

InitializationCheckerImpl

public InitializationCheckerImpl()

InitializationCheckerImpl

public InitializationCheckerImpl(java.lang.String redirectURI)

Method Detail

showForOnlyAdmin

protected void showForOnlyAdmin()

Initialization only shown for administrator (the default)

showForAnyUser

protected void showForAnyUser()

Initialization shown for any user

showWhenPermission

protected void showWhenPermission(org.benow.security.permission.Permission requiredPermission)

Initialization shown for users with given permission

Parameters:

requiredPermission -

clearAllows

protected void clearAllows()

Clears the allow strings, including the default strings to allow css, /js dir and /images dir.

isInitialized

public boolean isInitialized()

Override to return initialized state if constructed with a redirect URI

Specified by:

isInitialized in interface InitializationChecker

Returns:

isAllowed

public final boolean isAllowed(java.lang.String path)

Description copied from interface: InitializationChecker

Is this initializer at the given url in the process of initializing, if so requests will be allowed.

Specified by:

isAllowed in interface InitializationChecker

Parameters:

path - the path portion of the requested url

Returns:

true if initializing for given url

doIsAllowed

protected boolean doIsAllowed(java.lang.String path)

allowCSS

protected void allowCSS()

allowEnds

protected void allowEnds(java.lang.String endsWith)

Allows paths ending in given term

Parameters:

endsWith -

allowImagesDir

protected void allowImagesDir()

allowJSDir

protected void allowJSDir()

allowServiceJS

protected void allowServiceJS(java.lang.Class<? extends org.benow.service.Service> serviceClass)

allowServiceMethodJS

protected void allowServiceMethodJS(java.lang.Class<? extends org.benow.service.Service> serviceClass,
                                    java.lang.String methodSig)

allowEquals

protected void allowEquals(java.lang.String equals)

allowIfInSession

protected void allowIfInSession(java.lang.String key,
                                java.lang.Object value)

Allow if key with given value is in session

Parameters:

key -

b -

allowIfInSession

protected void allowIfInSession(java.lang.String key)

Allow if given key (with any value) is in session

Parameters:

key -

allowServices

public void allowServices()

getInitializationURI

public java.lang.String getInitializationURI()

Specified by:

getInitializationURI in interface InitializationChecker

Returns:

the uri to begin initialization

continueTesting

public boolean continueTesting()

Specified by:

continueTesting in interface InitializationChecker

Returns:

true if the initialization is not yet complete. Override if testing is to be done repeatedly (ie on a user-by-user basis)