org.kuali.rice.ksb.api.bus.support

Class CallbackServiceExporter

java.lang.Object

org.kuali.rice.ksb.api.bus.support.CallbackServiceExporter

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class CallbackServiceExporter
extends Object
implements org.springframework.beans.factory.InitializingBean

A helper class which can be used to by a client application to export a callback service to the Kuali Service Bus service registry. A callback service is a service published by a client application which is invoked by one of the Kuali Rice modules running as part of the standalone server.

While it's perfectly legal for an application to handle publishing of callback service implementations to the service registry manually using the ServiceBus api or the ServiceBusExporter, this class helps with publishing the services in such a way that they are compatible with the requirements of how the specific callback services are supposed to be published. This includes ensuring that information about the version of the callback services is properly present in the service registry. This additionally ensures the service is published using the correct type of ServiceDefinition and the proper security settings. By default, callback services use SOAP and have bus security turned on.

With the exception of the callbackService, most of the properties on this class are passed through to either a ServiceBusExporter or a SoapServiceDefinition. As a result, many of them are optional (see the documentation on the aforementioned classes for details). The callback service must be injected into this class or else an IllegalStateException will be thrown during startup of this bean.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

ServiceBusExporter, SoapServiceDefinition

Constructor Summary

Constructors

Constructor and Description
CallbackServiceExporter()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected ServiceBusExporter	createServiceBusExporter() Creates a ServiceBusExporter based on the properties set on this exporter.
protected SoapServiceDefinition	createSoapServiceDefinition() Creates a SoapServiceDefinition based on the properties set on this exporter.
Boolean	getBusSecurity()
Object	getCallbackService()
URL	getEndpointUrl()
protected String	getLocalServiceName()
ServiceBus	getServiceBus()
String	getServiceInterface()
QName	getServiceName()
String	getServiceNameSpaceURI()
String	getServicePath()
void	setBusSecurity(Boolean busSecurity)
void	setCallbackService(Object callbackService)
void	setEndpointUrl(URL endpointUrl)
void	setLocalServiceName(String localServiceName)
void	setServiceBus(ServiceBus serviceBus)
void	setServiceInterface(String serviceInterface)
void	setServiceName(QName serviceName)
void	setServiceNameSpaceURI(String serviceNameSpaceURI)
void	setServicePath(String servicePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

CallbackServiceExporter

public CallbackServiceExporter()

Method Detail

afterPropertiesSet

public final void afterPropertiesSet()
                              throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

createServiceBusExporter

protected ServiceBusExporter createServiceBusExporter()

Creates a ServiceBusExporter based on the properties set on this exporter. Subclasses may override this method in order to customize how the exporter or it's ServiceDefinition are created.

Returns:

a fully constructed ServiceBusExporter which is ready to be exported

createSoapServiceDefinition

protected SoapServiceDefinition createSoapServiceDefinition()

Creates a SoapServiceDefinition based on the properties set on this exporter. Subclasses may override this method in order to customize how the SOAP service definition is created.

Returns:

the SoapServiceDefinition to be exported

getLocalServiceName

protected final String getLocalServiceName()

setLocalServiceName

public final void setLocalServiceName(String localServiceName)

getServiceNameSpaceURI

public final String getServiceNameSpaceURI()

setServiceNameSpaceURI

public final void setServiceNameSpaceURI(String serviceNameSpaceURI)

getServiceName

public final QName getServiceName()

setServiceName

public final void setServiceName(QName serviceName)

getServicePath

public final String getServicePath()

setServicePath

public final void setServicePath(String servicePath)

getEndpointUrl

public final URL getEndpointUrl()

setEndpointUrl

public final void setEndpointUrl(URL endpointUrl)

getBusSecurity

public final Boolean getBusSecurity()

setBusSecurity

public final void setBusSecurity(Boolean busSecurity)

getServiceInterface

public String getServiceInterface()

setServiceInterface

public void setServiceInterface(String serviceInterface)

getCallbackService

public Object getCallbackService()

setCallbackService

public void setCallbackService(Object callbackService)

getServiceBus

public final ServiceBus getServiceBus()

setServiceBus

public final void setServiceBus(ServiceBus serviceBus)