ServicePlugin & newRevision

[mostl33]

Heya!

I am running a local dev checkout of BIMServer in my IDE (Eclipse). I've create a simple plugin by extending ServicePlugin and creating the "register"-method:

	@Override
	public void register(long uoid, SInternalServicePluginConfiguration internalService,
			PluginConfiguration pluginConfiguration) {
		ServiceDescriptor serviceDescriptor = StoreFactory.eINSTANCE.createServiceDescriptor();
		serviceDescriptor.setProviderName("XRAY");
		serviceDescriptor.setIdentifier("" + internalService.getOid());
		serviceDescriptor.setName("XRAY");
		serviceDescriptor.setDescription("XRAY FTW");
		serviceDescriptor.setNotificationProtocol(AccessMethod.INTERNAL);
		serviceDescriptor.setTrigger(Trigger.NEW_REVISION);
		
		serviceDescriptor.setReadRevision(true);
		
		LOGGER.info("XRay - register");
		
		registerNewRevisionHandler(uoid, serviceDescriptor, new NewRevisionHandler() {

			@Override
			public void newRevision(BimServerClientInterface bimServerClientInterface, long poid, long roid,
					String userToken, long soid, SObjectType settings) throws ServerException, UserException {
				
				LOGGER.info("registerNewRevisionHandler - newRevision");
				
			}
			
		});
		
	}

XML:

<PluginDescriptor>
	<JavaPlugin>
		<interfaceClass>org.bimserver.plugins.services.ServicePlugin</interfaceClass>
		<implementationClass>com.demotime.XRay</implementationClass>
		<description>Fancy</description>
		<name>XRay</name>
	</JavaPlugin>
	
</PluginDescriptor>

The plugin is loaded as an enabled (listed in BIMvie.ws) "Internal Service" (no idea what "internal" means in this context).

Shouldn't an upload ("Checkin") of an IFC file through BIMvie.ws (or a POST to "/upload") trigger a call to "newRevision"?

Thanks in advance.

Best regards,

Martin

[hlg]

That looks fine and your expectation is correct. However, you first need to add the service to the project.

If you wanted to take advantage of progress notifications (to see service execution progress in BIMvie.ws, for example), then you could extend AbstractService instead of ServicePlugin.

Internal services are the ones that run within BIMserver, where as external (or remote) services run on a different server. BIMserver itself can provide its services to external. See the wiki for further details.

[mostl33]

Thank you hlg -!-

However, you first need to add the service to the project.

Mhm can this be done via "BIMvie.ws" or the Console? Can't find any hints on how to "add" it?

If you wanted to take advantage of progress notifications (to see service execution progress in BIMvie.ws, for example), then > you could extend AbstractService instead of ServicePlugin.

Thanks for the heads up ... that's the next step.

Internal services are the ones that run within BIMserver, where as external (or remote) services run on a different server.
BIMserver itself can provide its services to external. See the wiki for further details.

Thanks for the explanation 👍. Mhm I've checked the Wiki but I might have missed it.

Best regards
Martin

[hlg]

In BIMvie.ws, you find the function in the drop-down at the project tree root, that you use for project-specific actions such as checkin.

Via the API you can use ServiceInterface.addLocalServiceToProject. You cannot call it via the console though, because this call needs a complex object and you can't input complex objects into the console (not implemented in frontend). But you can see the structure of the service payload for the call.

[mostl33]

Sigh, it was hiding in plain sight all along 🫠.

For reference:

Via the API you can use ServiceInterface.addLocalServiceToProject. You cannot call it via the console though, because this call needs a complex object and you can't input complex objects into the console (not implemented in frontend). But you can see the structure of the service payload for the call.

Yeah, next task: spelunking through the payload in the Network Inspector 🫡.

Thanks again -!!!-

[mostl33]

Ok now I am curious. Is there an example on how to create and register an external service? The documentation on this topic is somewhat sparse.

Thanks & best regards,
Martin