com.ibm.jaggr.core

Interface IPlatformServices

public interface IPlatformServices

Interface for all platform dependent functionalities used by the aggregator. The functionalities have been collated in this interface. This interface has been implemented by platform dependent implementations. For example, there is a OSGi specific implementation which provides the OSGi way for implementing these functionalities. The implementations are kept in the platform specific bundles. For OSGi, the implementation of this interface is location in jaggr-service bundle.

Method Summary

Methods

Modifier and Type	Method and Description
URI	getAppContextURI() This method returns the URI pointing to the context root of the consuming application.
Dictionary<String,String>	getHeaders() An interface method to get the headers from the application context.
URL	getResource(String resourceName) A method to access a resource within an application
Object	getService(IServiceReference serviceReference) Returns the service object corresponding to the service registration.
IServiceReference[]	getServiceReferences(String clazz, String filter) Returns an array of service references for the services that were registered under the specified class and filter.
IServiceRegistration	registerService(String clazz, Object service, Dictionary<String,String> properties) Registers the specified service object with the specified properties under the specified class name with the platform.
boolean	ungetService(IServiceReference serviceReference) Removes the service reference from the platform

Method Detail

registerService

IServiceRegistration registerService(String clazz,
                                   Object service,
                                   Dictionary<String,String> properties)

Registers the specified service object with the specified properties under the specified class name with the platform.

Parameters:

clazz - The class name under which the service is registered

service - The service object

properties - The properties for this service.

Returns:

An instance of com.ibm.jaggr.core.ServiceRegistration

getServiceReferences

IServiceReference[] getServiceReferences(String clazz,
                                       String filter)
                                         throws PlatformServicesException

Returns an array of service references for the services that were registered under the specified class and filter.

Parameters:

clazz - The class name under which the service is registered

filter - The specified filter expression is used to select the registered services whose service properties contain keys and values which satisfy the filter expression

Returns:

A array of objects of service references. For OSGi implementation, this object refers to implementation of org.osgi.framework.ServiceReference interface.

Throws:

PlatformServicesException

getService

Object getService(IServiceReference serviceReference)

Returns the service object corresponding to the service registration.

Parameters:

serviceReference - Service reference object for the desired service object. For OSGi implementation, this object refers to implementation of org.osgi.framework.ServiceReference interface.

Returns:

service object

ungetService

boolean ungetService(IServiceReference serviceReference)

Removes the service reference from the platform

Parameters:

serviceReference - Service reference object. For OSGi implementation, this object refers to implementation of org.osgi.framework.ServiceReference interface.

Returns:

true if the operation was successful else false

getResource

URL getResource(String resourceName)

A method to access a resource within an application

Parameters:

resourceName -

Returns:

URL of the resource

getHeaders

Dictionary<String,String> getHeaders()

An interface method to get the headers from the application context. For OSGi, it could be extracting the headers from the bundle context.

Returns:

A Dictionary of key-value pairs depicting the headers.

getAppContextURI

URI getAppContextURI()
                     throws URISyntaxException

This method returns the URI pointing to the context root of the consuming application.

Returns:

URI object pointing to the context root of the consuming application.

Throws:

URISyntaxException