org.bimserver.shared.interfaces

Interface RemoteServiceInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

RemoteServiceInterfaceAdaptor

public interface RemoteServiceInterface
extends PublicInterface

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

Method Detail

newRevision

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

This method gets called when a new revision has been created

Parameters:

poid - ProjectID

roid - RevisionID

soid - ServiceID (optional)

serviceIdentifier -

profileIdentifier -

userToken -

token -

apiUrl -

Throws:

UserException

ServerException

newExtendedDataOnProject

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

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

Parameters:

poid - ProjectID

edid - ExtendedDataID

soid - ServiceID (optional)

serviceIdentifier -

profileIdentifier -

userToken -

token -

apiUrl -

Throws:

UserException

ServerException

newExtendedDataOnRevision

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

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

Parameters:

poid -

roid -

edid -

soid -

serviceIdentifier -

profileIdentifier -

userToken -

token -

apiUrl -

Throws:

UserException

ServerException

getPublicProfiles

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

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

Parameters:

serviceIdentifier -

Returns:

Throws:

UserException

ServerException

getPrivateProfiles

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

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

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

getService

SServiceDescriptor getService(String serviceIdentifier)
                       throws UserException,
                              ServerException

Should return a description of a certain service

Parameters:

serviceIdentifier - Unique service identifier

Returns:

Throws:

UserException

ServerException