|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyManager
API for storing and retrieving Crowd server properties.
Method Summary | |
---|---|
void |
generateDesEncryptionKey()
Generates and stores a DES key for DES encoded passwords. |
Integer |
getBuildNumber()
This method returns the current build number for Crowd from the datastore. |
long |
getCacheTime()
Deprecated. since 1.0.2 All caching configuration has moved to the crowd-ehcache.xml |
int |
getCurrentLicenseResourceTotal()
|
String |
getDeploymentTitle()
|
Key |
getDesEncryptionKey()
|
String |
getDomain()
Will return the Domain property from the datastore or null if the domain has not been set. |
String |
getNotificationEmail()
|
String |
getProperty(String name)
Retrieves an arbitrary property by name. |
long |
getSessionTime()
|
SMTPServer |
getSMTPServer()
|
String |
getSMTPTemplate()
Deprecated. As of release 2.1, use getProperty(String) |
String |
getTokenSeed()
|
String |
getTrustedProxyServers()
Retrieves a String that contains a list of proxy servers we trust to correctly set the X-Forwarded-For flag. |
boolean |
isCacheEnabled()
|
boolean |
isGzipEnabled()
|
boolean |
isSecureCookie()
|
boolean |
isUsingDatabaseTokenStorage()
Will return true if the Crowd instance is using database token storage for authentication Token 's
otherwise assume we are using in-memory |
void |
removeProperty(String name)
Will attempt to remove a property from the datastore |
void |
setBuildNumber(Integer buildNumber)
Will set the buildNumber for the current release of Crowd. |
void |
setCacheEnabled(boolean enabled)
|
void |
setCacheTime(long cacheTime)
Deprecated. since 1.0.2 All caching configuration has moved to the crowd-ehcache.xml |
void |
setCurrentLicenseResourceTotal(int total)
|
void |
setDeploymentTitle(String title)
|
void |
setDomain(String domain)
|
void |
setGzipEnabled(boolean gzip)
|
void |
setNotificationEmail(String notificationEmail)
|
void |
setProperty(String name,
String value)
Sets an arbitrary property. |
void |
setSecureCookie(boolean secure)
|
void |
setSessionTime(long time)
|
void |
setSMTPServer(SMTPServer server)
|
void |
setSMTPTemplate(String template)
Deprecated. As of release 2.1, use setProperty(String, String) |
void |
setTokenSeed(String seed)
|
void |
setTrustedProxyServers(String proxyServers)
Persists a String containing a list of proxy servers we trust to correctly set the X-Forwarded-For flag. |
void |
setUsingDatabaseTokenStorage(boolean usingDatabaseTokenStorage)
Will set a property to state that this crowd instance is using database token storage, otherwise assume we are using in-memory |
Method Detail |
---|
long getCacheTime() throws PropertyManagerException
PropertyManagerException
- if the property cannot be foundvoid setCacheTime(long cacheTime)
cacheTime
- the caching time in minutesString getTokenSeed() throws PropertyManagerException
PropertyManagerException
- property does not exist.void setTokenSeed(String seed)
seed
- token seed.String getDeploymentTitle() throws PropertyManagerException
PropertyManagerException
- property does not exist.void setDeploymentTitle(String title)
title
- deployment title.String getDomain() throws PropertyManagerException
PropertyManagerException
- property does not exist.void setDomain(String domain)
domain
- SSO cookie domain.boolean isSecureCookie() throws PropertyManagerException
true
if the "secure" flag should be set on the SSO cookie.
PropertyManagerException
- property does not exist.void setSecureCookie(boolean secure)
secure
- true
if the "secure" flag should be set on the SSO cookie.void setCacheEnabled(boolean enabled)
enabled
- true
if application authorisation caching should be used on the server-side.boolean isCacheEnabled()
true
if application authorisation caching is used on the server-side.long getSessionTime()
void setSessionTime(long time)
time
- number of minutes the session is valid.SMTPServer getSMTPServer() throws PropertyManagerException
PropertyManagerException
- property does not exist.void setSMTPServer(SMTPServer server)
server
- SMTP server config.Key getDesEncryptionKey() throws PropertyManagerException
PropertyManagerException
- property does not exist.void generateDesEncryptionKey() throws PropertyManagerException
PropertyManagerException
- DES algorithm does not exist.@Deprecated void setSMTPTemplate(String template)
setProperty(String, String)
template
- mail template.@Deprecated String getSMTPTemplate() throws PropertyManagerException
getProperty(String)
PropertyManagerException
- property does not exist.void setCurrentLicenseResourceTotal(int total)
total
- license resource total.int getCurrentLicenseResourceTotal()
void setNotificationEmail(String notificationEmail)
notificationEmail
- notification email.String getNotificationEmail() throws PropertyManagerException
PropertyManagerException
- property does not exist.boolean isGzipEnabled() throws PropertyManagerException
true
if GZip compression should be used.
PropertyManagerException
- property does not exist.void setGzipEnabled(boolean gzip)
gzip
- true
if GZip compression should be used.Integer getBuildNumber() throws PropertyManagerException
BuildUtils.BUILD_NUMBER
since this number is for the
current release of Crowd, while the number in the database may still be set to a previous version if the UpgradeManager
has not been run.
PropertyManagerException
- if we fail to find the buildNumbervoid setBuildNumber(Integer buildNumber)
buildNumber
- the buildNumber to set in the databaseString getTrustedProxyServers() throws PropertyManagerException
PropertyManagerException
- If the list of proxy servers could not be found.void setTrustedProxyServers(String proxyServers)
proxyServers
- proxy servers.boolean isUsingDatabaseTokenStorage() throws PropertyManagerException
Token
's
otherwise assume we are using in-memory
PropertyManagerException
- property does not exist.void setUsingDatabaseTokenStorage(boolean usingDatabaseTokenStorage)
usingDatabaseTokenStorage
- true if you are switching to in-memory token storagevoid removeProperty(String name)
name
- the name of the property.String getProperty(String name) throws ObjectNotFoundException
name
- name of property.
ObjectNotFoundException
- property does not exist.void setProperty(String name, String value)
name
- name of property.value
- value.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |