public class GrantHooksInterface
extends java.lang.Object
Grant hooks default empty implementation
Constructor and Description |
---|
GrantHooksInterface() |
Modifier and Type | Method and Description |
---|---|
static boolean |
changeScope(Grant g,
View home)
This method is called when the user has changed its application scope
|
static java.lang.String |
customAuth(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
This method is called before any standard authentication mechanism.
|
static void |
downloadDocument(Grant g,
DocumentDB doc)
Hook called after allowing document for download
|
static void |
init(Grant g,
Parameters params)
This method is dedicated to be called when initializing presentation layers (in particular it is called by generic web UI main page display)
|
static boolean |
isMenuEnable(Grant g,
java.lang.String domain,
java.lang.String item)
Hook to limit access to menu
|
static void |
logout(Grant g)
Hook before logout
|
static java.lang.String |
parseAuth(Grant g,
java.lang.String auth)
This method is called for parsing authenticated authentication string to extract user login from it
|
static void |
postLoadGrant(Grant g)
This method is called after loading grant
|
static java.lang.String |
postLoadHome(Grant g,
java.lang.String h)
This method is called after loading home page (and before assigning it)
|
static void |
postLoadLogEvents(Grant g)
This method is called after loading log events
|
static void |
postLoadMenu(Grant g)
This method is called after loading user's menu
|
static void |
postLoadProfile(Grant g)
This method is called after loading user profile data
|
static void |
postLoadResponsibilities(Grant g)
This method is called after loading user's menu
|
static java.util.List<java.lang.String> |
postLoadScope(Grant g,
java.util.List<java.lang.String> views)
Hook to customize the available scopes
|
static void |
postLoadSystemParams(Grant g)
This method is called after loading of system parameters
|
static java.util.List<SearchItem> |
postSearchIndex(Grant g,
java.util.List<SearchItem> rows)
Hook to change the result after the search in index
|
static void |
preLoadGrant(Grant g)
This method is called before loading grant
|
static void |
preLoadHome(Grant g)
This method is called before loading home page
|
static void |
preLoadLogEvents(Grant g)
This method is called before loading log events
|
static void |
preLoadMenu(Grant g)
This method is called before loading loading user's menu
|
static void |
preLoadProfile(Grant g)
This method is called before loading user profile data
|
static void |
preLoadResponsibilities(Grant g)
This method is called before loading loading user's responsibilities
|
static void |
preLoadSystemParams(Grant g)
This method is called before loading of system parameters
|
static java.lang.String |
preSearchIndex(Grant g,
java.lang.String search)
Hook to change the query before the search in index
|
static java.util.List<java.lang.String> |
validatePassword(Grant g,
java.lang.String password)
This method is called before updating the password
|
public static java.lang.String customAuth(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
This method is called before any standard authentication mechanism. It can be used to return a custom authentication string from the incoming request.
request
- HTTP requestresponse
- HTTP responsejava.lang.Exception
public static java.lang.String parseAuth(Grant g, java.lang.String auth)
This method is called for parsing authenticated authentication string to extract user login from it
g
- Grantauth
- Authentication stringpublic static void preLoadGrant(Grant g)
This method is called before loading grant
g
- Grantpublic static void postLoadGrant(Grant g)
This method is called after loading grant
g
- Grantpublic static void preLoadSystemParams(Grant g)
This method is called before loading of system parameters
g
- Grantpublic static void postLoadSystemParams(Grant g)
This method is called after loading of system parameters
g
- Grantpublic static void preLoadProfile(Grant g)
This method is called before loading user profile data
g
- Grantpublic static void postLoadProfile(Grant g)
This method is called after loading user profile data
g
- Grantpublic static void preLoadResponsibilities(Grant g)
This method is called before loading loading user's responsibilities
g
- Grantpublic static void postLoadResponsibilities(Grant g)
This method is called after loading user's menu
g
- Grantpublic static void preLoadMenu(Grant g)
This method is called before loading loading user's menu
g
- Grantpublic static void postLoadMenu(Grant g)
This method is called after loading user's menu
g
- Grantpublic static void preLoadHome(Grant g)
This method is called before loading home page
g
- Grantpublic static java.lang.String postLoadHome(Grant g, java.lang.String h)
This method is called after loading home page (and before assigning it)
g
- Granth
- Home page namepublic static void preLoadLogEvents(Grant g)
This method is called before loading log events
g
- Grantpublic static void postLoadLogEvents(Grant g)
This method is called after loading log events
g
- Grantpublic static java.util.List<java.lang.String> validatePassword(Grant g, java.lang.String password)
This method is called before updating the password
g
- Grantpassword
- Passwordpublic static void init(Grant g, Parameters params)
This method is dedicated to be called when initializing presentation layers (in particular it is called by generic web UI main page display)
g
- Grantparams
- Parameterspublic static boolean changeScope(Grant g, View home)
This method is called when the user has changed its application scope
g
- Granthome
- new home pagepublic static java.util.List<java.lang.String> postLoadScope(Grant g, java.util.List<java.lang.String> views)
Hook to customize the available scopes
g
- User rightsviews
- List of home pages based on user rightspublic static boolean isMenuEnable(Grant g, java.lang.String domain, java.lang.String item)
Hook to limit access to menu
g
- User rightsdomain
- Domain nameitem
- Optional Object or Process namepublic static java.lang.String preSearchIndex(Grant g, java.lang.String search)
Hook to change the query before the search in index
g
- User rightssearch
- User querypublic static java.util.List<SearchItem> postSearchIndex(Grant g, java.util.List<SearchItem> rows)
Hook to change the result after the search in index
g
- User rightsrows
- search resultpublic static void downloadDocument(Grant g, DocumentDB doc)
Hook called after allowing document for download
g
- User rightsdoc
- Documentpublic static void logout(Grant g)
Hook before logout
g
- User rightsCopyright (c)2006-2015 Simplicite Software. All Rights Reserved.