org.bimserver.shared.interfaces

Class AdminInterfaceAdaptor

java.lang.Object

org.bimserver.shared.interfaces.AdminInterfaceAdaptor

All Implemented Interfaces:

AdminInterface, PublicInterface

public class AdminInterfaceAdaptor
extends Object
implements AdminInterface

Constructor Summary

Constructors

Constructor and Description
AdminInterfaceAdaptor()

Method Summary

Modifier and Type	Method and Description
Integer	clearOutputFileCache() Initiate clearing the output cache
void	disablePlugin(String name) Disable a plugin
void	enablePlugin(String name) Enable a plugin
List<SPluginDescriptor>	getAllPlugins() Get a list of all plugins
SBimServerInfo	getBimServerInfo() Get information about this BIMserver
SDatabaseInformation	getDatabaseInformation() Get information about the BIMserver database
SJavaInfo	getJavaInfo() Get information about the Java environment this BIMserver is running on
Date	getLastDatabaseReset() Get information about the last database reset
SVersion	getLatestVersion() Check which version of BIMserver is the latest available (will download an XML file from bimserver.org)
List<SLogAction>	getLogs() Get a list of logged actions
SMetrics	getMetrics()
List<SMigration>	getMigrations() Get a list of all migrations
String	getProtocolBuffersFile(String interfaceName) This will return the content of the .proto file (equivalent for SOAP's WSDL) for the ProtocolBuffers interface
SServerInfo	getServerInfo() Get information about this BIMserver's state
String	getServerLog() Get the BIMserver log
Date	getServerStartTime() Get the date when this BIMserver was last started
SSystemInfo	getSystemInfo() Get information about the system this BIMserver is running on
SVersion	getVersion() Get the actual version of this BIMserver
void	migrateDatabase() This will try to upgrade the database to the latest revision, this method will do nothing if the database schema is already up-to-date
void	regenerateGeometry(Long croid) Regenerate the geometry for a specified croid
void	setup(String siteAddress, String smtpServer, String smtpSender, String adminName, String adminUsername, String adminPassword) Setup this BIMserver.
Boolean	upgradePossible() Check whether an upgrade of the BIMserver is available (will download an XML file from bimserver.org)

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminInterfaceAdaptor

public AdminInterfaceAdaptor()

Method Detail

clearOutputFileCache

public Integer clearOutputFileCache()
                             throws UserException,
                                    ServerException

Description copied from interface: AdminInterface

Initiate clearing the output cache

Specified by:

clearOutputFileCache in interface AdminInterface

Returns:

The amount of removed files

Throws:

UserException

ServerException

disablePlugin

public void disablePlugin(String name)
                   throws UserException,
                          ServerException

Description copied from interface: AdminInterface

Disable a plugin

Specified by:

disablePlugin in interface AdminInterface

Parameters:

name - Name of the plugin to disable

Throws:

UserException

ServerException

enablePlugin

public void enablePlugin(String name)
                  throws UserException,
                         ServerException

Description copied from interface: AdminInterface

Enable a plugin

Specified by:

enablePlugin in interface AdminInterface

Parameters:

name - Name of the plugin to enable

Throws:

UserException

ServerException

getAllPlugins

public List<SPluginDescriptor> getAllPlugins()
                                      throws UserException,
                                             ServerException

Description copied from interface: AdminInterface

Get a list of all plugins

Specified by:

getAllPlugins in interface AdminInterface

Returns:

A list of all plugins

Throws:

UserException

ServerException

getBimServerInfo

public SBimServerInfo getBimServerInfo()
                                throws UserException,
                                       ServerException

Description copied from interface: AdminInterface

Get information about this BIMserver

Specified by:

getBimServerInfo in interface AdminInterface

Returns:

A SBimServerInfo object

Throws:

UserException

ServerException

getDatabaseInformation

public SDatabaseInformation getDatabaseInformation()
                                            throws UserException,
                                                   ServerException

Description copied from interface: AdminInterface

Get information about the BIMserver database

Specified by:

getDatabaseInformation in interface AdminInterface

Returns:

A SDatabaseInformation Object containing the information

Throws:

UserException

ServerException

getJavaInfo

public SJavaInfo getJavaInfo()
                      throws UserException,
                             ServerException

Description copied from interface: AdminInterface

Get information about the Java environment this BIMserver is running on

Specified by:

getJavaInfo in interface AdminInterface

Returns:

A SJavaInfo object

Throws:

UserException

ServerException

getLastDatabaseReset

public Date getLastDatabaseReset()
                          throws UserException,
                                 ServerException

Description copied from interface: AdminInterface

Get information about the last database reset

Specified by:

getLastDatabaseReset in interface AdminInterface

Returns:

When the last database reset occurred

Throws:

UserException

ServerException

getLatestVersion

public SVersion getLatestVersion()
                          throws UserException,
                                 ServerException

Description copied from interface: AdminInterface

Check which version of BIMserver is the latest available (will download an XML file from bimserver.org)

Specified by:

getLatestVersion in interface AdminInterface

Returns:

A SVersion object containing the version information

Throws:

UserException

ServerException

getLogs

public List<SLogAction> getLogs()
                         throws UserException,
                                ServerException

Description copied from interface: AdminInterface

Get a list of logged actions

Specified by:

getLogs in interface AdminInterface

Returns:

A list with all Log objects, Log objects contain information about action performed on the BIMserver like ProjectAdded, UserAdded etc...

Throws:

UserException

ServerException

getMetrics

public SMetrics getMetrics()
                    throws UserException,
                           ServerException

Specified by:

getMetrics in interface AdminInterface

Throws:

UserException

ServerException

getMigrations

public List<SMigration> getMigrations()
                               throws UserException,
                                      ServerException

Description copied from interface: AdminInterface

Get a list of all migrations

Specified by:

getMigrations in interface AdminInterface

Returns:

A list of all Migrations (either executed or not)

Throws:

UserException

ServerException

getProtocolBuffersFile

public String getProtocolBuffersFile(String interfaceName)
                              throws UserException,
                                     ServerException

Description copied from interface: AdminInterface

This will return the content of the .proto file (equivalent for SOAP's WSDL) for the ProtocolBuffers interface

Specified by:

getProtocolBuffersFile in interface AdminInterface

Returns:

A serialized version of the .proto file

Throws:

UserException

ServerException

getServerInfo

public SServerInfo getServerInfo()
                          throws UserException,
                                 ServerException

Description copied from interface: AdminInterface

Get information about this BIMserver's state

Specified by:

getServerInfo in interface AdminInterface

Returns:

A SServerInfo object containing information about the current state

Throws:

UserException

ServerException

getServerLog

public String getServerLog()
                    throws UserException,
                           ServerException

Description copied from interface: AdminInterface

Get the BIMserver log

Specified by:

getServerLog in interface AdminInterface

Returns:

The BIMserver log (can be big)

Throws:

ServerException

UserException

getServerStartTime

public Date getServerStartTime()
                        throws UserException,
                               ServerException

Description copied from interface: AdminInterface

Get the date when this BIMserver was last started

Specified by:

getServerStartTime in interface AdminInterface

Returns:

The Date when the BIMserver was last started

Throws:

UserException

ServerException

getSystemInfo

public SSystemInfo getSystemInfo()
                          throws UserException,
                                 ServerException

Description copied from interface: AdminInterface

Get information about the system this BIMserver is running on

Specified by:

getSystemInfo in interface AdminInterface

Returns:

A SSystemInfo object

Throws:

UserException

ServerException

getVersion

public SVersion getVersion()
                    throws UserException,
                           ServerException

Description copied from interface: AdminInterface

Get the actual version of this BIMserver

Specified by:

getVersion in interface AdminInterface

Returns:

A SVersion object containg the version information

Throws:

UserException

ServerException

migrateDatabase

public void migrateDatabase()
                     throws UserException,
                            ServerException

Description copied from interface: AdminInterface

This will try to upgrade the database to the latest revision, this method will do nothing if the database schema is already up-to-date

Specified by:

migrateDatabase in interface AdminInterface

Throws:

UserException

ServerException

regenerateGeometry

public void regenerateGeometry(Long croid)
                        throws UserException,
                               ServerException

Description copied from interface: AdminInterface

Regenerate the geometry for a specified croid

Specified by:

regenerateGeometry in interface AdminInterface

Throws:

UserException

ServerException

setup

public void setup(String siteAddress,
                  String smtpServer,
                  String smtpSender,
                  String adminName,
                  String adminUsername,
                  String adminPassword)
           throws UserException,
                  ServerException

Description copied from interface: AdminInterface

Setup this BIMserver. This BIMserver will not be available until you execute this method successfully. You can only do this once. After initial setup, use the methods provided by the SettingsInterface to change values.

Specified by:

setup in interface AdminInterface

Parameters:

siteAddress - The address the server will be reachable at (for example: http://demo.bimserver.org)

smtpServer - The address of the SMTP server that wil be used for sending e-mails

adminName - Name of the admin User (e.g. "Administrator")

adminUsername - Username of the admin User (must be a valid e-mail address)

adminPassword - Password of the admin User

Throws:

UserException

ServerException

upgradePossible

public Boolean upgradePossible()
                        throws UserException,
                               ServerException

Description copied from interface: AdminInterface

Check whether an upgrade of the BIMserver is available (will download an XML file from bimserver.org)

Specified by:

upgradePossible in interface AdminInterface

Returns:

Whether a new version is available

Throws:

UserException

ServerException