org.bimserver.shared.interfaces

Interface SettingsInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

SettingsInterfaceAdaptor

public interface SettingsInterface
extends PublicInterface

Method Summary

Modifier and Type	Method and Description
String	getEmailSenderAddress()
Integer	getProtocolBuffersPort()
SServerSettings	getServerSettings()
String	getServiceRepositoryUrl()
String	getSiteAddress()
String	getSmtpServer()
Boolean	isAllowSelfRegistration()
Boolean	isAllowUsersToCreateTopLevelProjects()
Boolean	isCacheOutputFiles()
Boolean	isCheckinMergingEnabled()
Boolean	isGenerateGeometryOnCheckin()
Boolean	isHideUserListForNonAdmin()
Boolean	isSendConfirmationEmailAfterRegistration()
void	setAllowSelfRegistration(Boolean allowSelfRegistration)
void	setAllowUsersToCreateTopLevelProjects(Boolean allowUsersToCreateTopLevelProjects)
void	setCacheOutputFiles(Boolean cacheOutputFiles)
void	setCheckinMergingEnabled(Boolean checkinMergingEnabled)
void	setEmailSenderAddress(String emailSenderAddress)
void	setGenerateGeometryOnCheckin(Boolean generateGeometryOnCheckin)
void	setHideUserListForNonAdmin(Boolean hideUserListForNonAdmin)
void	setProtocolBuffersPort(Integer port)
void	setSendConfirmationEmailAfterRegistration(Boolean sendConfirmationEmailAfterRegistration)
void	setServerSettings(SServerSettings serverSettings) With this method you can set all server settings at once
void	setServiceRepositoryUrl(String url)
void	setSiteAddress(String siteAddress)
void	setSmtpServer(String smtpServer)
void	setWhiteListedDomains(List<String> domains) Sets the domains that are whitelisted to connect to the different API endpoints.

Method Detail

getEmailSenderAddress

String getEmailSenderAddress()
                      throws ServerException,
                             UserException

Returns:

The current address used for sending e-mails

Throws:

ServerException

UserException

setEmailSenderAddress

void setEmailSenderAddress(String emailSenderAddress)
                    throws ServerException,
                           UserException

Parameters:

emailSenderAddress - The new e-mail address e-mail will be sent from

Throws:

ServerException, - UserException

ServerException

UserException

getProtocolBuffersPort

Integer getProtocolBuffersPort()
                        throws ServerException,
                               UserException

Returns:

The port on which the ProtocolBuffers server runs

Throws:

ServerException, - UserException

ServerException

UserException

setProtocolBuffersPort

void setProtocolBuffersPort(Integer port)
                     throws ServerException,
                            UserException

Parameters:

port - Set the port the ProtocolBuffers server runs on

Throws:

ServerException, - UserException

ServerException

UserException

getSiteAddress

String getSiteAddress()
               throws ServerException,
                      UserException

Returns:

The address the BIMserver is running on (used for links in e-mail for example)

Throws:

ServerException, - UserException

ServerException

UserException

setSiteAddress

void setSiteAddress(String siteAddress)
             throws ServerException,
                    UserException

Parameters:

siteAddress - The new address the BIMserver is running on (used for links in e-mail for example)

Throws:

ServerException, - UserException

ServerException

UserException

getSmtpServer

String getSmtpServer()
              throws ServerException,
                     UserException

Returns:

Address of the SMTP server used for sending e-mails

Throws:

ServerException, - UserException

ServerException

UserException

setSmtpServer

void setSmtpServer(String smtpServer)
            throws ServerException,
                   UserException

Parameters:

smtpServer - New address of the SMTP server used for sending e-mails

Throws:

ServerException, - UserException

ServerException

UserException

isAllowSelfRegistration

Boolean isAllowSelfRegistration()
                         throws ServerException,
                                UserException

Returns:

Whether self-registration is enabled

Throws:

ServerException, - UserException

ServerException

UserException

setAllowSelfRegistration

void setAllowSelfRegistration(Boolean allowSelfRegistration)
                       throws ServerException,
                              UserException

Parameters:

allowSelfRegistration - Change whether self-registration is enabled

Throws:

ServerException, - UserException

ServerException

UserException

isHideUserListForNonAdmin

Boolean isHideUserListForNonAdmin()
                           throws ServerException,
                                  UserException

Returns:

Whether to hide user lists (pricacy)

Throws:

ServerException, - UserException

ServerException

UserException

setHideUserListForNonAdmin

void setHideUserListForNonAdmin(Boolean hideUserListForNonAdmin)
                         throws ServerException,
                                UserException

Parameters:

hideUserListForNonAdmin - Set whether user lists should be hidden (privacy)

Throws:

ServerException, - UserException

ServerException

UserException

isAllowUsersToCreateTopLevelProjects

Boolean isAllowUsersToCreateTopLevelProjects()
                                      throws ServerException,
                                             UserException

Returns:

Whether a user can create top level projects

Throws:

ServerException, - UserException

ServerException

UserException

setAllowUsersToCreateTopLevelProjects

void setAllowUsersToCreateTopLevelProjects(Boolean allowUsersToCreateTopLevelProjects)
                                    throws ServerException,
                                           UserException

Parameters:

allowUsersToCreateTopLevelProjects - Set if users can create top level projects

Throws:

ServerException, - UserException

ServerException

UserException

isCheckinMergingEnabled

Boolean isCheckinMergingEnabled()
                         throws ServerException,
                                UserException

Returns:

Whether the BIMserver should do checkin merging (warning: this will alter your models)

Throws:

ServerException, - UserException

ServerException

UserException

setCheckinMergingEnabled

void setCheckinMergingEnabled(Boolean checkinMergingEnabled)
                       throws ServerException,
                              UserException

Parameters:

checkinMergingEnabled - Set whether the BIMserver should do checkin merging (warning: this wil alter your models)

Throws:

ServerException, - UserException

ServerException

UserException

isSendConfirmationEmailAfterRegistration

Boolean isSendConfirmationEmailAfterRegistration()
                                          throws ServerException,
                                                 UserException

Returns:

Whether a confirmation e-mail should be send after registration

Throws:

ServerException, - UserException

ServerException

UserException

setSendConfirmationEmailAfterRegistration

void setSendConfirmationEmailAfterRegistration(Boolean sendConfirmationEmailAfterRegistration)
                                        throws ServerException,
                                               UserException

Parameters:

sendConfirmationEmailAfterRegistration - Set whether a confirmation e-mail should be send after registration

Throws:

ServerException, - UserException

ServerException

UserException

isCacheOutputFiles

Boolean isCacheOutputFiles()
                    throws ServerException,
                           UserException

Returns:

Whether output files (serialized version) should be cached on disk

Throws:

ServerException, - UserException

ServerException

UserException

isGenerateGeometryOnCheckin

Boolean isGenerateGeometryOnCheckin()
                             throws ServerException,
                                    UserException

Returns:

Whether output files (serialized version) should be cached on disk

Throws:

ServerException, - UserException

ServerException

UserException

setCacheOutputFiles

void setCacheOutputFiles(Boolean cacheOutputFiles)
                  throws ServerException,
                         UserException

Parameters:

cacheOutputFiles - Set whether output files (serialized version) should be cached on disk

Throws:

ServerException, - UserException

ServerException

UserException

setGenerateGeometryOnCheckin

void setGenerateGeometryOnCheckin(Boolean generateGeometryOnCheckin)
                           throws ServerException,
                                  UserException

Parameters:

cacheOutputFiles - Set whether output files (serialized version) should be cached on disk

Throws:

ServerException, - UserException

ServerException

UserException

getServiceRepositoryUrl

String getServiceRepositoryUrl()
                        throws ServerException,
                               UserException

Returns:

The current service repository server address

Throws:

ServerException

UserException

setServiceRepositoryUrl

void setServiceRepositoryUrl(String url)
                      throws ServerException,
                             UserException

Parameters:

url - A new URL pointing to a server acting as a services repository

Throws:

ServerException

UserException

getServerSettings

SServerSettings getServerSettings()
                           throws ServerException,
                                  UserException

Returns:

The current server settings

Throws:

ServerException

UserException

setServerSettings

void setServerSettings(SServerSettings serverSettings)
                throws ServerException,
                       UserException

With this method you can set all server settings at once

Parameters:

serverSettings -

Throws:

ServerException

UserException

setWhiteListedDomains

void setWhiteListedDomains(List<String> domains)
                    throws ServerException,
                           UserException

Sets the domains that are whitelisted to connect to the different API endpoints. This is only a CORS (http://en.wikipedia.org/wiki/Cross-origin_resource_sharing) protection

Parameters:

domains -

Throws:

ServerException

UserException