Skip to content

Latest commit

 

History

History
142 lines (109 loc) · 4.86 KB

README.md

File metadata and controls

142 lines (109 loc) · 4.86 KB
Raw

Request and response interceptors MSF4J OSGi Bundle Sample

This sample demonstrates how to create MSF4J interceptors as an OSGi bundle.

In this sample we have exposed the InterceptorService as an OSGi service that implements org.wso2.msf4j.Microservice interface as shown in the following code.

@Component(
        name = "InterceptorService",
        service = Microservice.class,
        immediate = true
)
@Path("/interceptor-service")
public class InterceptorService implements Microservice {
    

    private static final Logger log = LoggerFactory.getLogger(InterceptorService.class);
    

    /**
     * Method for getting the micro-service name.
     *
     * @return name of the micro-service.
     */
    @GET
    @Path("/service-name")
    @RequestInterceptor(HTTPRequestLogger.class)
    @ResponseInterceptor(HTTPResponseLogger.class)
    public String getServiceName() {
        log.info("HTTP Method Execution - getServiceName()");
        return "WSO2 Service";
    }
}

Further more we have to define the request and response interceptor order. In order to proceed with include the following dependency in the pom. This dependency will contain the interceptors to be used.

        <dependency>
            <groupId>org.wso2.msf4j.samples</groupId>
            <artifactId>interceptor-common</artifactId>
            <version>${project.version}</version>
        </dependency>

###Defining the order of global interceptors

Please do refer to the SampleInterceptorConfig class.

In here you inherit from the OSGiInterceptorConfig class. All you need to do is to add a list of global request interceptors (optional) and global response interceptors (optional) using "addGlobalRequestInterceptors" and "addGlobalResponseInterceptors" respectively. The order in which you define the global interceptors are defined is the order in which they are executed.

Please do make sure to add the @component annotation as stated below.

@Component(
        name = "SampleInterceptorConfig",
        service = OSGiInterceptorConfig.class,
        immediate = true
)
public class SampleInterceptorConfig extends OSGiInterceptorConfig {
    @Override
    public void createRequestInterceptors() {
        addGlobalRequestInterceptors(new LogTextRequestInterceptor(), new PropertyAddRequestInterceptor());
        addGlobalResponseInterceptors(new LogTextResponseInterceptor(), new PropertyGetResponseInterceptor());
    }
}

How to build the sample

From this directory, run

mvn clean install

How to run the sample

Using OSGi Console

First you need to install the MSF4J feature in to carbon kernel. To proceed with this navigate to MSF4J Kernel pom (test distribution pom) and execute the command below:

mvn clean install

This will install the msf4j and other required features to the kernel and build up a product. You can find the product in the resources/target directory

Go to the target/wso2msf4j-/bin directory Then run the following command to start the MSF4J server.

./carbon.sh

Install the target/osgi-interceptor-service-<version>.jar and ../../interceptor-common/target/ interceptor-common-<version>.jar as an OSGi bundle to carbon kernel using it's OSGi console with the following command.

install file://<path to target directory>/osgi-interceptor-service-\<version>.jar
install file://<path to target directory>/interceptor-common-\<version>.jar

When the installation of the bundle is successful, use the bundle ID of the installed bundle to start
it. Use the following command in the OSGi console for that.

start <bundle ID>

When the bundle is started, the microservice that is exposed as an OSGi service will be picked by the runtime and will be exposed as a REST service.

Using dropins directory

Install MSF4J feature to the carbon kernel as described in section Using OSGi Console

Copy the target/osgi-interceptor-service-<version>.jar and ../../interceptor-common/target/ interceptor-common-<version>.jar to [SERVER-HOME]/lib" directory.

Then navigate to the bin directory and run the following command to start WSO2 carbon kernel.

./carbon.sh

When the server is being started, the bundle in the dropins directory will be automatically loaded and it's microservices that are there as OSGi services will be exposed as REST services.

How to test the sample

Use following cURL commands.

curl http://localhost:8080/interceptor-service/service-name