org.bimserver.shared.interfaces

Interface AdminInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

AdminInterfaceAdaptor

public interface AdminInterface
extends PublicInterface

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)

Method Detail

getAllPlugins

List<SPluginDescriptor> getAllPlugins()
                               throws ServerException,
                                      UserException

Get a list of all plugins

Returns:

A list of all plugins

Throws:

ServerException, - UserException

ServerException

UserException

enablePlugin

void enablePlugin(String name)
           throws ServerException,
                  UserException

Enable a plugin

Parameters:

name - Name of the plugin to enable

Throws:

ServerException, - UserException

ServerException

UserException

disablePlugin

void disablePlugin(String name)
            throws ServerException,
                   UserException

Disable a plugin

Parameters:

name - Name of the plugin to disable

Throws:

ServerException, - UserException

ServerException

UserException

getDatabaseInformation

SDatabaseInformation getDatabaseInformation()
                                     throws ServerException,
                                            UserException

Get information about the BIMserver database

Returns:

A SDatabaseInformation Object containing the information

Throws:

ServerException, - UserException

ServerException

UserException

getLastDatabaseReset

Date getLastDatabaseReset()
                   throws ServerException,
                          UserException

Get information about the last database reset

Returns:

When the last database reset occurred

Throws:

ServerException, - UserException

ServerException

UserException

setup

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

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.

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:

ServerException, - UserException

ServerException

UserException

getLogs

List<SLogAction> getLogs()
                  throws ServerException,
                         UserException

Get a list of logged actions

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

getMigrations

List<SMigration> getMigrations()
                        throws ServerException,
                               UserException

Get a list of all migrations

Returns:

A list of all Migrations (either executed or not)

Throws:

ServerException, - UserException

ServerException

UserException

migrateDatabase

void migrateDatabase()
              throws ServerException,
                     UserException

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

Throws:

ServerException, - UserException

ServerException

UserException

getServerInfo

SServerInfo getServerInfo()
                   throws ServerException,
                          UserException

Get information about this BIMserver's state

Returns:

A SServerInfo object containing information about the current state

Throws:

ServerException, - UserException

ServerException

UserException

getServerLog

String getServerLog()
             throws ServerException,
                    UserException

Get the BIMserver log

Returns:

The BIMserver log (can be big)

Throws:

ServerException

UserException

clearOutputFileCache

Integer clearOutputFileCache()
                      throws UserException,
                             ServerException

Initiate clearing the output cache

Returns:

The amount of removed files

Throws:

UserException

ServerException

getSystemInfo

SSystemInfo getSystemInfo()
                   throws UserException,
                          ServerException

Get information about the system this BIMserver is running on

Returns:

A SSystemInfo object

Throws:

UserException

ServerException

getJavaInfo

SJavaInfo getJavaInfo()
               throws UserException,
                      ServerException

Get information about the Java environment this BIMserver is running on

Returns:

A SJavaInfo object

Throws:

UserException

ServerException

getBimServerInfo

SBimServerInfo getBimServerInfo()
                         throws ServerException,
                                UserException

Get information about this BIMserver

Returns:

A SBimServerInfo object

Throws:

ServerException

UserException

getProtocolBuffersFile

String getProtocolBuffersFile(String interfaceName)
                       throws ServerException,
                              UserException

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

Returns:

A serialized version of the .proto file

Throws:

ServerException, - UserException

ServerException

UserException

getVersion

SVersion getVersion()
             throws ServerException,
                    UserException

Get the actual version of this BIMserver

Returns:

A SVersion object containg the version information

Throws:

ServerException, - UserException

ServerException

UserException

getLatestVersion

SVersion getLatestVersion()
                   throws ServerException,
                          UserException

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

Returns:

A SVersion object containing the version information

Throws:

ServerException, - UserException

ServerException

UserException

upgradePossible

Boolean upgradePossible()
                 throws ServerException,
                        UserException

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

Returns:

Whether a new version is available

Throws:

ServerException, - UserException

ServerException

UserException

getServerStartTime

Date getServerStartTime()
                 throws ServerException,
                        UserException

Get the date when this BIMserver was last started

Returns:

The Date when the BIMserver was last started

Throws:

ServerException, - UserException

ServerException

UserException

regenerateGeometry

void regenerateGeometry(Long croid)
                 throws ServerException,
                        UserException

Regenerate the geometry for a specified croid

Throws:

ServerException, - UserException

ServerException

UserException

getMetrics

SMetrics getMetrics()
             throws UserException,
                    ServerException

Throws:

UserException

ServerException