org.bimserver.shared.interfaces

Class NotificationRegistryInterfaceAdaptor

java.lang.Object

org.bimserver.shared.interfaces.NotificationRegistryInterfaceAdaptor

All Implemented Interfaces:

NotificationRegistryInterface, PublicInterface

public class NotificationRegistryInterfaceAdaptor
extends Object
implements NotificationRegistryInterface

Constructor Summary

Constructors

Constructor and Description
NotificationRegistryInterfaceAdaptor()

Method Summary

Modifier and Type	Method and Description
SLongActionState	getProgress(Long topicId)
List<Long>	getProgressTopicsOnProject(Long poid)
List<Long>	getProgressTopicsOnRevision(Long poid, Long roid)
List<Long>	getProgressTopicsOnServer()
void	registerChangeProgressOnProject(Long endPointId, Long poid)
void	registerChangeProgressOnRevision(Long endPointId, Long roid, Long poid)
void	registerChangeProgressOnServer(Long endPointId)
void	registerNewExtendedDataOnRevisionHandler(Long endPointId, Long roid) Register the given endpoint to be notified about extended data being added to the given revision
void	registerNewProjectHandler(Long endPointId) Register this endpoint to be notified when a project has been added
void	registerNewRevisionHandler(Long endPointId) Register the given endpoint to be notified about new revisions
void	registerNewRevisionOnSpecificProjectHandler(Long endPointId, Long poid) Register the given endpoint to be notified about new revisions on the given project
void	registerNewUserHandler(Long endPointId) Register this endpoint to be notified when a new user has been added
void	registerProgressHandler(Long topicId, Long endPointId)
Long	registerProgressOnProjectTopic(SProgressTopicType type, Long poid, String description) Register a new progress topic that is related to the given project
Long	registerProgressOnRevisionTopic(SProgressTopicType type, Long poid, Long roid, String description)
Long	registerProgressTopic(SProgressTopicType type, String description) Register a progress topic, remember to unregister with unregisterProgressTopic when done
void	unregisterChangeProgressOnProject(Long endPointId, Long poid)
void	unregisterChangeProgressOnRevision(Long endPointId, Long roid, Long poid)
void	unregisterChangeProgressOnServer(Long endPointId)
void	unregisterNewExtendedDataOnRevisionHandler(Long endPointId, Long roid) Unregister, called after registerNewExtendedDataOnRevisionHandler
void	unregisterNewProjectHandler(Long endPointId) Unregister this endpoint to be notified when a project has been added
void	unregisterNewRevisionHandler(Long endPointId)
void	unregisterNewRevisionOnSpecificProjectHandler(Long endPointId, Long poid)
void	unregisterNewUserHandler(Long endPointId) Unregister this endpoint to be notified when a new user has been added
void	unregisterProgressHandler(Long topicId, Long endPointId)
void	unregisterProgressTopic(Long topicId) Unregister a progress topic on this server
void	updateProgressTopic(Long topicId, SLongActionState state) Update the progress information on the given topic

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationRegistryInterfaceAdaptor

public NotificationRegistryInterfaceAdaptor()

Method Detail

getProgress

public SLongActionState getProgress(Long topicId)
                             throws UserException,
                                    ServerException

Specified by:

getProgress in interface NotificationRegistryInterface

Returns:

Throws:

UserException

ServerException

getProgressTopicsOnProject

public List<Long> getProgressTopicsOnProject(Long poid)
                                      throws UserException,
                                             ServerException

Specified by:

getProgressTopicsOnProject in interface NotificationRegistryInterface

Returns:

Throws:

UserException

ServerException

getProgressTopicsOnRevision

public List<Long> getProgressTopicsOnRevision(Long poid,
                                              Long roid)
                                       throws UserException,
                                              ServerException

Specified by:

getProgressTopicsOnRevision in interface NotificationRegistryInterface

Returns:

Throws:

UserException

ServerException

getProgressTopicsOnServer

public List<Long> getProgressTopicsOnServer()
                                     throws UserException,
                                            ServerException

Specified by:

getProgressTopicsOnServer in interface NotificationRegistryInterface

Returns:

Throws:

UserException

ServerException

registerChangeProgressOnProject

public void registerChangeProgressOnProject(Long endPointId,
                                            Long poid)
                                     throws UserException,
                                            ServerException

Specified by:

registerChangeProgressOnProject in interface NotificationRegistryInterface

Throws:

UserException

ServerException

registerChangeProgressOnRevision

public void registerChangeProgressOnRevision(Long endPointId,
                                             Long roid,
                                             Long poid)
                                      throws UserException,
                                             ServerException

Specified by:

registerChangeProgressOnRevision in interface NotificationRegistryInterface

Throws:

UserException

ServerException

registerChangeProgressOnServer

public void registerChangeProgressOnServer(Long endPointId)
                                    throws UserException,
                                           ServerException

Specified by:

registerChangeProgressOnServer in interface NotificationRegistryInterface

Throws:

UserException

ServerException

registerNewExtendedDataOnRevisionHandler

public void registerNewExtendedDataOnRevisionHandler(Long endPointId,
                                                     Long roid)
                                              throws UserException,
                                                     ServerException

Description copied from interface: NotificationRegistryInterface

Register the given endpoint to be notified about extended data being added to the given revision

Specified by:

registerNewExtendedDataOnRevisionHandler in interface NotificationRegistryInterface

Parameters:

endPointId - EndPointID

roid - Revision OID

Throws:

UserException

ServerException

registerNewProjectHandler

public void registerNewProjectHandler(Long endPointId)
                               throws UserException,
                                      ServerException

Description copied from interface: NotificationRegistryInterface

Register this endpoint to be notified when a project has been added

Specified by:

registerNewProjectHandler in interface NotificationRegistryInterface

Throws:

UserException

ServerException

registerNewRevisionHandler

public void registerNewRevisionHandler(Long endPointId)
                                throws UserException,
                                       ServerException

Description copied from interface: NotificationRegistryInterface

Register the given endpoint to be notified about new revisions

Specified by:

registerNewRevisionHandler in interface NotificationRegistryInterface

Parameters:

endPointId - EndPointID

Throws:

UserException

ServerException

registerNewRevisionOnSpecificProjectHandler

public void registerNewRevisionOnSpecificProjectHandler(Long endPointId,
                                                        Long poid)
                                                 throws UserException,
                                                        ServerException

Description copied from interface: NotificationRegistryInterface

Register the given endpoint to be notified about new revisions on the given project

Specified by:

registerNewRevisionOnSpecificProjectHandler in interface NotificationRegistryInterface

Parameters:

endPointId - EndPointID

poid - Project OID

Throws:

UserException

ServerException

registerNewUserHandler

public void registerNewUserHandler(Long endPointId)
                            throws UserException,
                                   ServerException

Description copied from interface: NotificationRegistryInterface

Register this endpoint to be notified when a new user has been added

Specified by:

registerNewUserHandler in interface NotificationRegistryInterface

Throws:

UserException

ServerException

registerProgressHandler

public void registerProgressHandler(Long topicId,
                                    Long endPointId)
                             throws UserException,
                                    ServerException

Specified by:

registerProgressHandler in interface NotificationRegistryInterface

Parameters:

topicId - Register an endpoint to be notified of update on the given (progress) topic

endPointId - EndPointID, which identifies the endpoint

Throws:

UserException

ServerException

registerProgressOnProjectTopic

public Long registerProgressOnProjectTopic(SProgressTopicType type,
                                           Long poid,
                                           String description)
                                    throws UserException,
                                           ServerException

Description copied from interface: NotificationRegistryInterface

Register a new progress topic that is related to the given project

Specified by:

registerProgressOnProjectTopic in interface NotificationRegistryInterface

Returns:

Throws:

UserException

ServerException

registerProgressOnRevisionTopic

public Long registerProgressOnRevisionTopic(SProgressTopicType type,
                                            Long poid,
                                            Long roid,
                                            String description)
                                     throws UserException,
                                            ServerException

Specified by:

registerProgressOnRevisionTopic in interface NotificationRegistryInterface

Returns:

Throws:

UserException

ServerException

registerProgressTopic

public Long registerProgressTopic(SProgressTopicType type,
                                  String description)
                           throws UserException,
                                  ServerException

Description copied from interface: NotificationRegistryInterface

Register a progress topic, remember to unregister with unregisterProgressTopic when done

Specified by:

registerProgressTopic in interface NotificationRegistryInterface

Parameters:

type - The type of progress

description - A description of the running service

Returns:

A TopicID, which can be used by updateProgressTopic

Throws:

UserException

ServerException

unregisterChangeProgressOnProject

public void unregisterChangeProgressOnProject(Long endPointId,
                                              Long poid)
                                       throws UserException,
                                              ServerException

Specified by:

unregisterChangeProgressOnProject in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterChangeProgressOnRevision

public void unregisterChangeProgressOnRevision(Long endPointId,
                                               Long roid,
                                               Long poid)
                                        throws UserException,
                                               ServerException

Specified by:

unregisterChangeProgressOnRevision in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterChangeProgressOnServer

public void unregisterChangeProgressOnServer(Long endPointId)
                                      throws UserException,
                                             ServerException

Specified by:

unregisterChangeProgressOnServer in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterNewExtendedDataOnRevisionHandler

public void unregisterNewExtendedDataOnRevisionHandler(Long endPointId,
                                                       Long roid)
                                                throws UserException,
                                                       ServerException

Description copied from interface: NotificationRegistryInterface

Unregister, called after registerNewExtendedDataOnRevisionHandler

Specified by:

unregisterNewExtendedDataOnRevisionHandler in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterNewProjectHandler

public void unregisterNewProjectHandler(Long endPointId)
                                 throws UserException,
                                        ServerException

Description copied from interface: NotificationRegistryInterface

Unregister this endpoint to be notified when a project has been added

Specified by:

unregisterNewProjectHandler in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterNewRevisionHandler

public void unregisterNewRevisionHandler(Long endPointId)
                                  throws UserException,
                                         ServerException

Specified by:

unregisterNewRevisionHandler in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterNewRevisionOnSpecificProjectHandler

public void unregisterNewRevisionOnSpecificProjectHandler(Long endPointId,
                                                          Long poid)
                                                   throws UserException,
                                                          ServerException

Specified by:

unregisterNewRevisionOnSpecificProjectHandler in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterNewUserHandler

public void unregisterNewUserHandler(Long endPointId)
                              throws UserException,
                                     ServerException

Description copied from interface: NotificationRegistryInterface

Unregister this endpoint to be notified when a new user has been added

Specified by:

unregisterNewUserHandler in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterProgressHandler

public void unregisterProgressHandler(Long topicId,
                                      Long endPointId)
                               throws UserException,
                                      ServerException

Specified by:

unregisterProgressHandler in interface NotificationRegistryInterface

Throws:

UserException

ServerException

unregisterProgressTopic

public void unregisterProgressTopic(Long topicId)
                             throws UserException,
                                    ServerException

Description copied from interface: NotificationRegistryInterface

Unregister a progress topic on this server

Specified by:

unregisterProgressTopic in interface NotificationRegistryInterface

Parameters:

topicId - TopicID

Throws:

UserException

ServerException

updateProgressTopic

public void updateProgressTopic(Long topicId,
                                SLongActionState state)
                         throws UserException,
                                ServerException

Description copied from interface: NotificationRegistryInterface

Update the progress information on the given topic

Specified by:

updateProgressTopic in interface NotificationRegistryInterface

Parameters:

topicId - TopicID

state - The new state

Throws:

UserException

ServerException