org.bimserver.shared.interfaces

Class RemoteServiceInterfaceAdaptor

java.lang.Object

org.bimserver.shared.interfaces.RemoteServiceInterfaceAdaptor

All Implemented Interfaces:

PublicInterface, RemoteServiceInterface

public class RemoteServiceInterfaceAdaptor
extends Object
implements RemoteServiceInterface

Constructor Summary

Constructors

Constructor and Description
RemoteServiceInterfaceAdaptor()

Method Summary

Modifier and Type	Method and Description
List<SProfileDescriptor>	getPrivateProfiles(String serviceIdentifier, String token) A remote server should be able to provide a list of profiles
List<SProfileDescriptor>	getPublicProfiles(String serviceIdentifier) A remote server should be able to provide a list of profiles.
SServiceDescriptor	getService(String serviceIdentifier) Should return a description of a certain service
void	newExtendedDataOnProject(Long poid, Long edid, Long soid, String serviceIdentifier, String profileIdentifier, String userToken, String token, String apiUrl) This method gets called when new extended data has been added to a project
void	newExtendedDataOnRevision(Long poid, Long roid, Long edid, Long soid, String serviceIdentifier, String profileIdentifier, String userToken, String token, String apiUrl) This method gets called when new extended data has been added to a revision
void	newRevision(Long poid, Long roid, Long soid, String serviceIdentifier, String profileIdentifier, String userToken, String token, String apiUrl) This method gets called when a new revision has been created

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteServiceInterfaceAdaptor

public RemoteServiceInterfaceAdaptor()

Method Detail

getPrivateProfiles

public List<SProfileDescriptor> getPrivateProfiles(String serviceIdentifier,
                                                   String token)
                                            throws UserException,
                                                   ServerException

Description copied from interface: RemoteServiceInterface

A remote server should be able to provide a list of profiles

Specified by:

getPrivateProfiles in interface RemoteServiceInterface

Parameters:

serviceIdentifier - A unique service identifier, defined by the remote server

token - A token the remote server can use to identify the user

Returns:

Throws:

UserException

ServerException

getPublicProfiles

public List<SProfileDescriptor> getPublicProfiles(String serviceIdentifier)
                                           throws UserException,
                                                  ServerException

Description copied from interface: RemoteServiceInterface

A remote server should be able to provide a list of profiles. This method returns the public profiles that do not need authentication

Specified by:

getPublicProfiles in interface RemoteServiceInterface

Returns:

Throws:

UserException

ServerException

getService

public SServiceDescriptor getService(String serviceIdentifier)
                              throws UserException,
                                     ServerException

Description copied from interface: RemoteServiceInterface

Should return a description of a certain service

Specified by:

getService in interface RemoteServiceInterface

Parameters:

serviceIdentifier - Unique service identifier

Returns:

Throws:

UserException

ServerException

newExtendedDataOnProject

public void newExtendedDataOnProject(Long poid,
                                     Long edid,
                                     Long soid,
                                     String serviceIdentifier,
                                     String profileIdentifier,
                                     String userToken,
                                     String token,
                                     String apiUrl)
                              throws UserException,
                                     ServerException

Description copied from interface: RemoteServiceInterface

This method gets called when new extended data has been added to a project

Specified by:

newExtendedDataOnProject in interface RemoteServiceInterface

Parameters:

poid - ProjectID

edid - ExtendedDataID

soid - ServiceID (optional)

Throws:

UserException

ServerException

newExtendedDataOnRevision

public void newExtendedDataOnRevision(Long poid,
                                      Long roid,
                                      Long edid,
                                      Long soid,
                                      String serviceIdentifier,
                                      String profileIdentifier,
                                      String userToken,
                                      String token,
                                      String apiUrl)
                               throws UserException,
                                      ServerException

Description copied from interface: RemoteServiceInterface

This method gets called when new extended data has been added to a revision

Specified by:

newExtendedDataOnRevision in interface RemoteServiceInterface

Throws:

UserException

ServerException

newRevision

public void newRevision(Long poid,
                        Long roid,
                        Long soid,
                        String serviceIdentifier,
                        String profileIdentifier,
                        String userToken,
                        String token,
                        String apiUrl)
                 throws UserException,
                        ServerException

Description copied from interface: RemoteServiceInterface

This method gets called when a new revision has been created

Specified by:

newRevision in interface RemoteServiceInterface

Parameters:

poid - ProjectID

roid - RevisionID

soid - ServiceID (optional)

Throws:

UserException

ServerException