org.bimserver.shared.interfaces

Class SettingsInterfaceAdaptor

java.lang.Object

org.bimserver.shared.interfaces.SettingsInterfaceAdaptor

All Implemented Interfaces:

PublicInterface, SettingsInterface

public class SettingsInterfaceAdaptor
extends Object
implements SettingsInterface

Constructor Summary

Constructors

Constructor and Description
SettingsInterfaceAdaptor()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsInterfaceAdaptor

public SettingsInterfaceAdaptor()

Method Detail

getEmailSenderAddress

public String getEmailSenderAddress()
                             throws UserException,
                                    ServerException

Specified by:

getEmailSenderAddress in interface SettingsInterface

Returns:

The current address used for sending e-mails

Throws:

UserException

ServerException

getProtocolBuffersPort

public Integer getProtocolBuffersPort()
                               throws UserException,
                                      ServerException

Specified by:

getProtocolBuffersPort in interface SettingsInterface

Returns:

The port on which the ProtocolBuffers server runs

Throws:

UserException

ServerException

getServerSettings

public SServerSettings getServerSettings()
                                  throws UserException,
                                         ServerException

Specified by:

getServerSettings in interface SettingsInterface

Returns:

The current server settings

Throws:

UserException

ServerException

getServiceRepositoryUrl

public String getServiceRepositoryUrl()
                               throws UserException,
                                      ServerException

Specified by:

getServiceRepositoryUrl in interface SettingsInterface

Returns:

The current service repository server address

Throws:

UserException

ServerException

getSiteAddress

public String getSiteAddress()
                      throws UserException,
                             ServerException

Specified by:

getSiteAddress in interface SettingsInterface

Returns:

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

Throws:

UserException

ServerException

getSmtpServer

public String getSmtpServer()
                     throws UserException,
                            ServerException

Specified by:

getSmtpServer in interface SettingsInterface

Returns:

Address of the SMTP server used for sending e-mails

Throws:

UserException

ServerException

isAllowSelfRegistration

public Boolean isAllowSelfRegistration()
                                throws UserException,
                                       ServerException

Specified by:

isAllowSelfRegistration in interface SettingsInterface

Returns:

Whether self-registration is enabled

Throws:

UserException

ServerException

isAllowUsersToCreateTopLevelProjects

public Boolean isAllowUsersToCreateTopLevelProjects()
                                             throws UserException,
                                                    ServerException

Specified by:

isAllowUsersToCreateTopLevelProjects in interface SettingsInterface

Returns:

Whether a user can create top level projects

Throws:

UserException

ServerException

isCacheOutputFiles

public Boolean isCacheOutputFiles()
                           throws UserException,
                                  ServerException

Specified by:

isCacheOutputFiles in interface SettingsInterface

Returns:

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

Throws:

UserException

ServerException

isCheckinMergingEnabled

public Boolean isCheckinMergingEnabled()
                                throws UserException,
                                       ServerException

Specified by:

isCheckinMergingEnabled in interface SettingsInterface

Returns:

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

Throws:

UserException

ServerException

isGenerateGeometryOnCheckin

public Boolean isGenerateGeometryOnCheckin()
                                    throws UserException,
                                           ServerException

Specified by:

isGenerateGeometryOnCheckin in interface SettingsInterface

Returns:

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

Throws:

UserException

ServerException

isHideUserListForNonAdmin

public Boolean isHideUserListForNonAdmin()
                                  throws UserException,
                                         ServerException

Specified by:

isHideUserListForNonAdmin in interface SettingsInterface

Returns:

Whether to hide user lists (pricacy)

Throws:

UserException

ServerException

isSendConfirmationEmailAfterRegistration

public Boolean isSendConfirmationEmailAfterRegistration()
                                                 throws UserException,
                                                        ServerException

Specified by:

isSendConfirmationEmailAfterRegistration in interface SettingsInterface

Returns:

Whether a confirmation e-mail should be send after registration

Throws:

UserException

ServerException

setAllowSelfRegistration

public void setAllowSelfRegistration(Boolean allowSelfRegistration)
                              throws UserException,
                                     ServerException

Specified by:

setAllowSelfRegistration in interface SettingsInterface

Parameters:

allowSelfRegistration - Change whether self-registration is enabled

Throws:

UserException

ServerException

setAllowUsersToCreateTopLevelProjects

public void setAllowUsersToCreateTopLevelProjects(Boolean allowUsersToCreateTopLevelProjects)
                                           throws UserException,
                                                  ServerException

Specified by:

setAllowUsersToCreateTopLevelProjects in interface SettingsInterface

Parameters:

allowUsersToCreateTopLevelProjects - Set if users can create top level projects

Throws:

UserException

ServerException

setCacheOutputFiles

public void setCacheOutputFiles(Boolean cacheOutputFiles)
                         throws UserException,
                                ServerException

Specified by:

setCacheOutputFiles in interface SettingsInterface

Parameters:

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

Throws:

UserException

ServerException

setCheckinMergingEnabled

public void setCheckinMergingEnabled(Boolean checkinMergingEnabled)
                              throws UserException,
                                     ServerException

Specified by:

setCheckinMergingEnabled in interface SettingsInterface

Parameters:

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

Throws:

UserException

ServerException

setEmailSenderAddress

public void setEmailSenderAddress(String emailSenderAddress)
                           throws UserException,
                                  ServerException

Specified by:

setEmailSenderAddress in interface SettingsInterface

Parameters:

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

Throws:

UserException

ServerException

setGenerateGeometryOnCheckin

public void setGenerateGeometryOnCheckin(Boolean generateGeometryOnCheckin)
                                  throws UserException,
                                         ServerException

Specified by:

setGenerateGeometryOnCheckin in interface SettingsInterface

Throws:

UserException

ServerException

setHideUserListForNonAdmin

public void setHideUserListForNonAdmin(Boolean hideUserListForNonAdmin)
                                throws UserException,
                                       ServerException

Specified by:

setHideUserListForNonAdmin in interface SettingsInterface

Parameters:

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

Throws:

UserException

ServerException

setProtocolBuffersPort

public void setProtocolBuffersPort(Integer port)
                            throws UserException,
                                   ServerException

Specified by:

setProtocolBuffersPort in interface SettingsInterface

Parameters:

port - Set the port the ProtocolBuffers server runs on

Throws:

UserException

ServerException

setSendConfirmationEmailAfterRegistration

public void setSendConfirmationEmailAfterRegistration(Boolean sendConfirmationEmailAfterRegistration)
                                               throws UserException,
                                                      ServerException

Specified by:

setSendConfirmationEmailAfterRegistration in interface SettingsInterface

Parameters:

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

Throws:

UserException

ServerException

setServerSettings

public void setServerSettings(SServerSettings serverSettings)
                       throws UserException,
                              ServerException

Description copied from interface: SettingsInterface

With this method you can set all server settings at once

Specified by:

setServerSettings in interface SettingsInterface

Throws:

UserException

ServerException

setServiceRepositoryUrl

public void setServiceRepositoryUrl(String url)
                             throws UserException,
                                    ServerException

Specified by:

setServiceRepositoryUrl in interface SettingsInterface

Parameters:

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

Throws:

UserException

ServerException

setSiteAddress

public void setSiteAddress(String siteAddress)
                    throws UserException,
                           ServerException

Specified by:

setSiteAddress in interface SettingsInterface

Parameters:

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

Throws:

UserException

ServerException

setSmtpServer

public void setSmtpServer(String smtpServer)
                   throws UserException,
                          ServerException

Specified by:

setSmtpServer in interface SettingsInterface

Parameters:

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

Throws:

UserException

ServerException

setWhiteListedDomains

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

Description copied from interface: SettingsInterface

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

Specified by:

setWhiteListedDomains in interface SettingsInterface

Throws:

UserException

ServerException