org.bimserver.plugins.services

Interface BimServerClientInterface

All Superinterfaces:

AutoCloseable, ServiceHolder

public interface BimServerClientInterface
extends ServiceHolder, AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	authenticate()
long	checkin(long poid, String comment, long deserializerOid, boolean merge, Flow flow, long fileSize, String filename, InputStream inputStream)
long	checkin(long poid, String string, long deserializerOid, boolean merge, Flow flow, Path file)
long	checkin(long poid, String comment, long deserializerOid, boolean merge, Flow flow, URL url)
void	commit(IfcModelInterface model, String comment)
void	disconnect() This will close all the connections, call this method as soon as you are done using this BimServerClient
void	download(long roid, long serializerOid, OutputStream outputStream)
void	download(long roid, long serializerOid, Path file)
void	download(long roid, Query query, long serializerOid, Path file)
void	download(long roid, String query, long oid, Path file)
AuthInterface	getBimServerAuthInterface()
InputStream	getDownloadData(long topicId) Convenience method that given you the InputStream belonging to an already started download
Geometry	getGeometry(long roid, IdEObject ifcProduct) Get the geometry for the given revision/product, this method is not tested
MetaDataManager	getMetaDataManager()
IfcModelInterface	getModel(SProject project, long roid, boolean deep, boolean recordChanges)
IfcModelInterface	getModel(SProject project, long roid, boolean deep, boolean recordChanges, boolean includeGeometry)
NotificationRegistryInterface	getNotificationRegistryInterface()
RemoteServiceInterface	getRemoteServiceInterface()
IfcModelInterface	newModel(SProject newProject, boolean recordChanges)
void	saveDownloadData(long topicId, Path path)
void	setAuthentication(AuthenticationInfo authenticationInfo)

Methods inherited from interface org.bimserver.shared.ServiceHolder

get, getAdminInterface, getAuthInterface, getLowLevelInterface, getMeta, getNewServicesInterface, getPluginInterface, getRegistry, getServiceInterface, getSettingsInterface

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getModel

IfcModelInterface getModel(SProject project,
                           long roid,
                           boolean deep,
                           boolean recordChanges,
                           boolean includeGeometry)
                    throws BimServerClientException,
                           UserException,
                           ServerException,
                           PublicInterfaceNotFoundException

Throws:

BimServerClientException

UserException

ServerException

PublicInterfaceNotFoundException

getModel

IfcModelInterface getModel(SProject project,
                           long roid,
                           boolean deep,
                           boolean recordChanges)
                    throws BimServerClientException,
                           UserException,
                           ServerException,
                           PublicInterfaceNotFoundException

Throws:

BimServerClientException

UserException

ServerException

PublicInterfaceNotFoundException

newModel

IfcModelInterface newModel(SProject newProject,
                           boolean recordChanges)
                    throws ServerException,
                           UserException,
                           BimServerClientException,
                           PublicInterfaceNotFoundException

Throws:

ServerException

UserException

BimServerClientException

PublicInterfaceNotFoundException

commit

void commit(IfcModelInterface model,
            String comment)

download

void download(long roid,
              long serializerOid,
              OutputStream outputStream)
       throws BimServerClientException

Throws:

BimServerClientException

download

void download(long roid,
              long serializerOid,
              Path file)
       throws IOException,
              BimServerClientException

Throws:

IOException

BimServerClientException

download

void download(long roid,
              Query query,
              long serializerOid,
              Path file)
       throws IOException,
              BimServerClientException

Throws:

IOException

BimServerClientException

checkin

long checkin(long poid,
             String string,
             long deserializerOid,
             boolean merge,
             Flow flow,
             Path file)
      throws IOException,
             UserException,
             ServerException

Throws:

IOException

UserException

ServerException

getDownloadData

InputStream getDownloadData(long topicId)
                     throws IOException

Convenience method that given you the InputStream belonging to an already started download

Parameters:

download -

serializerOid -

Returns:

Throws:

IOException

saveDownloadData

void saveDownloadData(long topicId,
                      Path path)
               throws IOException

Throws:

IOException

setAuthentication

void setAuthentication(AuthenticationInfo authenticationInfo)
                throws ServerException,
                       UserException,
                       ChannelConnectionException

Throws:

ServerException

UserException

ChannelConnectionException

getGeometry

Geometry getGeometry(long roid,
                     IdEObject ifcProduct)

Get the geometry for the given revision/product, this method is not tested

Parameters:

roid -

ifcProduct -

Returns:

getBimServerAuthInterface

AuthInterface getBimServerAuthInterface()
                                 throws PublicInterfaceNotFoundException

Throws:

PublicInterfaceNotFoundException

getRemoteServiceInterface

RemoteServiceInterface getRemoteServiceInterface()
                                          throws PublicInterfaceNotFoundException

Throws:

PublicInterfaceNotFoundException

getNotificationRegistryInterface

NotificationRegistryInterface getNotificationRegistryInterface()
                                                        throws PublicInterfaceNotFoundException

Throws:

PublicInterfaceNotFoundException

disconnect

void disconnect()

This will close all the connections, call this method as soon as you are done using this BimServerClient

getMetaDataManager

MetaDataManager getMetaDataManager()

checkin

long checkin(long poid,
             String comment,
             long deserializerOid,
             boolean merge,
             Flow flow,
             URL url)
      throws UserException,
             ServerException

Throws:

UserException

ServerException

download

void download(long roid,
              String query,
              long oid,
              Path file)
       throws ServerException,
              UserException,
              PublicInterfaceNotFoundException,
              IOException

Throws:

ServerException

UserException

PublicInterfaceNotFoundException

IOException

checkin

long checkin(long poid,
             String comment,
             long deserializerOid,
             boolean merge,
             Flow flow,
             long fileSize,
             String filename,
             InputStream inputStream)
      throws UserException,
             ServerException

Throws:

UserException

ServerException

authenticate

void authenticate()
           throws ServerException,
                  UserException

Throws:

ServerException

UserException